Appendix

NBT Data Types

The following are a list of acceptable types to use when creating NBT Tags for items.

NBT Tag Type

Bounds

BOOLEAN

true or false

BYTE

-128 to 127

SHORT

-32768 to 32767

INT

-2147483648 to 2147483647

LONG

-18446744073709551616 to 18446744073709551615

FLOAT

N/A

DOUBLE

N/A

BYTE_ARRAY

Essentially a LIST containing BYTE elements. The same bounds apply for BYTE.

STRING

N/A

COMPOUND

N/A

INT_ARRAY

Essentially a LIST containing INT elements. The same bounds apply for INT.

LIST

A LIST can contain elements of type INT, FLOAT, DOUBLE, LONG, or STRING. The same bounds apply for those types.

The following section contains various supplementary materials related to defining items in ItemAPI format, such as colors, patterns, enchantments, and potions.

Item Flags

The following are all available item flags that can be applied to items.

Item Flag

Purpose

Version

HIDE_ATTRIBUTES

Applicable to tools and weapons, hides attributes such as attack speed and attack damage.

1.12+

HIDE_DESTROYS

Applicable to tools, hides what an item can break and destroy.

1.12+

HIDE_DYE

Applicable to colored leather armor, hides the dyes from a piece of colored leather armor.

1.16+

HIDE_ENCHANTS

Hides the enchantments applied to an item.

1.12+

HIDE_PLACED_ON

Applicable to blocks, hides where the item can be built/placed on.

1.12+

HIDE_POTION_EFFECTS

Applicable to potions, hides the potion effects applied to an item.

1.12+

HIDE_UNBREAKABLE

Applicable to tools and weapons, hides if an item is unbeakable (see the bove section).

1.12+

Dye Colors

The following are colors that are applicable to patterns on banners and shields or fish in tropical fish buckets. These colors can also be used for leather armor.

Color

WHITE

ORANGE

MAGENTA

LIGHT_BLUE

YELLOW

LIME

PINK

GRAY

LIGHT_GRAY

CYAN

PURPLE

BLUE

BROWN

GREEN

RED

BLACK

Pattern Types

The following are pattern types that are applicable to patterns on banners and shields. Either the full pattern name or the short identifier can be used.

Pattern Type

Identifier

BASE

b

SQUARE_BOTTOM_LEFT

bl

SQUARE_BOTTOM_RIGHT

br

SQUARE_TOP_LEFT

tl

SQUARE_TOP_RIGHT

tr

STRIPE_BOTTOM

bs

STRIPE_TOP

ts

STRIPE_LEFT

ls

STRIPE_RIGHT

rs

STRIPE_CENTER

cs

STRIPE_MIDDLE

ms

STRIPE_DOWNRIGHT

drs

STRIPE_DOWNLEFT

dls

STRIPE_SMALL

ss

CROSS

cr

STRAIGHT_CROSS

sc

TRIANGLE_BOTTOM

bt

TRIANGLE_TOP

tt

TRIANGLES_BOTTOM

bts

TRIANGLES_TOP

tts

DIAGONAL_LEFT

ld

DIAGONAL_RIGHT

rd

DIAGONAL_LEFT_MIRROR

lud

DIAGONAL_RIGHT_MIRROR

rud

CIRCLE_MIDDLE

mc

RHOMBUS_MIDDLE

mr

HALF_VERTICAL

vh

HALF_HORIZONTAL

hh

HALF_VERTICAL_MIRROR

vhr

HALF_HORIZONTAL_MIRROR

hhb

BORDER

bo

CURLY_BORDER

cbo

CREEPER

cre

GRADIENT

gra

GRADIENT_UP

gru

BRICKS

bri

SKULL

sku

FLOWER

flo

MOJANG

moj

GLOBE

glo

Firework Effect Types

The following are effect types that can be applied to firework rockets and stars.

Effect Type

BALL

BALL_LARGE

STAR

BURST

CREEPER

Colors

The following are colors that can be applied to firework rockets, firework stars, and leather armor.

Warning

These colors cannot be used with banners, shields or tropical fish buckets! See Dye Colors for colors to be used with those items.

Color

WHITE

SILVER

GRAY

BLACK

RED

MAROON

YELLOW

OLIVE

LIME

GREEN

AQUA

TEAL

BLUE

NAVY

FUCHSIA

PURPLE

ORANGE

Potion Types

The following is a list of potion types available to use with potions and splash potions. Either the official name or any of the common names can be used.

Note

Make sure the potion type you are using exists in the Minecraft version you are running!

Official Name

Common Names

Version

Upgradeable?

Extendable?

Notes

FIRE_RESISTANCE

fireresistance, fireresist, resistfire

No

Yes

SPEED

swiftness, swift, quick

Yes

Yes

SLOWNESS

slow

No

Yes

INSTANT_HEAL

healing, heal, instantheal, instanthealing, healinstant, healinginstant

Yes

No

INSTANT_DAMAGE

harming, harm, instantdamage, instantdmg, dmginstant, damageinstant

Yes

No

POISON

Yes

Yes

REGEN

regeneration

Yes

Yes

STRENGTH

Yes

Yes

WEAKNESS

No

Yes

WATER

aqua

No

No

LUCK

No

No

This potion cannot be brewed or obtained via normal means.

NIGHT_VISION

nightvision, nightvis

1.4.2+

No

Yes

INVISIBILITY

1.4.2+

No

Yes

WATER_BREATHING

waterbreathing, waterbreathe, breathewater

1.7.2+

No

Yes

JUMP

leaping, leap, jumping

1.8+

Yes

Yes

TURTLE_MASTER

turtlemaster, masterturtle

1.13+

Yes

Yes

SLOW_FALLING

slowfalling, flowfall, fallingslow, fallslow

1.13+

No

Yes

Enchantments

The following is a list of enchantments available to use with enchantable items. Either the official name or the common names can be used.

Note

Make sure the enchantment you are using exists in the Minecraft version you are running!

Official Name

Common Names

Version

DAMAGE_ALL

sharpness, damageall, alldamage, dmg

DAMAGE_ARTHROPODS

bane_of_arthropods, baneofarthropods, damagearthropods, arthropodsdamage

DAMAGE_UNDEAD

smite, damageundead, undeaddamage

DIG_SPEED

efficiency, digspeed

DURABILITY

unbreaking

FIRE_ASPECT

fireaspect, fire

KNOCKBACK

knock

LOOT_BONUS_BLOCKS

fortune, lootbonusblocks, blockslootbonus, lootbonusblock

LOOT_BONUS_MOBS

looting, lootbonusmobs, mobslootbonus, lootbonusmob

OXYGEN

respiration, waterbreathing, breathing

PROTECTION_ENVIRONMENTAL

protection, protectionenvironmental, protect, prot

PROTECTION_EXPLOSIONS

blast_protection, blastprotection, protectionexplosions, explosionsprotection, expprotect, expprot

PROTECTON_FALL

feather_falling, featherfalling, protectionfall, fallprotection, fallprotect, fallprot

PROTECTION_FIRE

fire_protection, fireprotection, protectionfire, fireprotect, fireprot

PROTECTION_PROJECTILE

projectile_protection, projectileprotection, projectionprojectile, projectileprotect, projectileprot

SILK_TOUCH

silktouch, silk

WATER_WORKER

aqua_affinity, aquaaffinity, waterworker

ARROW_DAMAGE

power, arrowdamage

1.1+

ARROW_FIRE

flame, arrowfire, firearrow

1.1+

ARROW_INFINITE

infinity, arrowinfinite, infinitearrow

1.1+

ARROW_KNOCKBACK

punch, arrowknockback, knockbackarrow

1.1+

THORNS

thorn

1.4.6+

LUCK

luck_of_the_sea, luckofthesea, luckofsea

1.7.2+

LURE

luring

1.7.2+

DEPTH_STRIDER

depthstrider, striderdepth

1.8+

FROST_WALKER

frostwalker, frost

1.9+

MENDING

mend

1.9+

BINDING_CURSE

curse_of_binding, curseofbinding, binding

1.11+

VANISHING_CURSE

curse_of_vanishing, curseofvanishing, vanishing

1.11+

SWEEPING_EDGE

sweeping

1.11.1+

LOYALTY

1.13+

IMPALING

1.13+

RIPTIDE

1.13+

CHANNELING

1.13+

MULTISHOT

1.14+

QUICK_CHARGE

quickcharge

1.14+

PIERCING

1.14+

SOUL_SPEED

soulspeed

1.16+

Tropical Fish Patterns

The following are patterns available for tropical fish contained within a tropical fish bucket.

Pattern

KOB

SUNSTREAK

SNOOPER

DASHER

BRINELY

SPOTTY

FLOPPER

STRIPEY

GLITTER

BLOCKFISH

BETTY

CLAYFISH

Axolotl Variants

The following axolotl variants are available for axolotl buckets.

Variant

Description

LUCY

Leucistic (pink) axolotl

WILD

Brown axolotl

GOLD

Gold axolotl

CYAN

Cyan axolotl

BLUE

Blue axolotl

Entity Types

The following entity types can be used with spawners as well as with spawn eggs if you are using Minecraft version 1.12 and below.

Entity Type

Version

BAT

BEE

1.15+

BLAZE

CAT

1.14+

CAVE_SPIDER

CHICKEN

COW

CREEPER

DOLPHIN

1.13+

DONKEY

1.11+

DROWNED

1.13+

ELDER_GUARDIAN

1.11+

ENDER_DRAGON

ENDERMAN

ENDERMITE

1.8+

EVOKER

1.11+

FOX

1.14+

GHAST

GIANT

GUARDIAN

1.8+

HOGLIN

1.16+

HORSE

HUSK

1.11+

ILLUSIONER

1.12+

IRON_GOLEM

LLAMA

1.11+

MUSHROOM_COW

OCELOT

PANDA

1.14+

PARROT

1.12+

PHANTOM

1.13+

PIG

PIGLIN

1.16+

PILLAGER

1.14+

PIG_ZOMBIE

1.7-1.15

ZOMBIFIED_PIGLIN

1.16+

POLAR_BEAR

1.10+

RABBIT

1.8+

RAVAGER

1.14+

SHEEP

SHULKER

1.9+

SILVERFISH

SKELETON

SKELETON_HORSE

1.11+

SLIME

SNOWMAN

SPIDER

SQUID

STRAY

1.11+

STRIDER

1.16+

TRADER_LLAMA

1.14+

TURTLE

1.13+

VEX

1.11+

VILLAGER

VINDICATOR

1.11+

WITCH

WITHER

WOLF

ZOGLIN

1.16+

ZOMBIE

ZOMBIE_HORSE

1.11+

ZOMBIE_VILLAGER

1.11+