Configuration reference
The most important config.yml options. Run /mcbans reload after editing. Options marked as storage or network need a restart. Most of them can also be changed in game from /modpanel, Settings.
| Setting | Default | What it does |
|---|---|---|
| server-name | survival | This server's name, saved on every record. Use a different name per server on a network. |
storage.type | SQLITE | YAML (files in plugins/mcBans/data), SQLITE (plugins/mcBans/mcbans.db) or MYSQL. MYSQL is required on a network. |
storage.table-prefix | mcbans_ | Prefix of the database tables. Must match on the proxy. |
storage.mysql.* | localhost:3306, db mcbans | host, port, database, username, password, ssl and pool-size for MySQL or MariaDB. |
storage.deny-login-on-error | true | If the database cannot be reached when someone joins, refuse the join instead of letting them in unchecked. |
network.mode | auto | auto, single or proxy. |
network.purgatory-server | purgatory | Proxy mode: the purgatory server name in the proxy list. |
network.this-is-purgatory-server | false | Set to true only on the backend that hosts purgatory. |
network.route-timeout-seconds | 8 | Seconds before a purgatory-banned player still on a backend is disconnected. |
broadcast.scope | staff | staff or all. |
broadcast.network-wide | true | Show broadcasts on every server of the network. |
punishments.appeal | https://example.com/appeal | Appeal link used as the appeal tag. Empty hides the line. |
punishments.ip-by-default | false | Ban and mute the IP as well by default. |
punishments.default-reasons | per type | Reason used when staff give none, for ban, mute, warn, kick and freeze. |
punishments.muted-blocked-commands | msg, tell, w, ... | Commands muted players cannot use. |
warns.expire-after | 30d | How long a warning counts. permanent = never. |
warns.thresholds | 3, 5, 7 | Automatic punishments by warning count. |
freeze.* | see Freeze | indicator (title, bossbar, bossbar-color, actionbar), block-damage, allowed-commands, chat-log-size and quit-punishment. |
purgatory.enabled | true | Off makes every ban a normal ban. |
purgatory.default-for-bans | true | Bans go to purgatory unless -np is used. |
purgatory.unban-threshold | 10000 | Credits needed to be released. |
purgatory.reset-on-new-ban | true | A new purgatory ban starts at 0 credits and tier 1. |
purgatory.world | mcbans_purgatory | World name for purgatory. |
purgatory.mine.auto-build | true | Build the Hollow on first start. |
purgatory.mine.regen-seconds | 30 | Seconds until a mined block grows back as ore. |
purgatory.save-inventory | true | Single server: keep the inventory while in purgatory and return it on release. |
purgatory.release-location | spawn | spawn or last. |
purgatory.chat | purgatory | none, purgatory or staff. |
purgatory.hide-others | true | Hide purgatory players from everyone else and the other way around. |
| purgatory.bossbar / scoreboard / no-damage | true | Progress boss bar, sidebar scoreboard, and no damage, hunger or death. |
purgatory.allowed-commands | purgatory, msg, r, ... | The only commands purgatory players may use. |
purgatory.ores | 7 ores | value, smelt-value and weight for each ore. |
purgatory.pickaxe.tiers | 5 tiers | name, item, cost, efficiency, haste, fortune-multiplier, auto-smelt and radius per tier. |
| store.enabled / url | true / https://store.example.com | Credit store switch and the main store link. |
store.packages | 3 packages | name, credits, price, icon and an optional url for each package. |
economy.provider | internal | internal, vault, playerpoints or coinsengine. |
economy.coinsengine-currency | coins | The CoinsEngine currency to use. |
gui.duration-presets | 30m ... permanent | Up to 8 length buttons in the punish screen. |
gui.reason-presets | Hacking, X-ray, ... | Up to 8 reason buttons in the punish screen. Also offered in tab completion. |
updates.* | enabled | enabled, check-on-startup, check-interval-hours, auto-download, notify, shared-token and resource-id. |