Pet System
KyuubiSoft Companions — a complete 3-module pet system for Hytale servers featuring pickup pets with auto-collect, combat pets with AI targeting, and rideable mounts with full multiplayer sync.
Modules
The pet system consists of three independently toggleable modules (all enabled by default):
Pickup Pets
- 26 NPC Companions that follow the player and auto-collect dropped items
- Leveling System with XP from kills, mining, crafting, and item pickup
- Stat Buffs based on pet rarity and rolled stats (Speed, Luck, Mining, Combat, etc.)
- Pickup Filter with whitelist/blacklist mode, presets, and custom rules
- Pet Eggs — tradeable items that spawn pets with stored metadata
Combat Pets
- 13 Battle Companions that fight alongside the player
- Damage System based on pet level and combat stats
- Expanded Stat Pool: damage_bonus, crit_chance, max_health, life_steal, armor_bonus
- XP from Kills — pets level up by killing mobs
- Battle Scrolls — Battle_Reroll_Scroll and Battle_Refine_Scroll for rerolling and refining combat pet stats
Mounts
- 9 Rideable NPC Mounts with native position sync for all players
- Walk and Fly Roles with configurable speed and Y-offset
- Mount Horn Items — tradeable summoning items
- Animation Sync — other players see walk/run/idle animations
- Auto-Dismount on death and disconnect
UI Pages
| Page | Access | Description |
|---|---|---|
| Pet Menu | /kspet | Main menu -- summon, dismiss, view all pets, HUD settings |
| Collection | /kspet collection | Overview of all owned pets with rarity |
| Bestiary | /kspet bestiary | All pet types with discovery tracking |
| Filter | /kspet filter | Configure pickup filter rules |
| Combat | /kspet combat | Combat pet stats (damage, DPS, kills) |
| Mounts | /kspet mount | Mount selection and management |
| Reroll | Right-click Reroll Scroll | Re-roll individual stat type + value |
| Refine | Right-click Refine Scroll | Re-roll individual stat value (keep type) |
| Reroll All | Right-click Reroll All Scroll | Preview + confirm full stat reroll |
| Refine All | Right-click Refine All Scroll | Preview + confirm full stat refine |
| Language | /kslang | Select display language (9 languages) |
| Pet Creator | /kspetadmin creator | Admin-only: build custom pets with precise control |
All pages feature pagination when content exceeds the visible area. See the UI Pages documentation for details on each page.
Guides
- Custom Pets Guide — Add your own pickup pets, combat companions, and mounts using JSON templates. No code required.
- Admin Panel & Pet Creator — Full admin command reference and the in-game Pet Creator UI.
- UI Pages — Documentation for all player-facing and admin UI pages.
- API & Events — Public events for integration with other mods.
- FAQ & Troubleshooting — Common questions and solutions.
Quick Reference
| Feature | Details |
|---|---|
| Plugin Name | KyuubiSoft Companions |
| Version | 1.3.0 |
| Plugin JAR | KyuubiSoftPets.jar |
| Dependency | None required. Optional: KyuubiSoft Core (SmartConfigManager), DynamicTooltipsLib (tooltips) |
| Commands | /kspet, /kspetadmin, /kscombatpet, /ksmount, /kslang |
| Config | plugins/Pets/config.json |
| Pet Types | plugins/Pets/pet-types/{collector,combat,mount}/*.json |
| Player Data | plugins/Pets/data/players/{uuid}.json |
| Localization | plugins/Pets/i18n/{locale}.json (9 languages) |
| Pet Counts | 26 Pickup, 13 Combat, 9 Mounts |
Requirements
- Hytale Server (Update 3+)
- Java 25+
- Optional: KyuubiSoft Core (for SmartConfigManager merge-based config loading)
- Optional: DynamicTooltipsLib (for enhanced item tooltip details)