messages.yml

Defines BanManager's messages throughout the plugin.

Messages support JSON, Minecraft colour codes and RGB hex colors e.g. &#ff5500 using the & delimiter. Use \n for new lines. Text wrapped inside square brackets i.e. [player] are tokens which will be replaced with their corresponding value. Set values to an empty string, i.e. '' if you do not wish the message to display.

Platform	Location
CraftBukkit/Spigot/Paper	`/plugins/BanManager/messages.yml`
BungeeCord	`/plugins/BanManager/messages.yml`
Fabric	`/config/banmanager/messages.yml`
Sponge	`/config/banmanager/messages.yml`
Velocity	`/plugins/BanManager/messages.yml`

PlaceholderAPI Support (Bukkit)

On Bukkit-based servers with PlaceholderAPI installed, you can use PlaceholderAPI tokens directly in messages. For example: %player_name%, %server_online%, etc.

Message Types

`duplicateIP`

Sent to players with the bm.notify.duplicateips permission when the same IP address of a banned player joins.

Token	Example	Description
player	confuser	Player name
players	JamsJar, Issy2322, SavannahF	A list of comma separated player names

Example

&cWarning: [player] has the same IP as the following banned players:\n&6[players]

Warning: confuser has the same IP as the following banned players:
JamsJar, Issy2322, SavannahF

`duplicateIPAlts`

Sent to players with the bm.notify.alts permission when a player joins with an IP address associated to other players.

Token	Example	Description
player	confuser	Player name
players	JamsJar, Issy2322, SavannahF	A list of comma separated player names

Example

&cWarning: [player] has the same IP as the following players:\n&6[players]

Warning: confuser has the same IP as the following players:
JamsJar, Issy2322, SavannahF

`configReloaded`

Sent when the config is reloaded via /bmreload.

Example

&aConfiguration reloaded successfully!

Configuration reloaded successfully!

deniedNotify
- player
  Sent to players with the bm.notify.denied.player permission when a banned player is denied from joining the server.
  Token Example Description
  actor JamsJar Player name who issued punishment
  player confuser Player name
  reason Hacking The cause of the punishment
  Example
  &cWarning: [player] attempted to join the server but was denied due to &4[reason]
  Warning: confuser attempted to join the server but was denied due to Hacking
- ip
  Sent to players with the bm.notify.denied.ip permission when a banned IP address is denied from joining the server.
  Token Example Description
  actor JamsJar Player name who issued punishment
  ip 127.0.0.1 The punished IP address, IPv4 or IPv6
  reason Hacking The cause of the punishment
  Example
  &cWarning: [ip] attempted to join the server but was denied due to &4[reason]
  Warning: 127.0.0.1 attempted to join the server but was denied due to Hacking

Token	Example	Description
actor	JamsJar	Player name who issued punishment
player	confuser	Player name
reason	Hacking	The cause of the punishment

Token	Example	Description
actor	JamsJar	Player name who issued punishment
ip	127.0.0.1	The punished IP address, IPv4 or IPv6
reason	Hacking	The cause of the punishment

`deniedMaxIp`

Server join deny message when maxOnlinePerIp limit reached.

Example

&cToo many players with your ip address online

Disconnected by Server

Too many players with your ip address online

Back to server list

`deniedMultiaccounts`

Server join deny message when maxMultiaccountsRecently limit reached.

Example

&cToo many players with your ip address logged in recently

Disconnected by Server

Too many players with your ip address logged in recently

Back to server list

`deniedCountry`

Server join deny message when player connecting from a country not on the countries list.

Token	Example	Description
country	United Kingdom	Name of country
countryIso	GB	ISO code of country

Example

&cYou may not connect from your region

Disconnected by Server

You may not connect from your region

Back to server list

time
A list of components to display a length of time, e.g. temporary banning a player for 1y2m3w4d5m is displayed as 1 year 2 months 3 weeks 4 days 5 minutes
- now
- year
- years
- month
- months
- week
- weeks
- day
- days
- hour
- hours
- minute
- minutes
- second
- seconds
- never
  Displayed when a punishment is permanent and never expires
- error
  - invalid
    Displayed when entering an incorrect duration, e.g. /tempban confuser 6ha Hacking
    Example
    &cYour time length is invalid
    Your time length is invalid

`none`

Displayed when no alts for a player are found via /alts command.

sender
A list of generic messages used by most commands for common scenarios.
- error
  - notFound
    Displayed when attempting to perform a command on a player which cannot be found in BanManager's database
    Token Example Description
    player confuser Player name
    Example
    &c[player] not found, are you sure they exist?
    confuser not found, are you sure they exist?
  - offline
    Displayed when attempting to perform a command which requires a player to be online, e.g. /kick <player> <reason>
    Token Example Description
    player confuser Player name
    Example
    &c[player] is offline
    confuser is offline
  - noSelf
    Displayed when attempting to perform a command on yourself, e.g. banning yourself
    Example
    &cYou cannot perform that action on yourself!
    You cannot perform that action on yourself!
  - exception
    Displayed when attempting an unknown error occurs, check your server console & logs for further information.
    Example
    &cAn error occured whilst attempting to perform this command. Please check the console for further details.
    An error occured whilst attempting to perform this command. Please check the console for further details.
  - invalidIp
    Displayed when attempting to perform a command with an incorrectly formatted IP address, e.g. /banip 127.0.1
    Token Example Description
    ip 127.0.0.1 The punished IP address, IPv4 or IPv6
    Example
    &cInvalid IP address, expecting w.x.y.z format
    Invalid IP address, expecting w.x.y.z format
  - ipNotSupported
    Displayed when attempting to perform a command which does not support IP addresses, e.g. /bminfo 127.0.0.1
    Example
    &cFetching information by IP address is currently unsupported.
    Fetching information by IP address is currently unsupported.
  - offlinePermission
    Displayed when attempting to perform a command on an offline player without the neccessary offline permission, e.g. bm.command.ban.offline
    Example
    &cYou are not allowed to perform this action on an offline player
    You are not allowed to perform this action on an offline player
  - exempt
    Displayed when attempting to perform a command on a player who is exempt
    Token Example Description
    player confuser Player name
    Example
    &c[player] is exempt from that action
    confuser is exempt from that action
  - noPermission
    Displayed when attempting to perform a command without the neccessary permissions, such as attempting to use a command flag e.g. /ban -silent <player> <reason>
    Token Example Description
    player confuser Player name
    Example
    &cYou do not have permission to perform that action
    You do not have permission to perform that action
  - invalidReason
    Displayed when attempting to use a reason shortcut which does not exist, e.g. /ban confuser #doesnotexist, requires enabling blockInvalidReasons
    Token Example Description
    reason Hacking The cause of the punishment
    Example
    &c[reason] is no valid reason.
    Hacking is no valid reason.

Token	Example	Description
ip	127.0.0.1	The punished IP address, IPv4 or IPv6

Token	Example	Description
reason	Hacking	The cause of the punishment

alts
Messages used by the /alts command
- header
  First line sent when using the /alts <player || ip> command
  Token Example Description
  ip 127.0.0.1 The punished IP address, IPv4 or IPv6
  Example
  Possible alts found:
  Possible alts found:

Token	Example	Description
ip	127.0.0.1	The punished IP address, IPv4 or IPv6

export
Messages used by the /bmexport command
- error
  - inProgress
    Displayed when an export is already in progress
    Example
    &cAn export is already in progress, please wait
    An export is already in progress, please wait
- player
  Messages used by /bmexport players
  - started
    Displayed when an export begins
    Example
    &aPlayer ban export started
    Player ban export started
  - finished
    Displayed when an export successfully completes
    Token Example Description
    file banned-players-2021-06-01_12-32-10.json Location of export
    Example
    &aPlayer ban export finished, file [file] created
    Player ban export finished, file banned-players-2021-06-01_12-32-10.json created
- ip
  Messages used by /bmexport ips
  - started
    Displayed when an export begins
    Example
    &aIP ban export started
    IP ban export started
  - finished
    Displayed when an export successfully completes
    Token Example Description
    file banned-ips-2021-06-01_12-32-10.json Location of export
    Example
    &aIP ban export finished, file [file] created
    IP ban export finished, file banned-ips-2021-06-01_12-32-10.json created

Token	Example	Description
file	banned-players-2021-06-01_12-32-10.json	Location of export

Token	Example	Description
file	banned-ips-2021-06-01_12-32-10.json	Location of export

import
Messages used by the /bmimport command
- error
  - inProgress
    Displayed when an import is already in progress
    Example
    &cAn import is already in progress, please wait
    An import is already in progress, please wait
- player
  Messages used by /bmimport players
  - started
    Displayed when an import begins
    Example
    &aPlayer ban import started
    Player ban import started
  - finished
    Displayed when an import successfully completes
    Example
    &aPlayer ban import finished
    Player ban import finished
- ip
  Messages used by /bmimport ips
  - started
    Displayed when an import begins
    Example
    &aIP ban import started
    IP ban import started
  - finished
    Displayed when an import successfully completes
    Example
    &aIP ban import finished
    IP ban import finished
- advancedban
  Messages used by /bmimport advancedban
  - started
    Displayed when an import begins
    Example
    &aAdvancedBan import started
    AdvancedBan import started
  - finished
    Displayed when an import successfully completes
    Example
    &aAdvancedBan import finished
    AdvancedBan import finished
- h2
  Messages used by /bmimport h2
  - started
    Displayed when an import begins
    Example
    &aH2 import started
    H2 import started
  - finished
    Displayed when an import successfully completes
    Example
    &aH2 import finished, please restart the server
    H2 import finished, please restart the server

`info`

Messages used by the /bminfo command

error
- indexRequired
  Displayed when multiple players with the same name are found
  Token Example Description
  name confuser Name searched
  size 3 Number of players found with same name
  Example
  &cMultiple players named [name], found, please select a player by providing an index between 1 and [size], e.g. /bminfo [name] 1
  Multiple players named confuser, found, please select a player by providing an index between 1 and 3, e.g. /bminfo [name] 1
- invalidIndex
  Displayed when an invalid index number is provided, e.g. /bminfo confuser asb
  Token Example Description
  ip 127.0.0.1 The punished IP address, IPv4 or IPv6
  Example
  &cInvalid player option used
  Invalid player option used
- index
  Displays a list of players to choose from
  Token Example Description
  index 0 Option to choose
  name confuser Name searched
  uuid ae51c849-3f2a-4a37-986d-55ed5b02307f UUID of player
  Example
  &7#[index] - &6[name] - &4[uuid]
  #0 - confuser - ae51c849-3f2a-4a37-986d-55ed5b02307f

Token	Example	Description
name	confuser	Name searched
size	3	Number of players found with same name

Token	Example	Description
ip	127.0.0.1	The punished IP address, IPv4 or IPv6

Token	Example	Description
index	0	Option to choose
name	confuser	Name searched
uuid	ae51c849-3f2a-4a37-986d-55ed5b02307f	UUID of player

`stats`

`player`

Displays the sum of player punishments, separated by type

Token	Example	Description
player	confuser	Player name
playerId	ae51c849-3f2a-4a37-986d-55ed5b02307f	UUID of player
bans	2	Total number of bans
mutes	2	Total number of mutes
kicks	2	Total number of kicks
warns	2	Total number of warnings
warnPoints	2	Total amount of warning points
notes	2	Total number of notes

Example

&6[player] has been banned [bans] times, muted [mutes] times, kicked [kicks] times and warned [warns] times ([warnPoints] Points) and has [notes] notes

confuser has been banned 2 times, muted 2 times, kicked 2 times and warned 2 times (2 Points) and has 2 notes

ip
Displays the sum of IP punishments, separated by type
Token Example Description
bans 2 Total number of bans
Example
&6This ip has been banned [bans] times
This ip has been banned 2 times

connection
Displays the player's last connection
Token Example Description
player confuser Player name
ip 127.0.0.1 The punished IP address, IPv4 or IPv6
lastSeen 02-06-2021 13:42:54 Date and time player last connected in dd-MM-yyyy HH:mm:ss format
Example
&6Their last connection was with [ip] on [lastSeen]
Their last connection was with 127.0.0.1 on 02-06-2021 13:42:54
geoip
Displays the player's geolocation information, requires geoip to be enabled
Token Example Description
country United Kingdom Name of country
countryIso GB ISO code of country
city London Name of city
Example
Country: [country] City: [city]
Country: United Kingdom City: London

Token	Example	Description
bans	2	Total number of bans

`ban`

`permanent`

Displays the player's current permanent ban information

Token	Example	Description
id	1	Numerical identifier (ID)
player	confuser	Player name
actor	JamsJar	Player name who issued punishment
reason	Hacking	The cause of the punishment
created	02-06-2021 13:42:54	Date and time punishment issued

Example

&6Currently banned for &4[reason]&6 by [actor] at [created]

Currently banned for Hacking by JamsJar at 02-06-2021 13:42:54

`temporary`

Displays the player's current temporary ban information

Token	Example	Description
id	1	Numerical identifier (ID)
player	confuser	Player name
actor	JamsJar	Player name who issued punishment
reason	Hacking	The cause of the punishment
created	02-06-2021 13:42:54	Date and time punishment issued
expires	02-06-2021 13:42:54	Date and time punishment expires

Example

&6Currently banned for &4[reason]&6 by [actor] at [created] which expires in [expires]

Currently banned for Hacking by JamsJar at 02-06-2021 13:42:54 which expires in 02-06-2021 13:42:54

dateTimeFormat
Defines the format of when the ban was issued
Example
dd-MM-yyyy HH:mm:ss

`ipban`

permanent
Displays an associated permanent IP ban
Token Example Description
id 1 Numerical identifier (ID)
actor JamsJar Player name who issued punishment
reason Hacking The cause of the punishment
created 02-06-2021 13:42:54 Date and time punishment issued
Example
&6Currently banned for &4[reason]&6 by [actor] at [created]
Currently banned for Hacking by JamsJar at 02-06-2021 13:42:54

`temporary`

Displays an associated temporary IP ban

Token	Example	Description
id	1	Numerical identifier (ID)
actor	JamsJar	Player name who issued punishment
reason	Hacking	The cause of the punishment
created	02-06-2021 13:42:54	Date and time punishment issued
expires	02-06-2021 13:42:54	Date and time punishment expires

Example

&6Currently banned for &4[reason]&6 by [actor] at [created] which expires in [expires]

Currently banned for Hacking by JamsJar at 02-06-2021 13:42:54 which expires in 02-06-2021 13:42:54

dateTimeFormat
Defines the format of when the ban was issued
Example
dd-MM-yyyy HH:mm:ss

`mute`

`permanent`

Displays the player's current permanent mute information

Token	Example	Description
id	1	Numerical identifier (ID)
player	confuser	Player name
actor	JamsJar	Player name who issued punishment
reason	Hacking	The cause of the punishment
created	02-06-2021 13:42:54	Date and time punishment issued

Example

&6Currently muted for &4[reason]&6 by [actor] at [created]

Currently muted for Hacking by JamsJar at 02-06-2021 13:42:54

`temporary`

Displays the player's current temporary mute information

Token	Example	Description
id	1	Numerical identifier (ID)
player	confuser	Player name
actor	JamsJar	Player name who issued punishment
reason	Hacking	The cause of the punishment
created	02-06-2021 13:42:54	Date and time punishment issued
expires	02-06-2021 13:42:54	Date and time punishment expires

Example

&6Currently muted for &4[reason]&6 by [actor] at [created] which expires in [expires]

Currently muted for Hacking by JamsJar at 02-06-2021 13:42:54 which expires in 02-06-2021 13:42:54

dateTimeFormat
See Java's DateTimeFormatter for a list of available symbols.
Example
dd-MM-yyyy HH:mm:ss

website
- player
  Displays a link to view the player's profile
  Token Example Description
  player confuser Player name
  playerId ae51c849-3f2a-4a37-986d-55ed5b02307f UUID of player
  Example
  http://yourdomain.com/index.php?action=viewplayer&player=[player]&server=0
  http://yourdomain.com/index.php?action=viewplayer&player=confuser&server=0

`history`

Displays records for a player via /bminfo confuser -bans -mutes, requires permissions bm.command.bminfo.history.[type] depending on record types.

`row`

Token	Example	Description
id	1	Numerical identifier (ID)
type	Ban	The record type
reason	Hacking	The cause of the punishment
actor	JamsJar	Player name who issued punishment
created	02-06-2021 13:42:54	Date and time punishment issued
meta	5	Additional information pertaining to the record e.g. warning points

Example

&7#[id] &a[&f[type]&a] &6[actor]&f [meta] [reason] - &e[created]

#1 [Ban] JamsJar 5 Hacking - 02-06-2021 13:42:54

noResults
Displayed when no records found
Example
&cNo results found
No results found
dateTimeFormat
See Java's DateTimeFormatter for a list of available symbols.
Example
dd-MM-yyyy HH:mm:ss

ips
Shows join and leave times of player via /bminfo confuser -ips, requires permission bm.command.bminfo.history.ips and requires logIps to be enabled.
- row
  
  Token Example Description
  ip 127.0.0.1 The punished IP address, IPv4 or IPv6
  join 02-06-2021 13:42:54 Date and time player joined the server
  leave 02-06-2021 13:42:54 Date and time player left the server
  Example
  &e[ip] - &6[join] - [leave]
  127.0.0.1 - 02-06-2021 13:42:54 - 02-06-2021 13:42:54
- dateTimeFormat
  See Java's DateTimeFormatter for a list of available symbols.
  Example
  dd-MM-yyyy HH:mm:ss

Token	Example	Description
ip	127.0.0.1	The punished IP address, IPv4 or IPv6
join	02-06-2021 13:42:54	Date and time player joined the server
leave	02-06-2021 13:42:54	Date and time player left the server

Edit this page on GitHub

Getting Started

Usage

Migration Guides

Developers

Web UI

messages.yml

PlaceholderAPI Support (Bukkit)

Message Types

duplicateIP

duplicateIPAlts

configReloaded

deniedNotify

player

ip

deniedMaxIp

deniedMultiaccounts

deniedCountry

time

now

year

years

month

months

week

weeks

day

days

hour

hours

minute

minutes

second

seconds

never

error

invalid

none

sender

error

notFound

offline

noSelf

exception

invalidIp

ipNotSupported

offlinePermission

exempt

noPermission

invalidReason

alts

header

export

error

inProgress

player

started

finished

ip

started

finished

import

error

inProgress

player

started

finished

ip

started

finished

advancedban

started

finished

h2

started

finished

info

error

indexRequired

invalidIndex

index

`duplicateIP`

`duplicateIPAlts`

`configReloaded`

`deniedNotify`

`player`

`ip`

`deniedMaxIp`

`deniedMultiaccounts`

`deniedCountry`

`time`

`now`

`year`

`years`

`month`

`months`

`week`

`weeks`

`day`

`days`

`hour`

`hours`

`minute`

`minutes`

`second`

`seconds`

`never`

`error`

`invalid`

`none`

`sender`

`error`

`notFound`

`offline`

`noSelf`

`exception`

`invalidIp`

`ipNotSupported`

`offlinePermission`

`exempt`

`noPermission`

`invalidReason`

`alts`

`header`

`export`

`error`

`inProgress`

`player`

`started`

`finished`

`ip`

`started`

`finished`

`import`

`error`

`inProgress`

`player`

`started`

`finished`

`ip`

`started`

`finished`

`advancedban`

`started`

`finished`

`h2`

`started`

`finished`

`info`

`error`

`indexRequired`

`invalidIndex`

`index`

`stats`

`player`

`ip`

`connection`

`geoip`

`ban`

`permanent`

`temporary`