Welcome
SincePet is a Paper/Folia-ready pet plugin with configurable pet visuals, riding, combat, stat bonuses, pet levels,
upgrade levels, per-pet settings, GUI menus, PlaceholderAPI requirements, MythicLib stat integration, MythicMobs EXP
drops, and WorldGuard region control.
This wiki is written for server owners who want to configure the plugin without reading Java code. Start with
Installation if this is a new setup, or jump straight to GUI and Upgrades if you are customizing menus.
Main Sections
| Page | What it covers |
|---|---|
| Installation | Requirements, first install, updates, and generated files. |
| Commands and Permissions | Player commands, admin commands, and permission nodes. |
| Configuration Reference | config.yml display, follow, riding, database, and combat keys. |
| Pet Configuration | Pet IDs, textures, stats, XP, attacks, and riding. |
| Pet Abilities | MythicMobs triggers, active skills, passive skills. |
| Upgrade System | Upgrade levels, PAPI checks, friendly requirement display, and commands. |
| GUI Configuration | Item meta, pet display values, placeholders, and per-pet/per-upgrade overrides. |
| GUI Reference | Placeholder lists and bundled default mappings for GUI configuration. |
| Pet Experience GUI | Using MMOItems to feed pets for experience points or levels via the Detail GUI. |
| Display Conditions | GUI condition syntax like active_pet, rideable, and permissions. |
| Troubleshooting | Common visual, config, and PlaceholderAPI problems. |
Important Files
| File | Purpose |
|---|---|
config.yml |
Core plugin settings, database, display offsets, riding physics, follow behavior, combat throttle. |
pets.yml + pets/*.yml |
Pet order plus individual pet definitions, textures, stats, attack behavior, riding support, upgrade definitions, and abilities. |
gui.yml |
Every GUI item, GUI item meta, pet display value, upgrade display template, and display condition. |
messages.yml |
Player-facing messages, menu titles, and status labels. |
paper-plugin.yml |
Plugin metadata and dependency declarations. |
Color Formats
Most text supports both legacy color codes and MiniMessage:
name: "&eMonkey King"
name: "<gold><bold>Monkey King"
name: "<gradient:#ff5500:#ffaa00>Ember Core</gradient>"
Prefer MiniMessage for new configuration because it is more readable and supports gradients.
Quick Upgrade Example
This checks whether the player has 20 points, shows a friendly GUI line, and removes 20 points after a successful
upgrade.
requirement:
papi: "%playerpoints_points%"
compare: ">="
value: "20"
display: "You need 20 points"
commands:
- "points take <player> 20"
In gui.yml, use <requirement> to show the friendly line. Use <raw_requirement> only when you intentionally want to
show %playerpoints_points% >= 20.