Pet Blueprints

id

String

Yes

Blueprint identifier. If two files resolve to the same id, the duplicate is logged and skipped — since files are loaded into an unordered Set first, which copy is kept isn't guaranteed to follow file/folder order.

default-name

Component (MiniMessage)

Yes

Name given to a newly-created Pet instance. Players can rename their pet afterwards; this is only the initial value.

rarity

String

Yes

Id of a rarity defined in rarities.yml (see Rarities). Loading fails with Invalid rarity ID: <id> if it doesn't resolve.

max-level

int

No

Highest level the pet can reach. Defaults to 20 if omitted.

item

ItemStackWrapper

Yes

The pet's inventory/menu representation (see item).

entity

EntityBlueprint

Yes

The world entity spawned when the pet is summoned (see entity).

effects

Map<String, WrappedPetEffect>

No

Named effect entries that scale with level (see effects). The map key becomes the effect's id — it is what tells two effects of the same type apart (a farmer money bonus and a farmer XP bonus), and what a display line can switch on.

skins

List<String>

No

Ids of the skins a pet of this blueprint may wear. A skin outside this list can never be applied. Ids that no skins/ file declares are kept as written but logged as a warning after each load.

%pet_name%

The pet's current (possibly player-renamed) display name.

%pet_level%

The pet's current level.

%pet_experience%

Experience accumulated toward the next level (resets to 0 on level-up, see How leveling works).

%pet_effects%

Every effect bound to this pet's level, as a provider — iterate it with a list transformer rather than rendering it directly.

$apply-transformer(...)

A transformer from the plugin's transformers/ folder. This is how effect lines, the XP gauge and the "next level" block are drawn.

type

Bukkit EntityType

The type the pet is rendered as, e.g. cow, wolf, allay. It also decides how much room the spawn-spot search needs. Per-type behaviour comes from mob-blueprint, not from this key — see Where behaviour comes from.

mob-blueprint

String

Id of the AstralMobs blueprint the pet spawns as: its goals (follow-owner, idle animations), movement and skills. Blank or omitted falls back to the pet-<blueprint id> convention. A pet naming an unknown mob blueprint logs an error and does not spawn.

baby

boolean

Spawns the pet as a baby variant, where the rendered type has one.

rideable

boolean

Whether the entity can be mounted at all. This is only half the gate: the pet also needs its rideable effect to reach a value of at least 1 at its current level — the [ride-pet] action (EntityService.ride) checks both and messages the player with the level still required if the effect isn't there yet.

name

Component (MiniMessage)

First line of the floating nametag rendered above the entity. Supports %pet_level% and the other pet placeholders (resolved through the same placeholder container as the name/sub-name pair).

sub-name

Component (MiniMessage)

Second line of the floating nametag, rendered below name.

attributes

Map<Attribute, Double>

Namespaced Bukkit attribute keys (e.g. minecraft:max_health) mapped to their base value. Applied via Attribute#setBaseValue right after the entity spawns — any attribute the target mob type doesn't support is silently skipped. Common keys: minecraft:max_health, minecraft:follow_range, minecraft:movement_speed, minecraft:flying_speed, minecraft:scale, minecraft:jump_strength.

type

String

The effect implementation id. Unknown types fail blueprint loading — except for the three hook-backed types, which are skipped with a warning when their plugin is absent.

label

Component

What the effect is called to a player ("Vente Lianes"). The one piece of display text a blueprint still owns.

unit

String

How its value reads — percent, money, flag, level, amount, … Free-form: nothing in Java branches on it, transformers do.

values/modifier-values

Map<int, double>

Per-level value map: key is the pet level, value is the amount added at that level. Either key name is accepted — values is checked first, and modifier-values is used if it's absent or empty.

…effect-specific fields

—

e.g. stat/modifier-key/modifier-type for stats, key/scope for shop-modifier. See Pet Effects.

id

String

Identifier blueprints reference via their own rarity key. The map key above it (commun, rare, …) is free-form and only used to organise the file — lookups match on id, not the map key.

display

Component (MiniMessage)

Rarity label, e.g. used in menus/lore.

color

TextColor

Hex or named colour the rarity's name is written in.

accent-color

TextColor

Optional. The lighter tone its detail text is written in — effect lines, lore headers. Read as %..._rarity_accent%, which falls back to color when unset. Having it here is what keeps a colour change from being a thirty-file edit.

level-expression

String (Crunch expression)

Formula, in terms of a single variable level, for the experience required to advance into that level. See How leveling works.