Wrappers For Server Admins

This section is dedicated to server admins. If you are looking for the developers' page, click here

Many of the fields referenced on this page might be or require platform-specific values. Check the glossary

The wrappers module is a general subproject for holding multiple Minecraft objects. Its main focus is to provide an easy solution for both server admins and developers to store and load Minecraft specific data from any platform.

On this page we go over all the available wrappers and their usages.

Table of contents
Enchants
Potions
Sounds
Particles

Enchants

Enchantments can be specified by following the format <enchantment>:<level> where the level is optional.

Examples:

enchant: "unbreaking" # The default value is 1
levelled-enchant: "sharpness:3" 

Potions

There are many ways to specify Potions, but the main idea is that each value is separated by :. Here are all the accepted values:

• the name of the potion (mandatory);
• its duration (optional, by default 1 second);
• its level (optional, by default 1);
• display particles (optional, by default true);
• display icon (optional, by default true).

Examples:

simple-potion: "strength"
normal-potion: "strength:10.0:3"
extended-potion: "strength:10.0:3:false:true"

Sounds

Similarly to potions, also Sounds allow for multiple values to be specified. Here are all the accepted ones:

• the name of the sound (mandatory);
• its volume (optional, by default 1.0). The volume on vanilla Minecraft is limited between 0.0 (the quietest) and 1.0 (the loudest). Inputting higher values will make farther players hear the sound as if they were near its source;
• its pitch (optional, by default 1.0). The pitch on vanilla Minecraft is limited between 0.0 (the slowest) and 2.0 (the fastest). It defines the speed at which the sound will be played;
• its category (optional). Specifying the category will allow the sound to be played for the said category. For example, if the category is hostiles and the player muted it, they will not hear the sound.

Examples:

simple-sound: "villager_happy"
high-sound: "villager_happy:10.0"
categorized-sound: "villager_happy:1.0:2.0:hostiles"

Particles

Particles can be specified simply by their name.

You can find a full list here.

simple-particle: 
  type: FLAME
simple-optionable-particle: 
  type: REDSTONE # Even though REDSTONE accepts an option, it is NOT required. 

WARNING: for older versions of Minecraft, check out the effects section.

Special types of particles

As anticipated, some particles can have specific options that will change their behaviour. These are particle-specific, and should not be mixed with others, as they can be either ignored or cause errors.

Here is a full list of examples:

• REDSTONE, two options can be specified:
  • the color of the particle, either in HEX format or by one of the default values: WHITE, SILVER, GRAY, BLACK, RED, MAROON, YELLOW, OLIVE, GREEN, AQUA, TEAL, BLUE, NAVY, FUCHSIA, PURPLE, ORANGE;
  • the size of the particle (appending an f to a decimal number).

particle:
  type: REDSTONE
  option:
    color: RED
    size: 4.0f 

• ITEM_CRACK, it allows an item to be specified. It requires an Item from the item module to be passed. For more specific documentation, check the official documentation.

particle:
  type: ITEM_CRACK
  option:
    material: DIAMOND_SWORD

• BLOCK_CRACK, it allows a block to be specified and, optionally, its nbt tags in square brackets.

particle:
  type: BLOCK_CRACK
  option: oak_log[axis=y]  

• BLOCK_DUST, it allows a block to be specified and, optionally, its nbt tags in square brackets.

particle:
  type: BLOCK_DUST
  option: oak_log[axis=y]  

• FALLING_DUST, it allows a block to be specified and, optionally, its nbt tags in square brackets.

particle:
  type: FALLING_DUST
  option: oak_log[axis=y]  

• DUST_COLOR_TRANSITION, three options can be specified:
  • the color to start from, either in HEX format or by one of the default values: WHITE, SILVER, GRAY, BLACK, RED, MAROON, YELLOW, OLIVE, GREEN, AQUA, TEAL, BLUE, NAVY, FUCHSIA, PURPLE, ORANGE;
  • the color to end with;
  • the size of the particle (appending an f to a decimal number).

particle:
  type: DUST_COLOR_TRANSITION
  option:
    from: WHITE
    to: BLACK
    size: 5.0f

• SCULK_CHARGE, it accepts a decimal number with an f at the end that represents the rotation of the particle (uses radians):

particle:
  type: SCULK_CHARGE
  option: 2.0f

• SHRIEK, after how much time in ticks (1 second = 20 ticks) the particle should be displayed:

particle:
  type: SHRIEK
  option: 3

• VIBRATION, there is no official way of modifying values for this type; therefore, its interchangeability will depend on the developer.

Effects

WARNING: the following section contains some deprecated features for Minecraft versions prior to 1.13.

In older versions of Minecraft, particles were handled differently, and they were named effects. Although some effects remained during the course of the years, many were dropped in favor of particles. Luckily, their configuration methods are unchanged: both type and option are still valid (and required) fields.

Here you will find a full list of supported effects, with a clear separation between 1.13- and 1.20+ specific effects.

simple-effect: ENDER_SIGNAL

Special types of effects

As for the particles case, also effects support specific options based on the effect.

Here a full list of examples:

• SMOKE, allows specifying the direction of the smoke. Any value is accepted, but, based on the platform in use, these can be wrong;

effect:
  type: SMOKE
  option: NORTH

• POTION_BREAK, allows specifying a potion in a format similar to Potions. The allowed values are:
  • type: the type of the potion (name);
  • level: the level of the potion (can be either 1 or 2, by default 1);
  • splash: true if it is a splash potion (by default false);
  • extended: true if it is extended (by default false);

effect:
  type: POTION_BREAK
  option: "strength:2:false:true"

• VILLAGER_PLANT_GROW, allows specifying the number of particles.

effect:
  type: VILLAGER_PLANT_GROW
  option: 15

• ITEM_BREAK, allows specifying the material (id) of the item;

effect:
  type: ITEM_BREAK
  option: DIAMOND_SWORD

• TILE_BREAK, allows specifying the material (id) of the item and its data as numbers; WARNING: this option is deprecated for Minecraft 1.13+.

effect:
  type: TILE_BREAK
  option: oak_log[1]

• TILE_DUST, allows specifying the material (id) of the item and its data as numbers; WARNING: this option is deprecated for Minecraft 1.13+.

effect:
  type: TILE_DUST
  option: oak_log[1]

• COMPOSTER_FILL_ATTEMPT, allows specifying if the attempt was successful or not.

effect:
  type: COMPOSTER_FILL_ATTEMPT
  option: true

• BONE_MEAL_USE, allows specifying the number of particles.

effect:
  type: BONE_MEAL_USE
  option: 7

• ELECTRIC_SPARK, allows specifying the axis of the particle. This can either be X, Y or Z.

effect:
  type: ELECTRIC_SPARK
  option: Z

• INSTANT_POTION_BREAK, allows specifying the color of the broken potion, either in HEX format or by one of the default values: WHITE, SILVER, GRAY, BLACK, RED, MAROON, YELLOW, OLIVE, GREEN, AQUA, TEAL, BLUE, NAVY, FUCHSIA, PURPLE, ORANGE.

effect:
  type: INSTANT_POTION_BREAK
  option: PURPLE