Messages

Everything the plugin says lives in messages.yml. The file is written on the first start with every message and its default text, so you can change what players read without touching the code.

plugins/appeltoolsvelocity/messages.yml
plugins/AppelToolsPaper/messages.yml

How a message is written

A message is a piece of MiniMessage, so it can carry colours, bold text and clickable buttons:

prefix:
  normal: "<yellow><bold>AppelTools<reset> <dark_gray>» "
  staff: "<yellow><bold>AppelStaff<reset> <dark_gray>» "

The prefix is what is put in front of a chat or a broadcast message. There is one for the normal chat, one for the staff chat, and the proxy has extra ones for the punishments, the party chat and the friends.

Placeholders

Some messages have a placeholder that the plugin fills in. A placeholder is written between braces:

economy:
  pay-success: "<green>Je hebt <yellow>${AMOUNT} <green>betaald aan <yellow>{TARGET}<green>."

Placeholder	What it holds
{BALANCE}	The balance of the account.
{AMOUNT}	The amount of money.
{TARGET}	The name of the player it is about.
{PLAYER}	The name of the player who did it.
{REASON}	The reason of a punishment or a report.
{SERVER}	The name of the server.
{SERVER_NAME}	The name of the server, in the restart and the join messages.
{SERVER_IP}	The address of the network.
{TIME_LEFT}	The time that is left, written out.
{PAGE} / {MAX_PAGES}	The page of a list and how many there are.
{DATE}	The date of the event.

The generated file lists the placeholders of every section in a comment above it, so you do not have to guess:

# ----------------------------------------------------------------------------
# Home
# Placeholders: {HOME}, {NAME}, {WORLD}, {X}, {Y}, {Z}, {OLD}, {NEW}, {PLAYER}
# ----------------------------------------------------------------------------

TIP

Keep the placeholders. A message that loses its {TARGET} simply shows the text without the name — but a message that keeps a placeholder the plugin does not know shows the placeholder itself.

A message in one line or in many

A message may be a single line or a list of lines. Both work:

rules:
  message:
    - "<yellow><bold>Rules"
    - "<gray>1. Be nice to each other."
    - "<gray>2. No cheating."

The store of the messages file accepts both shapes, so you can turn one line into a list of lines without changing the key.

The sections of the backend

Section	What it holds
prefix	The prefixes of the chat.
economy	The balance, the payments and the leaderboard.
gamemode	The confirmation of a gamemode.
speed	The speed and the flight.
errors	"You do not have permission", "Only players can do this" and the rest.
staff	The freeze, the tool kit and the saved inventory.
reload	The two lines of a reload.
modules	Switching a module on and off.
notes	The notes of a player.
usage	A command that was used wrong.
back	Going back to the last place.
home	The homes.
teleport	The teleport, the requests and the cooldown.
stats	The statistics and the statistics GUI.
seen	When a player was last online.
alts	The accounts that share an address.
geoip	Where a player connects from.
transaction-history	The log of the balance changes.
two-factor	The messages of the reset command.

The sections of the proxy

Section	What it holds
announcements	The announcements that are broadcast on an interval.
prefix	The prefixes: normal, punishment, silent punishment, staff, party and friends.
staff	The broadcast and the staff chat.
staff-notifications	The joins, the leaves and the switches of the staff.
message	The private messages.
report	The reports.
party	The parties.
friends	The friends.
chat-channel	The switch to another chat channel.
punishment	The bans, the mutes, the kicks and their address variants.
restart	The countdown of a restart.
maintenance	The maintenance mode.
server-info	The information of the server in the server list.
rules	The rules that /rules shows.
errors	The errors.
reload	The two lines of a reload.
modules	Switching a module on and off.
chat	The state of the chat.
join	The message that is broadcast when a player joins.
two-factor	The two-factor: the message that holds a staff member, the answers of /verify and /2fasetup and the confirmation of a reset.

TIP

The rules are messages, not configuration: they live in the rules section of messages.yml, not in config.yml.

The language

server.locale is en or nl. It decides the words that the plugin writes for a duration — "5 minutes" or "5 minuten" — and the words for "on" and "off". An unknown value falls back to Dutch, and a change needs a restart.

The texts of the messages are not translated: they are MiniMessage, and you change them in messages.yml. The format of the dates is the same in every language.

Reading the file again

/atp reload and /atv reload read the messages again. A message that you change is live from that moment on.

The file is written back on every start as well: a key that a newer version of the plugin adds appears with its default, and a message that you changed keeps your text.