# MyPet Wiki

## Home

- [MyPet Wiki](https://wiki.mypet-plugin.com/readme.md): Your one-stop shop for all things MyPet

## Player Guide

- [Overview](https://wiki.mypet-plugin.com/player-guide/getting-started/readme.md): Learn the basics of MyPet
- [Overview](https://wiki.mypet-plugin.com/player-guide/commands/overview.md): Start here. Jump to player or admin commands.
- [Player Commands](https://wiki.mypet-plugin.com/player-guide/commands/player-commands.md): Player-facing commands and examples.
- [Admin Commands](https://wiki.mypet-plugin.com/player-guide/commands/admin-commands.md): Administrative commands and examples.

## Setup Guide

- [Supported Versions](https://wiki.mypet-plugin.com/setup-guide/getting-started/readme.md): A guide to which server softwares and Minecraft versions are supported
- [Quickstart](https://wiki.mypet-plugin.com/setup-guide/getting-started/readme-1.md): Quickly set up MyPet with default settings.
- [What's New in MyPet 4](https://wiki.mypet-plugin.com/setup-guide/getting-started/whats-new-in-4.0.md)
- [Updating from MyPet 3 to 4](https://wiki.mypet-plugin.com/setup-guide/getting-started/updating-from-3-to-4.md): What happens when you upgrade a MyPet 3.x server to 4.0, and what to check before you do.
- [FAQ](https://wiki.mypet-plugin.com/setup-guide/getting-started/faq.md): Frequently asked questions about MyPet 4, collected from the MyPet Discord.
- [Commands](https://wiki.mypet-plugin.com/setup-guide/getting-started/commands.md)
- [Admin Commands](https://wiki.mypet-plugin.com/setup-guide/getting-started/commands/pet-admin.md)
- [Permissions](https://wiki.mypet-plugin.com/setup-guide/getting-started/permissions.md): Every MyPet permission node, what it grants, and its default.
- [Configuration](https://wiki.mypet-plugin.com/setup-guide/getting-started/configuration.md): Guide to the various configuration files in MyPet.
- [config.yml](https://wiki.mypet-plugin.com/setup-guide/getting-started/configuration/config.yml.md): MyPet's main config file.
- [pet-config.yml](https://wiki.mypet-plugin.com/setup-guide/getting-started/configuration/pet-config.yml.md): Contains options for pet types.
- [Default Pet Settings](https://wiki.mypet-plugin.com/setup-guide/getting-started/configuration/pet-config.yml/default-pet-settings.md)
- [pet-shops.yml](https://wiki.mypet-plugin.com/setup-guide/getting-started/configuration/pet-shops.yml.md): Contains options for pet shops.
- [hooks-config.yml](https://wiki.mypet-plugin.com/setup-guide/getting-started/configuration/hooks-config.yml.md): Contains options for plugin hooks.
- [exp-config.yml](https://wiki.mypet-plugin.com/setup-guide/getting-started/configuration/exp-config.yml.md): Contains options for how experience is gained.
- [worldgroups.yml](https://wiki.mypet-plugin.com/setup-guide/getting-started/configuration/worldgroups.yml.md)
- [Custom-Item-Data in Config](https://wiki.mypet-plugin.com/setup-guide/getting-started/configuration/custom-item-data-in-config.md)
- [Systems](https://wiki.mypet-plugin.com/setup-guide/getting-started/systems.md)
- [Translation](https://wiki.mypet-plugin.com/setup-guide/getting-started/systems/translation.md)
- [Leash Flags / Requirements](https://wiki.mypet-plugin.com/setup-guide/getting-started/systems/leash-flags-requirements.md): Leash Flags are the requirements that a mob needs to meet in order to become a pet.
- [Skilltrees](https://wiki.mypet-plugin.com/setup-guide/getting-started/systems/skilltrees.md): Skilltrees are the way to specify when which pet will unlock/upgrade which abilities.
- [Experience](https://wiki.mypet-plugin.com/setup-guide/getting-started/systems/experience.md)
- [Pet Storage](https://wiki.mypet-plugin.com/setup-guide/getting-started/systems/pet-storage.md): The MyPet storage is way to have more than one MyPet.
- [Hunger-System](https://wiki.mypet-plugin.com/setup-guide/getting-started/systems/hunger-system.md)
- [World Groups](https://wiki.mypet-plugin.com/setup-guide/getting-started/systems/world-groups.md)
- [Custom Pet Models](https://wiki.mypet-plugin.com/setup-guide/getting-started/systems/custom-pet-models.md): Give your pets custom BlockBench models using ModelEngine, BetterModel, or ItemsAdder.
- [Bundled Models — Capybara & Chameleon](https://wiki.mypet-plugin.com/setup-guide/getting-started/systems/custom-pet-models/bundled-pet-models.md): How to add the Capybara and the Chameleon — the two custom-model creatures that ship inside the MyPet jar.
- [Auto Updater](https://wiki.mypet-plugin.com/setup-guide/getting-started/systems/auto-updater.md): This page describes the automatic plugin updater functionality and what you need to know to use it.
- [Plugin Hooks](https://wiki.mypet-plugin.com/setup-guide/getting-started/plugin-hooks.md)
- [Hook Types](https://wiki.mypet-plugin.com/setup-guide/getting-started/plugin-hooks/hook-types.md)
- [BossShopPro](https://wiki.mypet-plugin.com/setup-guide/getting-started/plugin-hooks/bossshoppro.md)
- [Citizens NPC](https://wiki.mypet-plugin.com/setup-guide/getting-started/plugin-hooks/citizens-npc.md)
- [PlaceholderAPI](https://wiki.mypet-plugin.com/setup-guide/getting-started/plugin-hooks/placeholderapi.md)
- [WG Region Flags](https://wiki.mypet-plugin.com/setup-guide/getting-started/plugin-hooks/wg-region-flags.md): Custom flags for use with WorldGuard regions.
- [Configurator](https://wiki.mypet-plugin.com/setup-guide/configurator/configurator.md): The MyPet Configurator is a web-based editor that connects to your live server and edits its configuration.
- [Opening a Session](https://wiki.mypet-plugin.com/setup-guide/configurator/configurator/opening-a-session.md): How to start a Configurator session and connect it to your server.
- [Saving Changes](https://wiki.mypet-plugin.com/setup-guide/configurator/configurator/saving-changes.md): How the Configurator writes your changes back to the server.
- [Overview](https://wiki.mypet-plugin.com/setup-guide/supported-mobs/overview.md): List of supported pets and the MyPet version where each pet was added.
- [What are Skilltrees?](https://wiki.mypet-plugin.com/setup-guide/skilltree-creation/what-are-skilltrees.md): Skilltrees are the way to specify when which pet will unlock/upgrade specified abilities.
- [Default Skilltrees](https://wiki.mypet-plugin.com/setup-guide/skilltree-creation/default-skilltrees.md): MyPet 4 ships with 124 default skilltrees arranged as a two-tier "Ascension Ladder". They are ordinary skilltree files; customize or replace them freely.
- [Creating Custom Skilltrees](https://wiki.mypet-plugin.com/setup-guide/skilltree-creation/creating-custom-skilltrees.md): MyPet's web-based Configurator makes creating custom Skilltrees easy.
- [Properties](https://wiki.mypet-plugin.com/setup-guide/skilltree-creation/creating-custom-skilltrees/properties.md)
- [Appearance](https://wiki.mypet-plugin.com/setup-guide/skilltree-creation/creating-custom-skilltrees/appearance.md)
- [Eligible Pets](https://wiki.mypet-plugin.com/setup-guide/skilltree-creation/creating-custom-skilltrees/eligible-pets.md)
- [Requirements](https://wiki.mypet-plugin.com/setup-guide/skilltree-creation/creating-custom-skilltrees/requirements.md): Skilltree requirements are used to limit skilltrees to pets that meet certain conditions.
- [Notifications](https://wiki.mypet-plugin.com/setup-guide/skilltree-creation/creating-custom-skilltrees/notifications.md)
- [Skills](https://wiki.mypet-plugin.com/setup-guide/skilltree-creation/creating-custom-skilltrees/skills.md): Skills are the abilities that Pets can gain as they level up.
- [Armor](https://wiki.mypet-plugin.com/setup-guide/skilltree-creation/creating-custom-skilltrees/skills/armor.md): Give your Pet armor to reduce the damage it takes.
- [Backpack](https://wiki.mypet-plugin.com/setup-guide/skilltree-creation/creating-custom-skilltrees/skills/backpack.md): Add a backpack (inventory) to your Pet.
- [Beacon](https://wiki.mypet-plugin.com/setup-guide/skilltree-creation/creating-custom-skilltrees/skills/beacon.md): Turn your Pet into a walking beacon.
- [Behavior](https://wiki.mypet-plugin.com/setup-guide/skilltree-creation/creating-custom-skilltrees/skills/behavior.md): Change the behavior of your Pet.
- [Climb](https://wiki.mypet-plugin.com/setup-guide/skilltree-creation/creating-custom-skilltrees/skills/climb.md): Let a Pet climb walls on its own to take shortcuts.
- [Control](https://wiki.mypet-plugin.com/setup-guide/skilltree-creation/creating-custom-skilltrees/skills/control.md): Directly control your Pet's actions.
- [Damage](https://wiki.mypet-plugin.com/setup-guide/skilltree-creation/creating-custom-skilltrees/skills/damage.md): Increase the damage your Pet deals in attacks.
- [Fire](https://wiki.mypet-plugin.com/setup-guide/skilltree-creation/creating-custom-skilltrees/skills/fire.md): Make your Pet's attacks potentially set fire to their opponent.
- [Gathering](https://wiki.mypet-plugin.com/setup-guide/skilltree-creation/creating-custom-skilltrees/skills/gathering.md): Let your Pet gather resources — mining ore, felling trees, and fishing.
- [Heal](https://wiki.mypet-plugin.com/setup-guide/skilltree-creation/creating-custom-skilltrees/skills/heal.md): Allow your Pet to self-heal.
- [Knockback](https://wiki.mypet-plugin.com/setup-guide/skilltree-creation/creating-custom-skilltrees/skills/knockback.md): Make your Pet's attacks potentially knock back their opponent.
- [Life](https://wiki.mypet-plugin.com/setup-guide/skilltree-creation/creating-custom-skilltrees/skills/life.md): Increase the HP your Pet has.
- [Lightning](https://wiki.mypet-plugin.com/setup-guide/skilltree-creation/creating-custom-skilltrees/skills/lightning.md): Make your Pet's attacks potentially strike lightning upon their opponent.
- [Pickup](https://wiki.mypet-plugin.com/setup-guide/skilltree-creation/creating-custom-skilltrees/skills/pickup.md): Allow your Pet to pick up dropped items.
- [Poison](https://wiki.mypet-plugin.com/setup-guide/skilltree-creation/creating-custom-skilltrees/skills/poison.md): Make your Pet's attacks potentially poison their opponent.
- [Potion](https://wiki.mypet-plugin.com/setup-guide/skilltree-creation/creating-custom-skilltrees/skills/potion.md): Let your Pet throw splash potions — buffs for you, debuffs for your enemies.
- [Ranged](https://wiki.mypet-plugin.com/setup-guide/skilltree-creation/creating-custom-skilltrees/skills/ranged.md): Arm your Pet with the ability to shoot projectiles at an opponent.
- [Ride](https://wiki.mypet-plugin.com/setup-guide/skilltree-creation/creating-custom-skilltrees/skills/ride.md): Train your Pet to be ridden.
- [Shield](https://wiki.mypet-plugin.com/setup-guide/skilltree-creation/creating-custom-skilltrees/skills/shield.md): Train your Pet to shield you from your opponent's attacks.
- [Slow](https://wiki.mypet-plugin.com/setup-guide/skilltree-creation/creating-custom-skilltrees/skills/slow.md): Make your Pet's attacks potentially slow down their opponent.
- [Sniff](https://wiki.mypet-plugin.com/setup-guide/skilltree-creation/creating-custom-skilltrees/skills/sniff.md): Let your Pet sniff out and dig up an item over time.
- [Sprint](https://wiki.mypet-plugin.com/setup-guide/skilltree-creation/creating-custom-skilltrees/skills/sprint.md): Make your Pet sprint towards its next target.
- [Stomp](https://wiki.mypet-plugin.com/setup-guide/skilltree-creation/creating-custom-skilltrees/skills/stomp.md): Train your Pet to stomp to attack nearby targets,.
- [Taunt](https://wiki.mypet-plugin.com/setup-guide/skilltree-creation/creating-custom-skilltrees/skills/taunt.md): Make your Pet pull hostile mobs' aggro off you.
- [Thorns](https://wiki.mypet-plugin.com/setup-guide/skilltree-creation/creating-custom-skilltrees/skills/thorns.md): Make your Pet's attacks potentially reflect back against their opponent.
- [Toolbox](https://wiki.mypet-plugin.com/setup-guide/skilltree-creation/creating-custom-skilltrees/skills/toolbox.md): Open portable workstations from your Pet.
- [Wither](https://wiki.mypet-plugin.com/setup-guide/skilltree-creation/creating-custom-skilltrees/skills/wither.md): Make your Pet's attacks potentially wither their opponent.

## Developer Guide

- [Developer Guide](https://wiki.mypet-plugin.com/developer-guide/readme.md): Build plugins that integrate with MyPet.
- [Events](https://wiki.mypet-plugin.com/developer-guide/events.md): Listen for and modify pet behavior via the MyPet event API.
- [Examples](https://wiki.mypet-plugin.com/developer-guide/examples.md): Copy-paste recipes for common MyPet integrations.
- [Example Plugin](https://wiki.mypet-plugin.com/developer-guide/example-plugin.md): A complete, runnable Bukkit plugin that registers a custom MyPet skill end-to-end.
- [Migrating from v3.x](https://wiki.mypet-plugin.com/developer-guide/migrating-from-v3.md): Migrating plugins from the MyPet 3.x API to the 4.0 API.

## MyPet 3

- [MyPet - Wiki](https://wiki.mypet-plugin.com/mypet-3/readme.md): The official wiki of MyPet!
- [MyPet 3.0](https://wiki.mypet-plugin.com/mypet-3/mypet-3.0.md)
- [Setup](https://wiki.mypet-plugin.com/mypet-3/setup.md)
- [Update to 3.0](https://wiki.mypet-plugin.com/mypet-3/setup/update-to-3.0.md): This page describes what you need to do in order to upgrade to MyPet 3.0
- [Permissions](https://wiki.mypet-plugin.com/mypet-3/setup/permissions.md)
- [Commands](https://wiki.mypet-plugin.com/mypet-3/setup/commands.md)
- [Configurations](https://wiki.mypet-plugin.com/mypet-3/setup/configurations.md)
- [config.yml](https://wiki.mypet-plugin.com/mypet-3/setup/configurations/config.yml.md): Main Configuration
- [pet-config.yml](https://wiki.mypet-plugin.com/mypet-3/setup/configurations/pet-config.yml.md): Pet Configuration
- [pet-shops.yml](https://wiki.mypet-plugin.com/mypet-3/setup/configurations/pet-shops.yml.md): Pet Shop Configuration
- [hooks-config.yml](https://wiki.mypet-plugin.com/mypet-3/setup/configurations/hooks-config.yml.md): Plugin Hook Configuration
- [exp-config.yml](https://wiki.mypet-plugin.com/mypet-3/setup/configurations/exp-config.yml.md): Experience Configuration
- [worldgroups.yml](https://wiki.mypet-plugin.com/mypet-3/setup/configurations/worldgroups.yml.md): World Group Configuration
- [Custom-Item-Data in Config](https://wiki.mypet-plugin.com/mypet-3/setup/configurations/configitems.md)
- [Systems](https://wiki.mypet-plugin.com/mypet-3/systems.md)
- [Translation](https://wiki.mypet-plugin.com/mypet-3/systems/translation.md)
- [Leash Flags / Requirements](https://wiki.mypet-plugin.com/mypet-3/systems/leashflag.md): Leash Flags are the requirements that a mob needs to meet in order to become a pet.
- [Skilltrees](https://wiki.mypet-plugin.com/mypet-3/systems/skilltrees.md): Skilltrees are the way to specify when which pet will unlock/upgrade which abilities.
- [Skilltree Requirements](https://wiki.mypet-plugin.com/mypet-3/systems/skilltrees/skilltree-requirements.md): Skilltree requirements are used to limit skilltrees to pets that meet certain conditions.
- [SkilltreeCreator - Tool](https://wiki.mypet-plugin.com/mypet-3/systems/skilltrees/skilltreecreator.md): The SkilltreeCreator is a tool with which you can create skilltrees for pet quickly, easily and without experience.
- [Experience](https://wiki.mypet-plugin.com/mypet-3/systems/experience.md)
- [Experience-Script](https://wiki.mypet-plugin.com/mypet-3/systems/experience/expjs.md)
- [Pet Storage](https://wiki.mypet-plugin.com/mypet-3/systems/storage.md): The MyPet storage is way to have more than one MyPet.
- [Hunger-System](https://wiki.mypet-plugin.com/mypet-3/systems/hungersystem.md)
- [World Groups](https://wiki.mypet-plugin.com/mypet-3/systems/multiworld.md)
- [Auto Updater](https://wiki.mypet-plugin.com/mypet-3/systems/updater.md): This page describes the automatic plugin updater functionality and what you need to know to use it.
- [Skill Overview](https://wiki.mypet-plugin.com/mypet-3/skills.md)
- [Backpack](https://wiki.mypet-plugin.com/mypet-3/skills/backpack.md)
- [Beacon](https://wiki.mypet-plugin.com/mypet-3/skills/beacon.md)
- [Behavior](https://wiki.mypet-plugin.com/mypet-3/skills/behavior.md)
- [Control](https://wiki.mypet-plugin.com/mypet-3/skills/control.md)
- [Damage](https://wiki.mypet-plugin.com/mypet-3/skills/damage.md)
- [Fire](https://wiki.mypet-plugin.com/mypet-3/skills/fire.md)
- [Heal](https://wiki.mypet-plugin.com/mypet-3/skills/heal.md)
- [Knockback](https://wiki.mypet-plugin.com/mypet-3/skills/knockback.md)
- [Life](https://wiki.mypet-plugin.com/mypet-3/skills/life.md)
- [Lightning](https://wiki.mypet-plugin.com/mypet-3/skills/lightning.md)
- [Pickup](https://wiki.mypet-plugin.com/mypet-3/skills/pickup.md)
- [Poison](https://wiki.mypet-plugin.com/mypet-3/skills/poison.md)
- [Slow](https://wiki.mypet-plugin.com/mypet-3/skills/slow.md)
- [Ranged](https://wiki.mypet-plugin.com/mypet-3/skills/ranged.md)
- [Ride](https://wiki.mypet-plugin.com/mypet-3/skills/ride.md)
- [Shield](https://wiki.mypet-plugin.com/mypet-3/skills/shield.md)
- [Sprint](https://wiki.mypet-plugin.com/mypet-3/skills/sprint.md)
- [Stomp](https://wiki.mypet-plugin.com/mypet-3/skills/stomp.md)
- [Thorns](https://wiki.mypet-plugin.com/mypet-3/skills/thorns.md)
- [Wither](https://wiki.mypet-plugin.com/mypet-3/skills/wither.md)
- [Tutorials](https://wiki.mypet-plugin.com/mypet-3/tutorials.md)
- [How to get a pet](https://wiki.mypet-plugin.com/mypet-3/tutorials/how_to_get_a_mypet.md)
- [File to MySQL](https://wiki.mypet-plugin.com/mypet-3/tutorials/how_to_upgrade_from_file_to_mysql.md)
- [File to MongoDB](https://wiki.mypet-plugin.com/mypet-3/tutorials/how_to_upgrade_from_file_to_mongodb.md)
- [Plugin-Hooks](https://wiki.mypet-plugin.com/mypet-3/hooks.md)
- [Hook Types](https://wiki.mypet-plugin.com/mypet-3/hooks/hook-types.md)
- [Citizens NPC](https://wiki.mypet-plugin.com/mypet-3/hooks/npc.md)
- [WG Region Flags](https://wiki.mypet-plugin.com/mypet-3/hooks/flags.md)
- [PlaceholderAPI](https://wiki.mypet-plugin.com/mypet-3/hooks/placeholder.md)
- [BossShopPro](https://wiki.mypet-plugin.com/mypet-3/hooks/bossshoppro.md)
- [Default Settings](https://wiki.mypet-plugin.com/mypet-3/default-settings.md): The Default settings and values that the plugin is packaged with.
- [Pet-Config](https://wiki.mypet-plugin.com/mypet-3/default-settings/pet-config.md): Default settings for Pets
- [Misc](https://wiki.mypet-plugin.com/mypet-3/misc.md)
- [MyPet-Premium](https://wiki.mypet-plugin.com/mypet-3/misc/premium.md)
- [Is MyPet EULA compliant?](https://wiki.mypet-plugin.com/mypet-3/misc/eula.md)
- [FAQ](https://wiki.mypet-plugin.com/mypet-3/misc/faq.md): Frequently Asked Questions
- [Changelog](https://wiki.mypet-plugin.com/mypet-3/misc/changelog.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
This site has an agentic ask interface you may use to query the documentation dynamically by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://wiki.mypet-plugin.com/index.md?ask=<question>&goal=<user_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.