Install (on multiple servers)

A full guide for installing, configuring and running BanManager for use on a Minecraft network. If you're unsure which option is best, try our configuration builder!

Prerequisites

• Java 8+

Option 1 - BungeeCord or Velocity

Requirement: you're using BungeeCord or Velocity and would like punishments to be shared across every Minecraft server

Initial Setup

1. Download the BanManager BungeeCord or Velocity jar from our downloads page and save it in an easily accessible location
2. Copy the BanManager jar file to your proxy's plugins folder
3. Fully restart your proxy
   • This is required to generate the default configuration files and enable BanManager
4. Check your server logs to confirm BanManager enables correctly

Option 2 - Alternative networks

Requirement: you're using a proxy such as LilyPad and would like punishments to be shared across every Minecraft server

Currently only BungeeCord & Velocity have first class support, however alternative networks such as LilyPad are supported by installing BanManager on each Minecraft instance (CraftBukkit/Spigot/Paper/Sponge) using the same shared database to sync data.

Prerequisites

• MySQL or MariaDB

Setup

1. Download the BanManager jar from our downloads page and save it in an easily accessible location
2. Copy the BanManager jar file to your server plugins folder (CraftBukkit/Spigot/Paper) or mods folder (Sponge)
3. Fully restart your minecraft server
   • This is required to generate the default configuration files
4. Open config.yml, find databases and under the local section, set storageType to mysql or mariadb. Then populate host, name, user & password with your connection details.
5. Save the file and then restart your minecraft server. Check the server logs to confirm the plugin has enabled correctly.
6. Open schedules.yml and configure scheduler values as necessary. The defaults suffice for most installations.
7. Open console.yml and change only the name value to help identify which server issued issued punishments via the console.
   • It is important this file is generated by each server, do not copy and paste it between servers
8. Perform the previous steps for every Minecraft server using the same database.

Option 3 - Individual punishments per server and global bans

Requirement: you're running a network but would like bans and other punishments to be specific to each server whilst still having the ability to globally punish players

Prerequisites

• MySQL or MariaDB

Setup

1. Follow steps 1 - 4 and 7 from Option 2 for each server.
2. Use either a different database or different table names per server when configuring databases local options.
   • Using the same database can allow sharing of certain punishments and not others, e.g. to share notes use the same playerNotes table name across all installations; this is optional.
3. Open config.yml, find databases and under the global section, set enabled to true and set storageType to mysql or mariadb. Then populate host, name, user & password with your connection details.
   • Each server must use the same global database and table names.
   • This enables /*all commands e.g. /banall. Use these to punish a player globally.
   • Note: Each server will poll the global database for punishments. Upon finding a new punishment, said punishments are then issued on the individual server. This means global punishments are not instant and the delay depends on the external* timings defined in every server's schedules.yml file.
4. Restart each minecraft server. Check the server logs to confirm the plugin has enabled correctly.