> For the complete documentation index, see [llms.txt](https://wiki.mypet-plugin.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://wiki.mypet-plugin.com/setup-guide/getting-started/readme-1.md).

# Quickstart

Quickly set up MyPet with default settings.

MyPet works out of the box on most servers. Install it, restart the server, and start capturing Pets.

{% stepper %}
{% step %}

### Confirm your server is compatible

Check [Supported Versions](/setup-guide/getting-started/readme.md) to make sure your Minecraft version is supported. [Paper](https://papermc.io/) is supported.

{% hint style="warning" %}
The MyPet 3.14 series was the **last MyPet version series to support base Spigot server software**. Paper is the superior and most widely used server software, with over 82% of Minecraft Java servers today running Paper or offshoots of Paper. Making the switch is as easy as swapping your server jar. Switch to Paper today: [https://papermc.io](https://papermc.io/)
{% endhint %}
{% endstep %}

{% step %}

### Download MyPet from an official source

There are three official sources:

* [BuiltByBit](https://builtbybit.com/resources/mypet-4.115339/) (**recommended;** stable releases)
* [Discord](https://discord.gg/GtcdWFw) (alpha builds)
* [GitHub](https://github.com/MyPetORG/MyPet/releases) (build it yourself)
  {% endstep %}

{% step %}

### Stop your server

{% endstep %}

{% step %}

### Put the jar in your `plugins/` folder

1. Download the `MyPet-*.jar`.
2. Copy it to `<server root>/plugins/`.

{% hint style="info" %}
It's a good idea to keep the name of the jar file the same, eg. `MyPet-3.14.1.jar`, as this can help you determine whether you are up to date when the server is offline.
{% endhint %}
{% endstep %}

{% step %}

### Start the server once to generate files

On first boot, MyPet will create `plugins/MyPet/`. This is where `config.yml` and other automatically-generated configuration files live.
{% endstep %}

{% step %}

### Verify the install

1. Check the server console for lines that says MyPet is enabled.
2. In-game, run `/plugins`.
3. Confirm you see `MyPet` in the plugin list.

{% hint style="warning" %}
If you don’t see `MyPet`, check the console for errors.
{% endhint %}
{% endstep %}
{% endstepper %}


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://wiki.mypet-plugin.com/setup-guide/getting-started/readme-1.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.