-
Notifications
You must be signed in to change notification settings - Fork 0
Home
mahdixser edited this page Aug 23, 2026
·
3 revisions
Welcome. This is the deep-dive documentation — if you just want to get the plugin running, the README covers that in five minutes. This wiki is for when you want to actually understand what's happening under the hood, or when something isn't behaving the way you expect.
- Installation — full setup walkthrough, including what to do if you're migrating from another punishment plugin
- Commands — every command, every argument, every alias
- Permissions — the full permission tree, admin levels, and bypass nodes
-
Configuration — a line-by-line walk through
config.yml - Database Setup — JSON vs SQLite vs MySQL vs PostgreSQL, and when to pick which
- Web Panel — setting it up properly, adding staff accounts, securing it
- Network Setup — running SXBans across multiple servers with Redis
- Developer API — hooking into SXBans from your own plugin
- Troubleshooting — the stuff that goes wrong and how to fix it
- FAQ — questions that come up a lot
SXBans tries to have sane defaults for everything. If you never touch a single config option, it should still work correctly for a small server with a handful of staff. The configuration exists for when the defaults don't fit your setup — not because you're required to tune every knob before it'll function.
If you're reading this wiki because you're stuck on something, start with Troubleshooting — there's a decent chance it's already been hit by someone else.