Setup Minecraft Plugin

A full guide for installing, configuring and running BanManager for use in production on a Minecraft Server

Prerequisites

The recommended installation requires the following stack:

Initial Setup

Configuration

Quick Start

By default, BanManager works without any configuration using H2. In order to leverage features such as cross server punishments and the WebUI, a MySQL or MariaDB database is required.

databases:
  # Local Database is always required. If not enabled, plugin will disable on startup.
  local:
    enabled: true
    storageType: 'h2'
    host: 127.0.0.1
    port: 3306
    name: local_bans
    user: root
    password: ''
    maxConnections: 10
    useSSL: false
    verifyServerCertificate: false  

Please see FAQ for common database connection issues

config.yml

timeLimits:
  playerMutes:
    Moderator: 1h
  playerBans:
    Moderator: 1d
  playerWarnings:
    Moderator: 30d
  ipBans:
    Moderator: 1d
  ipMutes:
    Moderator: 1d
  rollbacks:
    Moderator: 1d
  nameBans:
    Moderator: 1d

actions:
  '10':
  - cmd: ban [player] [reason]
    delay: 10
  - cmd: mute [player] [reason]

events:
  ban:
    pre:
    - cmd: kick [player] [reason]
      delay: 10
    - cmd: banip [player] [reason]
    post:
    - cmd: broadcast [player] banned

console.yml

You should only change the name value in this file

discord.yml

Allows sending messages to Discord server channels when a punishment occurs. Bukkit requires DiscordSRV and Sponge requires MagiBridge.

Example

enabled: true
punishments:
  ban:
    channel: global
    message: '&6[player] has been permanently banned by [actor] for &4[reason]'
  tempban:
    channel: global
    message: '&6[player] has been temporarily banned for [expires] by [actor] for
      &4[reason]'
  mute:
    channel: global
    message: '&6[player] has been permanently muted by [actor] for &4[reason]'
  tempmute:
    channel: global
    message: '&6[player] has been temporarily muted for [expires] by [actor] for &4[reason]'
  warning:
    channel: global
    message: '&6[player] has been warned by [actor] for &4[reason]'

exemptions.yml

Players listed here are exempt from certain punishments even when offline. This is required as Bukkit's permission system does not support offline players.

Example

b55249d4-9226-4c11-9877-d757c3fe180f:
  ban: true
  tempban: true
  mute: true
  tempmute: true
  warn: true
  tempwarn: true
  alts: true
ae51c849-3f2a-4a37-986d-55ed5b02307f:
  ban: true
  tempban: true
  mute: true
  tempmute: true
  warn: true
  tempwarn: true
  alts: true

geoip.yml

Enables location based information, such as showing which country a player is connected from on join or via /bminfo and allows/blocks certain countries from connecting

Please note this now requires a license key from MaxMind. Please follow these instructions to generate a license key to paste into licenseKey within your BanManager/geoip.yml

Example

enabled: true
download:
  city: 'https://download.maxmind.com/app/geoip_download?edition_id=GeoLite2-City&license_key=[licenseKey]&suffix=tar.gz'
  country: 'https://download.maxmind.com/app/geoip_download?edition_id=GeoLite2-Country&license_key=[licenseKey]&suffix=tar.gz'
  lastUpdated: 0
  licenseKey: 'yourLicenseKeyHere'
countries:
  type: 'whitelist'
  list:
  - GB
  - FR

messages.yml

This contains all of the plugin messages sent to players. Format as desired. Text wrapped inside [] are tokens which will be replaced e.g. [reason] and can be removed if necessary. Use \n for new lines. Supports colours using & format, e.g. &c. Set a message to an empty string if you do not want it to be sent.

reasons.yml

Setup shortcuts for reasons to punish players quickly. Use the below examples like /ban confuser #hacking which will ban the player for the reason Using a hacked client.

You can combine multiple shortcuts or append/prepend them to reasons, e.g. /ban confuser #hacking & #swearing will ban the player for Using a hacked client & Swearing in chat

Example

hacking: "Using a hacked client"
swearing: "Swearing in chat"

schedules.yml

Controls how often data is synced between the database and Minecraft server to punish players across multiple servers. If you are updating punishments directly via the database, ensure you update the timestamps of the relevant punishments to correctly sync back to the Minecraft server.

Example

scheduler:
  expiresCheck: 30
  playerBans: 30
  playerMutes: 30
  playerWarnings: 30
  ipBans: 30
  ipRangeBans: 30
  rollbacks: 30
  nameBans: 30
  externalPlayerBans: 120
  externalPlayerMutes: 120
  externalPlayerNotes: 120
  externalIpBans: 120
  saveLastChecked: 60

Multiple Server Support

BanManager supports sharing punishments across multiple servers, often refered to as data syncing in the documentation. This is not dependent on a particular proxy e.g. Bungeecord or Lilypad and there are a number of ways you can achieve this.

Check out the Cross-Server Syncing Guides for more information.