Installation

Installation

Basic setup

1. Download SXBans.jar and drop it into your plugins/ folder.

2. Start your server once. This lets SXBans generate its default files:

   • plugins/SXBans/config.yml
   • plugins/SXBans/messages.yml
   • plugins/SXBans/templates.yml
   • plugins/SXBans/data/ (only if you're using JSON storage, which is the default)

3. Shut the server down.

4. Open config.yml and decide on two things before you go further:

   • Storage type — JSON works with zero setup and is fine for most servers. If you're expecting a lot of punishment history or you already run MySQL for other plugins, see Database Setup.
   • Web panel port — default is 8080. Change it if that port's already taken on your machine, or if you'd rather run it behind a reverse proxy on a different internal port.

5. Start the server again.

6. Watch your console on this boot. SXBans generates a random password for the default admin web panel account and prints it once:

   =================================================
    SXBans Web Panel - Initial admin account password generated:
    Username: admin
    Password: <a bunch of random characters>
    Please log in now and change this password from Settings.
   =================================================
   

   If you miss it, don't panic — see Web Panel: I lost my admin password.

That's the whole install. No commands need to be run, no database schema needs to be created by hand — the plugin handles table/collection creation itself.

Migrating from another punishment plugin

SXBans doesn't have a one-click importer for other plugins' punishment data (every plugin stores this differently, and half of them don't document their schema). If you're switching over:

• Existing bans in the other plugin will keep working until you remove that plugin, since Minecraft/Bukkit's underlying ban list is separate from SXBans' own tracking for name-based bans.
• IP bans are a bit different — if the old plugin used the server's built-in IP ban list, those will still apply after you remove it, since that list lives at the server level, not inside the plugin.
• There's no harm running both plugins side by side for a transition period as long as they're not both trying to register the exact same commands (check for /ban, /mute, etc. conflicts in your plugins/ folder before starting).

If you specifically need to bulk-import historical punishment records, that's a case-by-case job — reach out with details on what format the old data is in.

Updating

Replace the jar, restart. SXBans will add any new config keys that came with the update automatically without touching your existing settings — you don't need to delete your config to pick up new options.

Uninstalling

Remove the jar. If you also want to wipe the plugin's data, delete the plugins/SXBans/ folder (or drop the relevant database if you were using MySQL/PostgreSQL). Note this permanently deletes all punishment history — there's no undo.