Skip to content

signs.yml

The signs.yml file controls arena join signs. Signs can show the arena state, player limits, map metadata, and any branding text you want players to see before joining.


The lines section defines the four lines shown on registered arena signs.

lines:
- "<gradient:#FF1744:#D50000><bold>TNT Run</gradient>"
- "%state%"
- "<gradient:#00E676:#29B6F6><bold>%map_name%</bold></gradient>"
- "<#455A64>[ <#CFD8DC>%players% <#455A64>/ <#CFD8DC>%max_players% <#455A64>]"

PlaceholderDescription
%state%The configured state label from game-states.
%players%Current player count.
%min_players%Minimum players required to start.
%max_players%Arena maximum player count.
%map_name%Arena display map name.
%map_author%Arena map author.
%map_difficulty%Arena map difficulty.

Placeholders are resolved before MiniMessage formatting, so they can be placed inside tags such as gradients and bold text:

- "<gradient:#00E676:#29B6F6><bold>%map_name%</bold></gradient>"

The game-states section lets you change how arena states appear on signs.

game-states:
waiting: "<#00E676><bold>WAITING"
starting: "<#FFAB00><bold>STARTING"
in-game: "<#FF5252><bold>IN GAME"
full-game: "<#D50000><bold>FULL"
ending: "<#9E9E9E><bold>ENDING"
restarting: "<#607D8B><bold>REBOOTING"
inactive: "<#B0BEC5><bold>MAINTENANCE"

The top-level messages in this file are used for sign setup feedback.

MessagePurpose
createdSent when an arena sign is registered successfully.
removedSent when an arena sign is removed.
no-perm-to-breakSent when a player tries to break a registered sign without permission.
look-at-a-signSent when the setup action cannot find a valid sign block.

The created and removed messages can use these location placeholders:

PlaceholderDescription
%x%Sign block X coordinate.
%y%Sign block Y coordinate.
%z%Sign block Z coordinate.
%direction%Direction the sign is facing.

Breaking registered TNT Run signs requires:

tntrun.sign.break

The cleanest way to create a join sign is through the setup menu:

  1. Run /tr edit <arena>.
  2. Open the sign setup item.
  3. Look at or select the target sign block.
  4. Save it for the arena.

The plugin will then update the sign as the arena state changes.