Skip to content

Utils

Jump to bottom
Soreth edited this page Feb 16, 2021 · 6 revisions

This plugin provides lots of utils to uniformize different aspects.

Item

Item can be either a simple string matching this format : material: damages, amount for simples item.

Or a section with the followings nodes :

MATERIAL is the item material, is required. If not set or invalid will log it and return paper. Since some items have strange name they have some alias. All alias can have caps, , - or _ are allowed to match name.

Alias list for pre 1.13
Alias Material
ironbar IRON_FENCE
ironbars IRON_FENCE
glasspane THIN_GLASS
netherwart NETHER_STALK
netherwarts NETHER_STALK
slab STEP
stoneslab STEP
woodenslab WOOD_STEP
doubleslab DOUBLE_STEP
stonebrick SMOOTH_BRICK
stonebricks SMOOTH_BRICK
stonestair SMOOTH_STAIRS
stonestairs SMOOTH_STAIRS
carrotonstick CARROT_STICK
carrotonastick CARROT_STICK
cobblestonewall COBBLE_WALL
acaciawoodstairs ACACIA_STAIRS
darkoakwoodstairs DARK_OAK_STAIRS
woodslab WOOD_STEP
doublewoodslab WOOD_DOUBLE_STEP
repeater DIODE
piston PISTON_BASE
stickypiston PISTON_STICKY_BASE
flowerpot FLOWER_POT_ITEM
woodshowel WOOD_SPADE
stoneshowel STONE_SPADE
goldshowel GOLD_SPADE
ironshowel IRON_SPADE
diamondshowel DIAMOND_SPADE
steak COOKED_BEEF
cookedporkchop GRILLED_PORK
rawporkchop PORK
hardenedclay HARD_CLAY
hugebrownmushroom HUGE_MUSHROOM_1
hugeredmushroom HUGE_MUSHROOM_2
mycelium MYCEL
poppy RED_ROSE
comparator REDSTONE_COMPARATOR
head SKULL
redstonetorch REDSTONE_TORCH_ON
redstonelamp REDSTONE_LAMP_OFF
glisteringmelon SPECKLED_MELON
acacialeaves LEAVES_2
acacialog LOG_2
gunpowder SULPHUR
lilypad WATER_LILY
commandblock COMMAND
dye INK_SACK
diamondhorsearmor DIAMOND_BARDING
ironhorsearmor IRON_BARDING
goldenhorsearmor GOLD_BARDING
planks WOOD
redflower RED_ROSE
tallgrass LONG_GRASS
fish RAW_FISH
infestedstone SPAWN_EGGS
monsteregg SPAWN_EGGS
When context is item :
Alias Material
-- --
skull SKULL_ITEM
head SKULL_ITEM
playerhead SKULL_ITEM
potato POTATO_ITEM
carrot CARROT_ITEM
cauldron CAULDRON_ITEM
brewingstand BREWING_STAND_ITEM

AMOUNT is the amount of the item.

DAMAGES is the item data ( for block is type like wool color, otherwise it's durability ). Nb : data no longer exist after 1.13 but still work with this plugin.

EXTRA_TYPE is a tag used by the plugin to allow extra item types.

META is item raw nbt, can be in JSON format ( like in /give ) or in yaml format.

Example 
  META:
    AttributeModifiers:
     -
      Name: "generic.movementSpeed"
      AttributeName: "generic.movementSpeed"
      Amount: 2
      Operation: 0
      UUIDLeast: 894654
      UUIDMost: 2872
      Slot: "mainhand"

or

  META: "{AttributeModifiers:[Name: \"generic.movementSpeed\",AttributeName: \"generic.movementSpeed\",Amount: 2,Operation: 0,UUIDLeast: 894654,UUIDMost: 2872,Slot: \"mainhand\"]}

UNBREAKABLE will set the item unbreakable.

NAME is the name of the item.

DESCRIPTION is a list of lore for the item. Note, default is purple and italic, set &r to have white line or any color you want.

FLAG_LIST is a list of Item flag

ENCHANT is a list of enchantment.

Leather armor

COLOR is formatted like this : red:green:blue each value is color component from 0 to 255.

Book

AUTHOR is the author of the book.

TITLE is the title of the book.

PAGES is list of string, each one is a page of book. Can be simple text or native book's json.

Example 
    - '{"text":"Page 1","hoverEvent":{"action":"show_text","value":"This is the first page"}}'
    - '{"text":"This is page 2","clickEvent":{"action":"change_page","value":3}}'
    - "page 3"
    - "page 4"
    - "page 5"

Banner

BASE is the base color of the banner.

PATTERN is a list of pattern for the banner. Each pattern have type as key and color as value.

Example 
 PATTERN:
  STRIPE_MIDDLE: WHITE
  STRIPE_CENTER: WHITE
  STRIPE_DOWNLEFT: WHITE
  STRIPE_DOWNRIGHT: WHITE
  STRAIGHT_CROSS: RED
  CROSS: RED

Skull

OWNER is the skull owner.

Potion

EFFECT_LIST is list of potion effect with type as node.

Enchantment

If you need a single enchantment the format is Enchantment:level.

Note the enchantment is bukkit name. Since some enchants have strange name they have some alias. All alias can have caps, , - or _ are allowed to match name.

Nb : You can use RANDOM as enchantment to get randoms enchantments ( level is the amount of random enchantment ).

Alias list
Enchantment Version Alias(es)
ARROW_DAMAGE 48, minecraft:power, power
ARROW_FIRE 50, minecraft:flame, flame
ARROW_INFINITE 51, minecraft:infinity, infinity
ARROW_KNOCKBACK 49, minecraft:punch, punch
BINDING_CURSE 1.11 10, minecraft:binding_curse, binding_curse
CHANNELING 1.13 minecraft:channeling, channeling
DAMAGE_ALL 16, minecraft:sharpness, sharpness
DAMAGE_ARTHROPODS 18, minecraft:bane_of_arthropods, bane_of_arthropods
DAMAGE_UNDEAD 17, minecraft:smite, smite
DEPTH_STRIDER 8, minecraft:depth_strider, depth_strider
DIG_SPEED 32, minecraft:efficiency, efficiency
DURABILITY 34, minecraft:unbreaking, unbreaking
FIRE_ASPECT 20, minecraft:fire_aspect, fire_aspect
FROST_WALKER 1.9 9, minecraft:frost_walker, frost_walker
IMPALING 1.13 minecraft:impaling, impaling
KNOCKBACK 19, minecraft:knockback, knockback
LOOT_BONUS_BLOCKS 35, minecraft:fortune, fortune
LOOT_BONUS_MOBS 21, minecraft:looting, looting
LOYALTY 1.13 minecraft:loyalty, loyalty
LUCK 61, minecraft:luck_of_the_sea, luck_of_the_sea
LURE 62, minecraft:lure, lure
MENDING 1.9 70, minecraft:mending, mending
MULTISHOT 1.14 minecraft:multishot, multishot
OXYGEN 5, minecraft:respiration, respiration
PIERCING 1.14 minecraft:piercing, piercing
PROTECTION_ENVIRONMENTAL 0, minecraft:protection, protection
PROTECTION_EXPLOSIONS 3, minecraft:blast_protection, blast_protection
PROTECTION_FALL 2, minecraft:feather_falling, feather_falling
PROTECTION_FIRE 1, minecraft:fire_protection, fire_protection
PROTECTION_PROJECTILE 4, minecraft:projectile_protection, projectile_protection
QUICK_CHARGE 1.14 minecraft:quick_charge, quick_charge
RIPTIDE 1.13 minecraft:riptide, riptide
SILK_TOUCH 33, minecraft:silk_touch, silk_touch
SWEEPING_EDGE 1.12 22, minecraft:sweeping, sweeping
THORNS 7, minecraft:thorns, thorns
VANISHING_CURSE 1.11 71, minecraft:vanishing_curse, vanishing_curse
WATER_WORKER 6, minecraft:aqua_affinity, aqua_affinity

If you need a list of enchantment you can either supply only one like above.

Or a list in the above format :

... :
 -Unbreaking:1
 -Sharpness:3
 -fire_aspect:4

Or a list in yaml format :

... :
 Unbreaking: 1
 Sharpness: 3
 fire_aspect: 4

Potion

Each potion effect are created with those node :

DURATION is the time in second, default is 120.

LEVEL is the level of the potion, default is 1.

AMBIANT is if particles are ambient ( less visible ).

PARTICLE only in 1.8 or higher, if display particle or not.

Note, if not specified, type is EFFECT node, otherwise is node name.

Recipe

You can create recipes like this :

ITEM is the item to create.

TYPE is the type of recipe, can be SHAPED, SHAPELESS or FURNACE.

SHAPED

Shaped recipe is classic recipe, like diamond sword, enchanting table ...

SHAPE is the shape of the recipe, can be 1, 2 or 3 line with letter. Note, for air just put a space ( " D " ).

ITEM_LIST is list of section with char as key and material as value. Note if want material data, value is section with MATERIAL for the material and DAMAGES for the data.

Example 
...
 ITEM:
  MATERIAL: diamond
  AMOUNT: 16
 TYPE: SHAPED
 SHAPE:
  - WDW
  - DSD
  - WDW
 ITEM_LIST:
  D: diamond_sword
  W:
   MATERIAL: WOOL
   DAMAGES: 3
  S: netherstar

SHAPELESS

Shapeless recipe is like book, flint and steel, ...

ITEM_LIST is list of section with material as key and amount as value. Note if want material data, value is section with AMOUNT for the amount and DAMAGES for the data.

Example 
...
 ITEM:
  MATERIAL: diamond
  AMOUNT: 1
  NAME: "&4Idiot"
 TYPE: SHAPELESS
 ITEM_LIST:
  diamond: 2
...
 ITEM:
  MATERIAL: wool
  AMOUNT: 2
 TYPE: SHAPELESS
 ITEM_LIST: 
  wool:
   AMOUNT: 2
   DAMAGES: -1 # any type of wool pre 1.13

FURNACE

Furnace recipe, no need to explain.

FROM is the item material to burn. Note if want material data, value is section with DAMAGES for the material and DAMAGES for the data.

Example 
...
 ITEM:
  MATERIAL: diamond
  AMOUNT: 1
 TYPE: FURNACE
 FROM: coal block

Click type

To allow more configuration with click type, my plugin implements his own click types.

  • ALL
    • CLICK
      • MIDDLE correspond to a middle click in the inventory.
      • LEFT
        • LEFT_CLICK correspond to a left click in the inventory.
        • CONTROL_LEFT correspond to a control left click in the inventory.
        • SHIFT_LEFT correspond to a shift left click in the inventory.
      • RIGHT
        • RIGHT_CLICK correspond to a right click in the inventory.
        • CONTROL_RIGHT correspond to a control right click in the inventory.
        • SHIFT_RIGHT correspond to a shift right click in the inventory.
      • CONTROL match CONTROL_LEFT or CONTROL_RIGHT.
      • SHIFT match SHIFT_LEFT or CONTROL.
    • DOUBLE_CLICK
    • DROP_ALL
      • DROP_KEY is when you press the drop key on inventory.
      • DROP_CONTROL is when you press the control drop key on inventory.
      • DROP_HOTBAR is when you press the drop key from hotbar.
    • NUMBER_KEY
      • KEY_1 to KEY_9 is when you press the corresponding hotbar key.
    • USE
      • USE_LEFT is when you left click with item in hand.
      • USE_RIGHT is when you right click with item in hand.

Inventory type

Inventory types used in menus :

1.8+
  • DISPENSER
  • DROPPER
  • CHEST
  • ENDER_CHEST : like a 3 rows chest, only for client textures
  • HOPPER
  • PLAYER : Used for player inventory menu
1.12+
  • SHULKER_BOX : like a 3 rows chest, only for client textures
1.14+
  • BARREL : like a 3 rows chest, only for client textures

Other inventory types causes issues when using bukkit features. To add them I'll need to recode them.

VanillaPlus

Setup

Index

Clone this wiki locally