Shared Configuration Members

Actions

Actions perform some sort of action, usually on the player or the server. Different actions don't have anything in common. Actions are typically always defined in a collection, with each action being executed one after the other.

Spigot compatible example:

actions:
  # Teleport the player to some location
  commands:
    - tp %player_name% 0 65 0
  # Then make them open an existing form or menu called "spawn_form"
  form: spawn_form

Actions available on all server types:

Commands:

# Runs each command in a row. The prefix determines who it is run by, console if unspecified.
# Placeholders supported.
commands:
  - "player; <Command to execute as player>"
  - "op; Command to execute as player, temporarily opped. Currently only works on Spigot.>"
  - "console; <Command to execute as console>"
  - "<Command to execute as console>"
  ...

Message

Sends messages to the player. LEGACY format uses the character to parse legacy formatting codes, and also supports hex colours.
JSON uses the JSON text format for Java Edition.

Default values:

• format: LEGACY
• character: §

message:
  format: <LEGACY or JSON>
  character: '§'
  message: <A single message to send>
  messages:
    - <A message to send>
    - <Another message>
    ...

e.g:

message:
  message: "§5Your balance is now:§2 %player_balance%"

Form

# Makes a player open a form or menu. Does not perform any permission checks. Placeholders supported.
form: <form or menu name>

Server

# Transfers a player to the given BungeeCord or Velocity server. 
# If this is used on Spigot and the server doesn't actually exist, this will fail silently.
server: <BungeeCord or Velocity server name>

Transfer packet

# Instructs a Bedrock Edition player to leave the server, and join a different server. Placeholders supported.
transfer_packet:
  address: <IP address or domain>
  port: <numerical port between 1-65535>

Platform

Possibles values:
bedrock Restricts something to only Bedrock Edition players
java      Restricts something to only Java Edition players
all        No restriction

Permission Default

The default value that a registered permission will be given.
Possible values: false, true, op