Skip to main content

Pet Definition

Type: pet_definition Defines a species of pet. This includes its default appearance, leveling progression, and combat settings.

Configuration

FieldTypeDefaultDescription
idString""Unique identifier.
descriptionString""Internal description.
textureString""Base64 texture for HEAD mode.
npcRef<EntityDefinition>EmptyEntity definition for GROUND mode or skin.
skinsList<Skin>[]List of alternative skins.
defaultModeEnumHEADHEAD (floating) or GROUND (walking).
headOffsetVectorZeroOffset for floating head position.
xpXpSettingsLeveling configuration.
combatCombatSettingsRetaliation configuration.
tokenTokenSettingsAppearance of the item representing this pet.

Xp Settings

FieldTypeDefaultDescription
formulaString""Expression using {level} for XP per level.
levelsList<Level>[]Explicit per-level requirements.
maxLevelInt10Maximum achievable level.
killRewardInt0XP gained when owner kills a mob.

Combat Settings

FieldTypeDefaultDescription
enabledBooleanfalseWhether the pet attacks attackers.

Token Settings

FieldTypeDefaultDescription
itemItemPlayerHeadIcon used in menus/items.
nameString""Display name.
loreList<String>Item lore.
glowBooleanfalseIf the item glows.