Reference

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.

SettingDefaultWhat it does
server-namesurvivalThis server's name, saved on every record. Use a different name per server on a network.
storage.typeSQLITEYAML (files in plugins/mcBans/data), SQLITE (plugins/mcBans/mcbans.db) or MYSQL. MYSQL is required on a network.
storage.table-prefixmcbans_Prefix of the database tables. Must match on the proxy.
storage.mysql.*localhost:3306, db mcbanshost, port, database, username, password, ssl and pool-size for MySQL or MariaDB.
storage.deny-login-on-errortrueIf the database cannot be reached when someone joins, refuse the join instead of letting them in unchecked.
network.modeautoauto, single or proxy.
network.purgatory-serverpurgatoryProxy mode: the purgatory server name in the proxy list.
network.this-is-purgatory-serverfalseSet to true only on the backend that hosts purgatory.
network.route-timeout-seconds8Seconds before a purgatory-banned player still on a backend is disconnected.
broadcast.scopestaffstaff or all.
broadcast.network-widetrueShow broadcasts on every server of the network.
punishments.appealhttps://example.com/appealAppeal link used as the appeal tag. Empty hides the line.
punishments.ip-by-defaultfalseBan and mute the IP as well by default.
punishments.default-reasonsper typeReason used when staff give none, for ban, mute, warn, kick and freeze.
punishments.muted-blocked-commandsmsg, tell, w, ...Commands muted players cannot use.
warns.expire-after30dHow long a warning counts. permanent = never.
warns.thresholds3, 5, 7Automatic punishments by warning count.
freeze.*see Freezeindicator (title, bossbar, bossbar-color, actionbar), block-damage, allowed-commands, chat-log-size and quit-punishment.
purgatory.enabledtrueOff makes every ban a normal ban.
purgatory.default-for-banstrueBans go to purgatory unless -np is used.
purgatory.unban-threshold10000Credits needed to be released.
purgatory.reset-on-new-bantrueA new purgatory ban starts at 0 credits and tier 1.
purgatory.worldmcbans_purgatoryWorld name for purgatory.
purgatory.mine.auto-buildtrueBuild the Hollow on first start.
purgatory.mine.regen-seconds30Seconds until a mined block grows back as ore.
purgatory.save-inventorytrueSingle server: keep the inventory while in purgatory and return it on release.
purgatory.release-locationspawnspawn or last.
purgatory.chatpurgatorynone, purgatory or staff.
purgatory.hide-otherstrueHide purgatory players from everyone else and the other way around.
purgatory.bossbar / scoreboard / no-damagetrueProgress boss bar, sidebar scoreboard, and no damage, hunger or death.
purgatory.allowed-commandspurgatory, msg, r, ...The only commands purgatory players may use.
purgatory.ores7 oresvalue, smelt-value and weight for each ore.
purgatory.pickaxe.tiers5 tiersname, item, cost, efficiency, haste, fortune-multiplier, auto-smelt and radius per tier.
store.enabled / urltrue / https://store.example.comCredit store switch and the main store link.
store.packages3 packagesname, credits, price, icon and an optional url for each package.
economy.providerinternalinternal, vault, playerpoints or coinsengine.
economy.coinsengine-currencycoinsThe CoinsEngine currency to use.
gui.duration-presets30m ... permanentUp to 8 length buttons in the punish screen.
gui.reason-presetsHacking, X-ray, ...Up to 8 reason buttons in the punish screen. Also offered in tab completion.
updates.*enabledenabled, check-on-startup, check-interval-hours, auto-download, notify, shared-token and resource-id.