> 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/getting-started/installation.md).

# Installation

## Requirements

* **Paper 1.20.4+** (Spigot is not supported — EdPets uses Paper API).
* **Java 21+**.
* [**PlaceholderAPI**](https://www.spigotmc.org/resources/placeholderapi.6245/) — required.

## Steps

1. Drop `EdPets.jar` into `plugins/`.
2. Make sure PlaceholderAPI is installed (EdPets will not enable without it).
3. Restart the server (do not use plugin managers to hot-load).
4. EdPets generates its configuration inside `plugins/EdPets/`:

```
plugins/EdPets/
├── config.yml            # data storage, pet/display settings, lore addons
├── messages.yml          # every chat message
├── tiers.yml             # pet rarities
├── animations.yml        # grind animation profiles (held items + swings)
├── candy.yml             # candy definitions
├── pet-boxes.yml         # pet box definitions + opening animation
├── scrolls.yml           # owner / rarity / level / black scrolls
├── runes.yml             # rune definitions
├── enhancements.yml      # enhancement rolls
├── boosts.yml            # F → SSS boost grades
├── upgrades.yml          # the player upgrade engine
├── fusion.yml            # fusion mode + economy
├── mastery.yml           # mastery broadcast
├── presets.yml           # preset limits
├── candy-backpacks.yml   # backpack types + upgrades
├── currencies/           # internal ticket currencies (one file each)
├── pets/                 # one file per pet type (dragon.yml ships as example)
├── guis/                 # every menu layout
└── models/               # optional EdLib Blockbench models for model pets
```

## Integrations (optional)

EdPets hooks automatically when these plugins are present — nothing to configure:

* **PinnaPrison** — pets level from mined blocks, boost currencies & enchant proc chance, show in the boosters GUI.
* **EdTools (EdGens)** — pets level from zone blocks (pickaxe/hoe zones behave differently), boost currencies, show in the boosters GUI.
* **EdDungeons** — pets level from sword hits and mob kills, boost currencies, show in the boosters GUI.
* **EdPrison** — pets level from mined blocks and boost currencies through its multiplier event.

{% hint style="info" %}
Booster **GUI display** needs an up-to-date build of the target plugin. On older builds EdPets logs `currency fallback` — boosts still apply, they just don't render a line in that plugin's boosters menu.
{% endhint %}

## Storage

Player data is stored in **H2** by default (a single local database file — zero setup). For networks, switch to **MySQL** in [`config.yml`](/p/edpets/getting-started/main-configuration.md). Data is loaded during the async pre-login phase and saved asynchronously on quit plus on a configurable autosave interval.