Skip to Content
PhantomBans is a premium plugin. Get it from the store or join the Discord.
ConfigurationMessages & Screens

Messages & Screens

Change any wording players or staff see. PhantomBans keeps text in a few files so you can find things fast.

FileHolds
messages.ymlMost in-game text: command replies, errors, list headers.
appearance.ymlChat formatting and punishment broadcast messages.
screens.ymlThe full-screen messages shown on disconnect (ban, kick, and so on).

MiniMessage formatting

All text uses MiniMessage, a simple way to add colour and style with tags. A few examples:

<red>This text is red</red> <bold>This text is bold</bold> <gradient:#9B30FF:#FF3A6E>A purple to pink gradient</gradient>

The brand colours are PRIMARY #9B30FF, SECONDARY #FF3A6E, TERTIARY #1AFFB2, HIGHLIGHT #FFD166, and NEUTRAL #C8C8C8. Use them to keep your messages on-brand, or change them to match your server.

Most messages start with <prefix>, which inserts the PhantomBans tag. Edit the prefix line in messages.yml to rebrand every message at once.

Placeholders inside messages

Many messages accept placeholders in curly braces, filled in by the plugin. For example a ban message might use {player}, {reason}, and {expiry}. Keep these tags in place so the message still makes sense, and move them around as you like.

Disconnect screens

screens.yml controls what a player sees when they are kicked or denied entry.

ScreenShown when
banA banned player tries to join.
tempbanA temporarily banned player tries to join.
ipbanAn IP-banned player tries to join.
kickA player is kicked.
country-blockedA player is blocked by a country rule.
vpn-blockedA player is blocked as a VPN or proxy.

Each screen is a list of lines, so you can lay out a tidy multi-line message. If a screen is left empty, the plugin falls back to the ban screen.

What a banned player sees:

The screen a banned player sees

The kick screen:

The kick screen

What an IP-banned player sees:

The screen an IP-banned player sees

The VPN block screen:

The VPN block screen

Apply your changes

After editing any of these files, run:

/phantombans reload

The messages-version and appearance-version lines are managed by the plugin. Do not edit them.

Last updated on