Getting Started

Installation

1. Place KyuubiSoftPets.jar in your server's mods/ folder
2. Start the server once — the plugin creates its data folder
3. Stop the server and configure plugins/Pets/config.json

Folder Structure

plugins/Pets/
  config.json              — Main configuration
  pet-types/
    collector/             — Pickup pet definitions
      wolf.json
      crab.json
      ...
    combat/                — Combat pet definitions
      wolf_combat.json
      boar_combat.json
      ...
    mount/                 — Mount definitions
      horse_mount.json
      rex_cave_mount.json
      ...
  data/
    players/               — Per-player data (auto-generated)
      {uuid}.json
    pet_state.json         — Entity UUID tracking for cleanup
  i18n/
    en-US.json             — English localization
    de-DE.json             — German localization

Module Configuration

All three modules are enabled by default. You can disable individual modules in config.json:

{
  "enabled": true,
  "modules": {
    "collector": true,
    "combat": true,
    "mount": true
  }
}

First Test

1. Give yourself a pet egg: /kspetadmin give <player> wolf
2. Right-click the egg to summon the pet
3. The pet NPC spawns and follows you
4. Open the pet menu: /kspet

Adding New Pet Types

Drop a .json file into the matching subfolder under pet-types/:

{
  "id": "my_pet",
  "displayName": "My Custom Pet",
  "entityTypeId": "Wolf_Black",
  "modelScale": 0.5,
  "maxLevel": 50,
  "baseXpPerLevel": 100,
  "xpScaleFactor": 1.15,
  "eggItemId": "Pet_Egg_MyPet",
  "rarity": "rare",
  "description": "A custom pet companion."
}

The module is auto-detected from the folder name (pickup, combat, mount).

tip

After adding new pet types, restart the server or use /kspetadmin reload to load them.

warning

Pet type files follow the file-first pattern — once extracted to the server, the JAR version is NOT used. Delete the server file to get the updated version from the JAR.