KyuubiSoft Companions v1.5.2

▸ What is KyuubiSoft Companions?

A complete pet system for Hytale servers with three distinct modules: Pickup Pets that follow you and pick up items, Combat Pets that fight alongside you, and Mounts you can ride. Each pet levels up, earns random stats, and can be enhanced with reroll and refine scrolls.

Summon pets with right-clickable egg items, battle runes, or mount horns. Every pet is persistent — stats, level, XP, and nickname are saved per player.

Works standalone — no other plugins required. Optionally integrates with DynamicTooltipsLib for enhanced item tooltips and MultipleHUD for multi-HUD support.



▸ Three Modules

Pickup Pets

• Follow you around the world as cute companions
• Auto-pickup — pets collect nearby dropped items for you
• Configurable pickup filter — blacklist junk, whitelist valuables, or use presets
• Level up by collecting items — higher level = better stat bonuses
• 26 unique pet types across all rarities

Combat Pets

• Fight alongside you against hostile mobs
• Attack when you attack, defend when you're attacked
• Floating damage numbers — see your pet's damage in real-time
• Attack animations — each pet type has unique combat animations
• Combat stats: damage bonus, crit chance, max health, life steal, armor bonus
• 13 unique combat pet types

Mounts

• Rideable mounts with real movement sync
• Configurable speed per mount type
• Health system — mounts can take damage
• Instant summoning — right-click the horn to mount up
• Dismiss by pressing F or dropping the horn item
• 9 unique mount types including Horse, Dragon, Wolf, Sabertooth, and more

▸ Summoning Items

Pet Eggs (Pickup)

• Right-click to summon or dismiss your pickup pet
• Each pet type has its own egg item
• Eggs store the pet's instance data — level, stats, nickname all persist

Battle Runes (Combat)

• Right-click to summon or dismiss your combat companion
• Rune-themed items with rarity-based textures

Mount Horns (Mounts)

• Right-click to summon and instantly mount
• Drop the horn to automatically dismount

Drop protection: If you drop the item that summoned your pet/mount, it is automatically dismissed. No orphaned NPCs.



▸ Leveling & Stats

XP & Leveling

• Pets earn XP from collecting items (Pickup) or killing mobs (combat)
• Configurable XP curve per rarity — scaling formula with base XP and growth factor
• Max level configurable per pet type (default: 50)
• Level-up notification toast + HUD refresh
• Buffs scale with level — higher level = stronger bonuses

Random Stats

• Each pet rolls random stats based on rarity
• Pickup pet stats: pickup radius, XP bonus, damage bonus, stamina regen, max health, and more
• Combat stats: damage bonus, crit chance, max health, life steal, armor bonus
• Stats unlock at specific levels — higher rarity = more stat slots
• Stats apply as real player buffs (health, stamina, damage modifiers)

Scrolls

• Reroll Scroll — completely re-rolls one stat (new type + new value)
• Refine Scroll — re-rolls only the value (keeps the stat type)
• Separate scrolls for pickup pets (Pet_Reroll_Scroll) and combat pets (Battle_Reroll_Scroll)
• Consumed on use — stackable up to 16

▸ HUD & UI

Pet Tracker HUD

• Persistent on-screen HUD showing active pet name, level, XP, buffs, and items collected
• Separate sections for pickup and combat pets (shown side by side or stacked)
• Player-configurable position — 6 presets: Top/Middle/Bottom Left/Right
• Player-configurable layout — Vertical (stacked) or Horizontal (side by side)
• Settings accessible via /kspet menu

Pet Menu

• Open with /kspet — overview of all owned pets
• Active pet info card with level, XP bar, buffs, and stats
• Pet grid showing all owned pets with rarity colors
• Quick-summon buttons per pet slot
• HUD settings (position + layout dropdowns)

Additional Pages

• Collection — browse all owned pets
• Bestiary — encyclopedia of all pet types
• Filter Settings — configure pickup filters (blacklist/whitelist/presets)
• Reroll & Refine Pages — visual stat reroll/refine with scroll consumption
• Combat Pet Stats — detailed combat stats view
• Mount Selection — browse and summon mounts

▸ Pet Types

26 Pickup Pets

• Uncommon: Bunny, Parrot, Frog, Squirrel, Bat, Crab, Duck, Gecko, Meerkat, Hatworm, Cactee, Bluebird, Penguin
• Rare: Fox, Cat, Snow Owl, Wolf, Trork, Archaeopteryx, Skrill Chick, Fen Stalker, Ferab Cub, Lizard Sand
• Epic: Frost Dragon, Yeti
• Legendary: Dragon

13 Combat Pets

• Rare: Wolf, Boar, Bramblekin, Crawler, Crocodile, Lizard, Spider, Scorpion, Hyena, Wolf Outlander
• Epic: Rex Cave, Shadow Knight
• Legendary: Yeti

9 Mounts

• Uncommon: Horse, Camel
• Rare: Wolf, Moose, Bison
• Epic: Rex Cave, Sabertooth
• Legendary: Dragon, Bear Polar

▸ Server Owner Features

Easy Configuration

• All settings in config.json — modules, default filter, XP scaling, teleport distance
• Enable/disable each module independently (pickup, combat, mount)
• Per-pet-type JSON configs — customize stats, speed, damage, rarity per pet
• Auto-generated item templates — add a pet type JSON, server generates the matching item template

Admin Commands

• /kspetadmin give <player> <type> — give a pet (with egg item)
• /kspetadmin remove <player> <type> — remove a pet
• /kspetadmin setlevel <player> <type> <level> — set pet level
• /kspetadmin addxp <player> <type> <amount> — grant XP
• /kspetadmin reload — hot-reload all configs
• /kspetadmin list — list all registered pet types
• /kspetadmin cleanup — remove orphaned pet NPCs
• /kspetadmin cleanworld — clean all worlds
• /kspetadmin despawnall — despawn all active pets

Player Commands

• /kspet — open pet menu
• /kspet summon <type> — summon a pet
• /kspet dismiss — dismiss active pet
• /kspet stats — view pet stats
• /kspet rename <name> — rename your pet
• /kspet filter — manage pickup filter
• /kscombatpet stats — view combat pet stats
• /ksmount summon <type> — summon a mount
• /ksmount dismount — dismount
• /ksmount list — list available mounts

Extensible

• Add custom pets — drop a JSON in pet-types/pickup/, combat/, or mount/
• Server auto-discovers new types on reload
• Item templates auto-generated for missing items
• Custom NPC roles for pet behavior
• Multi-language support (English + German included, easily extendable)

▸ Safety Features

• Drop Guard — dropping a pet's egg/rune/horn auto-dismisses the pet (prevents orphaned NPCs)
• Orphan Cleanup — periodic scan removes stale pet NPCs from previous sessions
• Gamemode Protection — pet follow target refreshes on creative/survival switch
• Disconnect Handling — all pets and mounts properly despawned on disconnect
• Data Backup — player pet data backed up before each save
• Buff Tracking — buffs properly removed on despawn (no stacking exploit)

▸ Technical Details

• Standalone — works without any other plugins
• Optional integrations: DynamicTooltipsLib (tooltips), MultipleHUD (multi-HUD), KyuubiSoft Core (config merge)
• Built on Hytale's ECS system — NPC spawning, behavior roles, entity tracking
• Efficient: pickup scanning throttled to every 5 ticks, orphan cleanup every 60s
• All data stored as JSON in the plugin data folder
• Java 25+ compatible

▸ Requirements

• Hytale Server (Update 3+)
• Java 25+
• No other plugins required