> For the complete documentation index, see [llms.txt](https://lethium.gitbook.io/lethium-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://lethium.gitbook.io/lethium-docs/gameplay/pets.md). # Pets Pets: rarities, stats, leveling, prestige, enhancement, grades, boosts, candy, tickets, upgrades and set bonuses. Files: `plugins/ClickEmCore/modules/pets.yml` (global settings and defaults) and `plugins/ClickEmCore/modules/pets/.yml` (one file per pet). Module id: `pets`. Commands: `/pet`, `/pets`. {% hint style="success" %} **Quick start** * Give a pet: `/ceadmin pet grant `. * Make a pet stronger: `stats.power` in its file in `modules/pets/`. * Change egg odds: a rarity's `egg-weight` in `pets.yml`. * Rename a pet: `clickem.pets..name` in `lang/en_us.yml`. * Reload: `/clickem module reload pets`. Deep settings are on the [advanced page](/lethium-docs/gameplay/pets-advanced.md). {% endhint %} Pets are the flagship collectible. Equipped pets float behind the player as **floating heads** and give stats. Players get them from [Eggs](/lethium-docs/gameplay/eggs.md), [Fusion](/lethium-docs/gameplay/fusion.md), events, crates and trading. There are 240 pets (6 per zone, 40 zones) and 40 eggs. A new player receives one free starter pet (`starter-pet: Z1_1`), equipped automatically, only once and only if they own no pets. ### What a pet gives A pet can only give **three** stats, and which ones depends on its rarity. Anything else in a pet file is removed at load with a console warning. | Stat in the pet file | Gives | Available from | | -------------------- | -------------------- | ------------------ | | `power` | + % Power | every rarity | | `coins` | + % Coins per kill | epic and above | | `essence` | + % Artifact Essence | mythical and above | ### Rarities (`rarities:` in pets.yml) | Rarity | Egg weight | Level cap | Enhancement cost x | Glow | | --------- | ---------- | --------- | ------------------ | ---- | | common | 60 | 40 | 1 | no | | rare | 25 | 70 | 2 | yes | | epic | 10 | 110 | 4 | yes | | legendary | 4 | 160 | 8 | yes | | mythical | 1 | 220 | 16 | yes | | ancient | 0.4 | 300 | 32 | yes | | event | 0 | 400 | 32 | yes | `event` never comes from an egg. It is only given by events or `/ceadmin pet grant`. Each rarity also sets the floating head look: `head-scale-multiplier`, `glow`, `particle` and `particle-count`. Players can turn this presentation off for their own pets with **Pet Glow** in `/settings`. Golden, Rainbow and Shiny variants are shown at least at the rarity in `visuals.variant-rarity-floor` (epic, mythical, event). ### A pet file ```yaml display-name: "clickem.pets.Z1_1.name" rarity: common visual: type: vanilla entity: CHICKEN stats: power: 1 abilities: - type: ON_KILL_BONUS_LOOT chance: 18.0 amount: 8 fusion-tiers: golden: power-multiplier: 1.4 coins-multiplier: 1.6 essence-multiplier: 1.5 required-duplicates: 5 rainbow: {power-multiplier: 2.2, coins-multiplier: 2.8, essence-multiplier: 2.5, required-duplicates: 8} shiny: {power-multiplier: 3.5, coins-multiplier: 5.0, essence-multiplier: 4.2, required-duplicates: 12} fusion-recipe: result: Z1_2 required-count: 3 success-chance: 80 ``` The file name is the pet id. `Z1_1` = zone 1, slot 1 of 6. | Key | Meaning | | -------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | | `display-name` | Language key or inline MiniMessage text. | | `rarity` | One of the rarities above. | | `visual.entity` | The mob the floating head is based on. | | `visual.head-texture` | Optional base64 skin to override the species head. | | `stats` | `power`, `coins`, `essence`. | | `abilities` | See below. | | `fusion-tiers` | The Golden, Rainbow, Shiny ladder. Numbers multiply each of the three stats. `required-duplicates` is how many copies are needed. | | `fusion-recipe` | Species fusion. See [Fusion](/lethium-docs/gameplay/fusion.md). | | `leveling`, `enhancement`, `candy`, `grades`, `boosts`, `idle-earning`, `storage`, `mastery` | Optional per-pet overrides of the defaults in `pets.yml`. Same names as the defaults. | #### Pet abilities | Type | What it does | Fields | | --------------------------------------------------------------- | ------------------------------------------------------------------------------------ | --------------------------- | | `ON_KILL_BONUS_LOOT` | Chance of bonus Coins on a kill. | `chance`, `amount` | | `ON_KILL_CURRENCY_MULTIPLY` | Chance of a multiplied payout. | `chance`, `amount` | | `ON_HIT_EXECUTE_CHANCE` | Chance to finish off a mob already under `amount`% health. | `chance`, `amount` | | `PASSIVE_TICK_CURRENCY`, `PASSIVE_TICK_HEAL`, `PASSIVE_TICK_XP` | Something every `intervalSeconds`. | `intervalSeconds`, `amount` | | `ACTIVE_ABILITY` | The player triggers it (`/pet ability`, or a click in the Pet menu) with a cooldown. | `cooldownSeconds`, `amount` | | `AURA_NEARBY_BUFF` | A Coins trickle for other nearby players too. | `amount` | Coin amounts here are **units scaled by progress** (see [Reward scaling](/lethium-docs/configuration/reward-scaling.md)). ### Loadout `loadout.base-max-equipped: 3`. The total equip slots = base + **Pet Slots** universal upgrade + VIP `extra-pet-slots` + the Rebirth slot milestone. The Pet menu has a 9-button loadout row, so totals are capped at 9. ### Leveling (`leveling:`) | Key | Default | Meaning | | ------------------------------------------------- | -------- | ----------------------------------------------------------------------- | | `base-xp`, `growth` | 50, 1.12 | XP for level N = `base-xp x growth^(N-1)`. | | `stat-growth-percent-per-level` | 1.0 | Each level above 1 adds this percent to base stats. | | `xp-per-kill` | 1.0 | XP an equipped pet earns per kill. | | `milestone-interval`, `milestone-reward-currency` | 10, 100 | Coins (scaled) every N levels. | | `prestige.enabled` | true | A pet at its cap can **prestige**: level resets, for a permanent bonus. | | `prestige.bonus-per-prestige-percent` | 1.0 | Bonus per prestige. | | `prestige.level-cap-boost-per-prestige` | 5 | Level cap raised per prestige. | ### Idle earning (`idle-earning:`) Off by default. When on, owned but **unequipped** pets earn `percent-of-active-rate` (25%) of their normal rate. > **Deep settings:** grades, enhancement, boost slots, candy, tickets, scrolls, storage, upgrades and sets are on [Pets: advanced settings](/lethium-docs/gameplay/pets-advanced.md). You only need them to rebalance the collecting game. ### How to {% tabs %} {% tab title="Give a player a pet" %} `/ceadmin pet grant [level] [grade]`. Find pet ids with `/ceadmin pet list ` or by looking at the file names in `modules/pets/`. {% endtab %} {% tab title="Make a pet stronger" %} Edit `stats.power` (and `coins`, `essence` if its rarity allows) in its file, then run `/clickem module reload pets`. {% endtab %} {% tab title="Change egg odds" %} Change `egg-weight` of a rarity in `pets.yml`, or change which pets are in an egg's `loot.pool` in `eggs.yml`. See [Eggs](/lethium-docs/gameplay/eggs.md). {% endtab %} {% tab title="Rename a pet" %} Edit `clickem.pets..name` in `lang/en_us.yml`, or put inline MiniMessage text in `display-name`. {% endtab %} {% tab title="Change a pet's head" %} Set `visual.head-texture` in its file to a base64 skin value, or add its mob type to `visuals.entity-textures` in `pets.yml`. On startup the console lists every mob type still missing a texture. Get values from minecraft-heads.com. {% endtab %} {% tab title="Add a pet" %} See [Add a pet](/lethium-docs/how-to/add-a-pet.md). {% endtab %} {% endtabs %} ### Staff commands `/ceadmin pet grant`, `set`, `max`, `delete`, `list`. See [Admin commands](/lethium-docs/commands/admin-commands.md). ### Placeholders `%clickem_pet_equipped_count%`, `%clickem_pet_1_name%`, `%clickem_pet_1_power_formatted%` and more. See [Pet and Echo placeholders](/lethium-docs/placeholders/pets-and-echoes.md). --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://lethium.gitbook.io/lethium-docs/gameplay/pets.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.