Pet Definition

Configure a companion pet

清单由 Pets 提供

字段

字段	类型	默认值	描述
description	String	—	—
texture	String	—	Base64 encoded player head texture for head-display pets. Leave blank for default.
npc	Ref<EntityDefinitionEntry>	—	Optional NPC entity definition used when the pet walks beside the player.
skins	List<PetSkinEntry>	empty	Collection of NPC definitions that players can choose from when the pet walks beside them.
defaultMode	PetDisplayMode	HEAD	—可选值：HEADGROUNDFLY
headOffset	Vector	ZERO	Offset applied when the pet floats above the player in head mode.
swimMode	PetSwimMode	AUTO	How this pet behaves in liquid while using ground mode. AUTO follows the configured entity capabilities.可选值：AUTOALWAYSNEVER
flightHeight	Double	2.0	Height above the owner used by flying pets.
xp	PetXpSettings	—	— PetXpSettings（4） 字段 类型 默认值 描述 formula String — Optional arithmetic expression using {level} to calculate XP required per level. levels List<PetLevelRequirement> empty Explicit XP requirements that override the formula when provided. PetLevelRequirement（3） 字段 类型 默认值 描述 level Int 1 — xp Int 0 — damage Double? — Damage dealt by the pet when retaliating at this level. Leave empty to use the default scaling. maxLevel Int 10 Maximum level this pet can reach. killReward Int 0 Experience granted whenever the owner kills an entity.
combat	PetCombatSettings	—	— PetCombatSettings（1） 字段 类型 默认值 描述 enabled Boolean false Enable simple retaliation behaviours when the owner is attacked.
token	PetTokenSettings	—	— PetTokenSettings（4） 字段 类型 默认值 描述 item Item — TypeWriter item captured or built to represent this pet when given to players. lore List<String> — Lore of the token. Supports MiniMessage and the placeholder {name}. glow Boolean false Adds a glowing enchantment effect to the token item. noSlotMessage String <red>Ton menu des compagnons est plein. Message sent when the player has no available slot for this pet. Supports MiniMessage.

How to use it

One Pet Definition describes one species. The entry name is the display name and its id is what commands, actions and placeholders use.

Display.

• defaultMode: HEAD floats above the player (with headOffset), GROUND walks beside the player, FLY hovers flightHeight blocks above.
• texture: a base64 skin texture for the floating head and the token item.
• npc: an entity definition spawned for GROUND and FLY, and for HEAD when you want a model instead of a head. It is also the fallback when no skin matches.
• skins: alternative NPC skins. Each needs an npc, and uses priority (higher first) and criteria to decide whether the player may wear it. icon is the item shown in the skin menu, where {skin} is replaced by the skin name.

Progression. In xp:

• maxLevel is the top level.
• levels lists, for each level, the total xp the pet must have. An optional damage sets the retaliation damage from that level on.
• formula is used when a level is not in levels. It may contain {level} and + - * / with parentheses, for example {level} * 100.
• killReward is the XP the pet earns each time its owner kills something while it is active.

Combat and token. combat.enabled turns on retaliation against mobs that hit the owner. token defines the item players receive: item, name and lore (MiniMessage, with {name} replaced by the pet name), glow, and noSlotMessage shown when the menu is full.

A pet with GROUND or FLY and no usable npc is never shown. swimMode only matters for ground pets.