> For the complete documentation index, see [llms.txt](https://edseries-plugins.gitbook.io/p/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://edseries-plugins.gitbook.io/p/edpets/introduction.md).

# Introduction

<mark style="color:red;">**WARNING: EdPets ONLY WORKS ON PAPER 1.20.4+**</mark>

Welcome to the official documentation for **EdPets** — a high-performance companion pets plugin. This guide covers every feature, configuration file, command and placeholder available in the plugin.

EdPets gives every player **fully packet-based floating pets** (no real entities are ever spawned — pets are **only visible to their owner** and other players receive **zero packets** for them). Pets **level up while grinding** in PinnaPrison, EdTools (EdGens), EdDungeons and EdPrison, **boost currency gains** (shown inside those plugins' booster GUIs), and **swing tools while you grind** — a pickaxe while mining, a hoe while farming, a sword while fighting. On top sit **candy**, **pet boxes**, **scrolls**, **runes**, **candy backpacks**, **upgrades**, **fusion**, the **bin**, **graded boosts**, **enhancements**, **mastery (prestige)** and **presets** — all driven by YAML.

## ✨ Highlights

* **Packet-only pets** — armor-stand floating heads, interpolated item displays, or full **EdLib Blockbench model entities** with animations. One global async task moves every pet on the server.
* **Owner-only visibility** — the owner is the only packet watcher; a server with 500 displayed pets sends each player packets for *their own* pets only.
* **Grind leveling** — per-pet, per-source XP: raw blocks mined in PinnaPrison/EdPrison, zone blocks in EdTools (pickaxe vs hoe zones), sword hits in EdDungeons — or any custom source through the API.
* **Grind animations** — `animations.yml` maps grind sources to held items + swings (and model animations for model pets), fully configurable per source and per pet.
* **Booster integration** — pet currency boosts register inside PinnaPrison / EdTools / EdDungeons booster GUIs and placeholders.
* **Full progression suite** — upgrades (with refunds & toggles), fusion, bin, F→SSS boosts, enhancements, mastery, presets, tradeable candy backpacks.
* **Fully Configurable** — every GUI, item, message, formation and number is editable from YAML.

## 🚀 Installation

1. Download the latest version of the EdPets plugin (`.jar` file).
2. Place the `EdPets.jar` into your server's `plugins/` folder.
3. Install the required dependency: [PlaceholderAPI](https://www.spigotmc.org/resources/placeholderapi.6245/).
4. Restart your server. EdPets generates its default configuration files inside `plugins/EdPets/`.

See the [Installation](/p/edpets/getting-started/installation.md) page for full setup details.

## 🧭 Where to start

* New to the plugin? Read [Installation](/p/edpets/getting-started/installation.md) → [Pets](/p/edpets/core/pets.md) → [Leveling & Grind Sources](/p/edpets/core/leveling-sources.md).
* Making pets swing tools? See [Grind Animations](/p/edpets/core/animations.md).
* Hooking your gamemode plugins? Jump to the [Integrations](/p/edpets/integrations/pinnaprison.md) section.
* Looking for a command or placeholder? Jump to the [Reference](/p/edpets/reference/commands.md) section.

## 💬 Support

Need help? Join the Discord: <https://discord.gg/7RapfdQ7VH>