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

# Configuration

This page has all of the information related to config.yml file.

## 📝 Example configuration:

```yaml
menu:
  # Players with permission "afropets.show.locked" can see all pets
  show_locked: true
  title: "<gradient:#ae00f2:#be5cff:#ae00f2><bold>Select pet"
  menu_rows: 5
  status:
    can_use: "<green>Click to select your pet!"
    no_permission: "<red>You don't have permissions for this pet!"
  pets_per_page: 36
  slots:
    fillers:
      example_filler:
        - "36-44"
    # If you set "despawn', "next_page" or "previous_page" to -1 -> the button will not appear
    despawn: 40
    next_page: 43
    previous_page: 37

# If set to false, only admin can remove pet from player using command:
#   /afropets admin remove <player>
allow_despawn_pets: true

placeholders_defaults:
  no_pet: "---"
  no_description: "No description provided!"

pet_speed: 0.2
# Available pets formats:
# - MODERN - Use display entity
# - LEGACY - Use armorstands
pets_format: "MODERN"

position:
  height_offset: 1.5
  distance_behind: 1.3
  radians: 220

icons:
  # You can add fillers much as you want
  example_filler:
    material: "BLACK_STAINED_GLASS_PANE"
    name: ""
  despawn:
    material: "BARRIER"
    name: " "
    lore:
      - "     <#ff0500>ᴄʟɪᴄᴋ ᴛᴏ ᴅᴇsᴘᴀᴡɴ ᴘᴇᴛ     "
      - " "
  next_page:
    material: "ARROW"
    name: " "
    lore:
      - "     <green>ɴᴇxᴛ ᴘᴀɢᴇ     "
      - " "
  previous_page:
    material: "ARROW"
    name: " "
    lore:
      - "     <red>ᴘʀᴇᴠɪᴏᴜs ᴘᴀɢᴇ     "
      - " "
```

{% hint style="success" %}
Title, status info, item name and lore supports MiniMessage format, more informations [here](https://docs.advntr.dev/minimessage/format.html).
{% endhint %}

{% hint style="danger" %}
pets\_format available value: MODERN / LEGACY
{% endhint %}

{% hint style="warning" %}
Material list can be find on [Spigot JavaDocs](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Material.html)!
{% endhint %}

### 🎨 Custom Model Data and Skull Texture

Syntax:

```yaml
material: "MATERIAL:VALUE"
```

If the `MATERIAL` is set to `PLAYER_HEAD`, the value after the colon will be treated as the head texture. However, in any other case, the value after the colon will indicate the CustomModelData value.

**You can use CustomModelData for all Materials!**