Configuration

Manuka Moderation is configured in plugins/ManukaModeration/config.yml, which the first start creates with comments on every key. Edit it and run /mm reload; no restart is needed except where noted. On Pro you can also change every setting from the panel's Settings page. On Free the panel can change the language, the theme and the accent colour, and everything else stays editable in the file.

A bad value never stops the plugin: the console names the key, what was expected and the default used instead. If the file is not valid YAML at all, the previous settings stay in use.

Keys marked Pro only take effect with a Pro license. On Free they are kept, never deleted.

General #

Console #

Capture #

What the plugin records. Login, register and password commands are never captured, whatever you set here.

Storage #

Everything is stored in one SQLite file, plugins/ManukaModeration/data.db. Back it up with the server stopped, or copy data.db, data.db-wal and data.db-shm together.

Groups and exemptions #

Exempt players' lines are still stored and shown as context in other players' cases. The permission manukamod.exempt exempts a player too.

Advertising #

advertising:
  allowed: [myserver.net, discord.gg/abc123, "play.myserver.net"]

A message that shares one of these links is never flagged because of it, however players write it: with or without https:// and www., on a subdomain, in capitals, inside brackets or behind a colour code, or spelled out ("myserver punto net"). Everything else still is: another Discord or website, a look-alike name, a longer address (myserver.net.ru) or the same code on another invite service (dsc.gg, discord.me).

• Write a host (myserver.net) or an invite (discord.gg/abc123). A port or a query in an entry is ignored.
• An entry with a path (your page on a server list, such as minecraft-mp.com/server/123456) allows that page and the pages under it, not the rest of the site.
• An invite code with capital letters only matches when typed exactly like that. Write a vanity invite in lower case.
• A bare name (myserver) allows that name under every domain, so list it only if nobody else runs a server with that name.

Detection #

Actions #

Each type and severity gets a list of actions: log (store only; always implied), notify (in-game alert, real-time e-mails and a panel notification) or command (Pro, runs the matching detection.commands entries). Types that are not listed use default. As shipped:

detection:
  actions:
    default:       { low: [log], medium: [notify], high: [notify] }
    advertising:   { low: [notify], medium: [notify], high: [notify] }
    personal_data: { low: [notify], medium: [notify], high: [notify] }
    spam:          { low: [log], medium: [log], high: [notify] }
    caps:          { low: [log], medium: [log], high: [log] }

Automatic commands (Pro) #

Nothing is punished automatically by default. An entry of detection.commands runs once per case, as the console, when the case reaches threshold events at min-severity or above, and only while the detection.actions row of that type and severity includes command. Placeholders: {player}, {uuid}, {type}, {severity}, {case} and {server}. Use your punishment plugin's commands, and test them by hand first.

detection:
  actions:
    advertising: { low: [notify], medium: [notify], high: [notify, command] }
  commands:
    - { type: advertising, min-severity: high, threshold: 3, run: ["warn {player} Advertising (case {case})"] }

Rules files #

The rules live in plugins/ManukaModeration/rules/:

• en.yml and es.yml are the bundled language packs, copied on the first start.
• custom.yml holds your own rules and is always loaded last. Its lists add to the packs unless you set merge: replace at the top.

# rules/custom.yml
version: 1
merge: append
detectors:
  advertising:
    allowed: []        # e.g. [myserver.net, discord.gg/abc123]
    hosts: []          # extra competitor hosts
  insult:
    words: []          # extra word stems
    safe-words: []     # words that must never flag
  custom:
    toxic-links:       # shows as "custom:toxic-links" in the panel
      enabled: false
      severity: medium
      regex: ["\\bbit\\.ly/\\w+\\b"]

• Words are stems: idiot also matches idiots and idiotic. End an entry with ! to match the whole word only.
• Regular expressions use Java syntax and are matched, by default, on the normalized text: lower case, accents removed and leetspeak undone. Start a pattern with raw: to match the original text instead.
• Patterns are checked when the file loads. A pattern that could hang (such as (a+)+) is rejected, and one that takes more than 50 ms on hostile input is disabled and named in the console.
• A rules file with an error is reported, and the previous rules stay active until it is fixed.

Alerts #

Panel #

Changes to panel.bind, panel.port, panel.base-path and panel.https.* are applied by a restart or by /mm reload from the console or the game, not by a save in the panel. Setup recipes are in the panel guide.

Access #

Which groups may log in to the panel and what each one sees.

access:
  permissions-override: true
  groups:
    owner: { violations: [all], punishments: true, logs: true, analytics: true, settings: true, users: true, ai: true }
    admin: { violations: [all], punishments: true, logs: true, analytics: true, settings: false, users: false, ai: true }
    mod:   { violations: [advertising, insult, harassment, discrimination, sexual, threat], punishments: true, logs: false, analytics: true, settings: false, users: false, ai: false }

• Each entry is a group name as in LuckPerms or your Vault permission plugin. violations is [all] or a list of violation types; the other keys are true or false (missing ones count as false).
• A player's access is the sum of all their groups, primary and inherited. A player with no matching group and no panel permission cannot log in.
• Free uses the first two groups only (as shipped, mod is the third). The console says so at start.
• manukamod.admin (operators by default) always sees everything.
• access.permissions-override (Pro with LuckPerms or Vault): the manukamod.panel.* permissions add access on top of the groups. Without LuckPerms or Vault, those permissions are the only way in, on Free and Pro.
• The settings scope can change the automatic commands, which run as the console. Give it to owners only.

E-mail #

email:
  recipients:
    - { address: "[email protected]", language: en, categories: [all, digest], min-severity: medium, mode: digest, every: "daily@08:00" }

Each recipient has a language (en, es, es_AR), categories (violation types, punishments, digest, or all), a minimum severity and a mode: realtime, digest or both. Digest schedules look like 30m, 6h, daily@08:00, daily@08:00,20:00 or weekly@mon-08:00. Free uses the first recipient only, with real-time e-mails or one daily digest; Pro allows any number of recipients, any schedule and both modes.

Any SMTP service works: a Gmail or Google Workspace app password, Outlook or Microsoft 365, SendGrid, Mailgun, Brevo or your own server. Test with /mm email test <address>.

AI #

Off by default. Nothing in the plugin depends on it.

Free allows 10 explanations a day; Pro has no limit. An explanation or a second opinion sends the flagged case and the lines around it, with e-mail addresses and phone numbers replaced by [personal data]. The digest paragraph (Pro) sends the digest of the period instead: its totals, each new case's player, group, type, severity and first evidence line, and the punishments; that text is not masked. Answers are shown as text and never executed. Test with /mm ai test.

License #

See Licensing and payment.

Updates #

Punishments #

LiteBans, AdvancedBan and EssentialsX mutes are read directly, and the vanilla ban list, which Essentials bans also use, is checked for changes. For other punishment plugins, the commands below are recorded when staff type them. The same punishment seen twice within 5 seconds is recorded once.

punishments:
  commands:
    ban: [ban, eban]
    tempban: [tempban, etempban]
    ipban: [ipban, banip, tempipban, tempbanip]
    unban: [unban, pardon, unbanip, pardon-ip]
    mute: [mute, tempmute, ipmute, emute]
    unmute: [unmute, eunmute]
    kick: [kick, ekick]
    warn: [warn, ewarn]

Advanced #

Secrets in environment variables #

Four keys are secrets: they are never logged, the panel only shows them masked, and they can come from environment variables instead of the file. A variable always wins over config.yml and is never written back to it.

Reloading #

/mm reload re-reads config.yml, the rules files, the language files, the AI prompts and the e-mail templates, and applies them without a restart. If the new config.yml cannot be read, nothing changes and the errors are listed.

• The panel's address keys (panel.bind, panel.port, panel.base-path, panel.https.*) and advanced.http-threads are applied by a restart or by /mm reload from the console or the game.
• advanced.intake-queue and advanced.db-queue need a full restart.
• Never use the server's own /reload. Restart the server to update the plugin.