Actions

Format

Starting with v2.0.0 the format for actions was changed to the following {properties} [id] args.

Properties

A set of key=value options separated by space. Read more about properties on their own page. 👇

pageProperties

ID

Each action has its own unique identifier. The id is also case-insensitive, meaning that [CONSOLE] is the same as [console].

Default actions

• Commands

  • [console] <command>

  • [player] <command>

• Economy

  • [addexp] <amount>(L)

  • [item] <material>(:damage) <amount> (args...)

  • [voucher] <name> (amount) (args...)

• Message

  • [bossbar] <message>

  • [chat] <message>

  • [message] <message>

• Other

  • [data] <key> <value>

  • [effect] <effect> <duration> (amplifier)

  • [sound] <sound>

Actions with dependencies

• Crates

  • [givecratereloadedkey] <crate> (amount)

• Vault

  • [addmoney] <amount>

  • [permission] <ADD/REMOVE> <permission.node> (world)

Available actions

Default actions

Commands

[console] - execute a command from console

Arguments

<command>: String, the command to execute

Examples

[console] kill %player_name - make the console run /kill <name>

[player] - execute a command as the player that is using the voucher

Arguments

<command>: String, the command to execute (the slash is not required, unless the command has two or more)

Examples

[player] kit Daily - make the player run /kit Daily

Economy

[addexp] - give to the player an amount of EXP

Arguments

<amount>(L): Integer, amount of exp to add. By appending an L after, levels of exp will be given instead of points

Examples

[addexp] 100 - give 100 EXP points to the player

[addexp] 100L - give 100 levels of EXP to the player

[item] - give to the player a custom item

A format similar to EssentialsX's is used.

Arguments

Required

• material(:damage): String, name of a Material. To specify its damage, add :damage after (INK_SACK:4 for lapiz lazuli on < 1.13)

• amount: Integer, the amount of the item

Optional

• name: String, the name of the item, use _ for space

• lore: String, the lore of the item, use _ for space and | for a new line

• color: ColorString, the color of the item, used for leather armor

• flags: List, a comma separated list of ItemFlag names

• unbreakable: make the item unbreakable, this argument doesn't require a value

• model: Integer, the custom model data of this item (1.14.4+)

• nbt: String, a JSON string representing item's NBT, some escaping should be done, mostly for quotes. This argument must be the last one since it takes everything that's after nbt: as value

For enchantments simply use Enchantment:level For name and lore , if you want to use _ and | you will have to escape them by adding a \ before.

Examples

[item] LEATHER_CHESTPLATE 1 lore:<red>What's</red>_<blue>up?</blue> - a leather chestplate with a lore saying What's up?

[voucher] - give vouchers to the player

Arguments

Required

• name: String, the name of a voucher

Optional

• amount: Integer, the amount of vouchers to give (default: 1)

• args: String, similar to the give command

Examples

[voucher] MoneyPouch 1 - one 'MoneyPouch' voucher

[voucher] Rank 1 VIP 7d - one 'Rank' voucher

Message

[bossbar] - display a boss bar on player's screen

Arguments

message: String, the message that will be displayed

Properties

color: String, the name of a Color (default: WHITE)

duration: Ticks, how long the bar will be displayed (default: 200 or 10 seconds)

flags: List, comma separated list of Flag names (default: empty)

overlay: String, the name of an Overlay (default: PROGRESS)

progress: Float, the progress of the bar (default: MAX_PROGRESS)

Examples

{color=BLUE progress=0.5 display=200} [bossbar] <green>Hey</green> - a blue bar that will stay on the screen for 10 seconds, with 50% progress and a green text saying Hey

[chat] - make the player send a message in chat

Arguments

message: String, the message that will be sent

Examples

[chat] <yellow>Hello everyone, my name is %player_name%!<yellow> - a yellow message saying Hello everyone, my name is <name>!

[message] - send a message to the player

Arguments

message: String, the message that will be sent.

Properties

broadcast: see Properties/Broadcast (default: none)

type: String, the type of the message (ACTION_BAR, CHAT, TITLE) (default: CHAT). Properties for TITLE:

• fadeIn: Ticks, the time the title will fade-in (default: 10 or 0.5 seconds)

• fadeOut: Ticks, the time the title will fade-out (default: 20 or 1 second)

• stay: Ticks, the time the title will stay (default: 70 or 3.5 seconds)

For TITLE, use [n] to separate the title from subtitle (This is the title[n]And this is the subtitle)

Examples

{type=TITLE stay=100] [message] <blue>You have won</blue>[n]<dark_green>$</dark_green><green>50,000</green>- a title that will stay on the screen for 5 seconds saying You have won $50,000

[message] <red>Hey %player_name%, how are you?<red> - a red chat message saying Hey <name>, how are you?

Other

[data] - store a value that can be reused on the next actions

Arguments

key: String, the key of the value, must not contain spaces

value: Anything, the value

Examples

[data] %random% randomL:{100,200} [addmoney] %random% [message] You have received $%amount% Generate a random number and use it to give money and inform the player how much they got.

[effect] - give a potion effect to the player

Arguments

Required:

• effect: String, the name of a PotionEffectType

• duration: Ticks, the duration of the effect

Optional:

• amplifier: Integer, the amplifier of the effect (default: 1)

Properties

Universal: (available on all game versions)

• ambient: Boolean, makes potion effect produce more, translucent, particles (default: true)

• particles: Boolean, whether the effect has particles (default: true)

1.9 - 1.12.2:

• color: ColorString, the color of the particles (default: none)

1.13+:

• icon: Boolean, whether the icon of the effect will be displayed (default: true)

Examples

{particles=false} [effect] SPEED 200 1 - Speed II for 10s with no particles

[sound] - play a sound to the player

Arguments

sound: NamespacedKey, the key of the sound

Properties

broadcast: see Properties/Broadcast (default: none)

pitch: Float, the pitch of the sound (default: 0)

source: String, the name of a Source (default: MASTER)

volume: Float, the volume of the sound (default: 0)

Examples

{source=AMBIENT} [sound] minecraft:ambient.cave - play the sound from AMBIENT source

[sound] custom:sound_name - play a custom sound

Actions with dependencies

Vault

[addmoney] - add money to player's balance

An economy plugin is required to use this action.

Arguments

amount: Double, the amount of money to give

Examples

[addmoney] 125.50

[permission] add or remove a permission to the player

A permissions plugin is required to use this action.

Arguments

Required:

• action: String, the name of the action to perform, ADD or REMOVE

• permission: String, the permission node

Optional:

• world: String, the name of the world where the permission will be added / removed (default: player's world)

Examples

[permission] ADD some.permission world_nether - add the permission only on world_nether

[permission] REMOVE some.permission - remove the permission global