SincePet Wiki

A complete configuration guide for pets, upgrades, GUI items, display conditions, riding, combat, data storage, and integrations.

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.

InstallServer requirements, first start, and updating existing files. ConfigureDisplay offsets, riding physics, database, follow behavior, and combat. Create PetsTextures, stats, XP formulas, attacks, riding, and permissions. Build UpgradesLevel upgrades, PlaceholderAPI checks, friendly requirement text, and commands. Customize GUIEvery item meta field, upgrade item states, placeholders, and per-upgrade overrides. Fix IssuesName offsets, riding visuals, PlaceholderAPI values, and missing config keys.

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.
Upgrade System Upgrade levels, PAPI checks, friendly requirement display, and commands.
GUI Configuration Item meta, upgrade templates, placeholders, and per-upgrade overrides.
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 Pet definitions, textures, stats, attack behavior, riding support, upgrade definitions.
gui.yml Every GUI item, GUI item meta, upgrade display templates, and display conditions.
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.