Commands

Version: 1.12.1

KyuubiSoft Pets registers five commands. Subcommand words are not case-sensitive.

Command	Aliases	Used by	Permission	Registered
/kspet	pet, pets	players	ks.pet.user.use	always
/kscombatpet	combatpet, cpet	players	ks.pet.user.combat	only when modules.combat is true at server start
/ksmount	mount	players	ks.pet.user.mount	only when modules.mount is true at server start
/kspetadmin	petadmin	players and console	ks.pet.admin	always
/kslang	none	players	none	by the first KyuubiSoft mod that loads (Pets ships its own copy)

The three player commands answer “This command is for players only.” when they are run from the console. Details on the permission nodes are on the Permissions page; the windows the commands open are described on UI Pages.

---

/kspet

Usage	What it does
/kspet	Opens the Pet Compendium (or the classic pet menu when ui.compendium is false)
/kspet summon <type>	Summons one of your collector pets by pet type ID
/kspet dismiss	Sends your summoned collector pet home
/kspet rename <name>	Renames your summoned combat pet
/kspet stats	Shows your summoned collector pet’s level, XP, items and buffs in chat
/kspet filter	Opens the pickup filter window
/kspet filter mode <whitelist|blacklist>	Sets the filter mode
/kspet filter add <type> <value>	Adds a filter rule
/kspet filter remove <index>	Removes a filter rule
/kspet filter clear	Removes all filter rules
/kspet filter preset <no_junk|valuables|ores_only|pick_all>	Replaces the rules with a preset
/kspet collection	Opens the pet collection window
/kspet bestiary	Opens the bestiary window
/kspet combat	Opens the combat pet window with your summoned combat pet (refused while the combat module is off)
/kspet mount or /kspet mounts	Opens the mount window with the mounts you own (refused while the mount module is off)

Any other word after /kspet prints the command list.

/kspet without arguments

Opens the Pet Compendium with the live 3D preview. With ui.compendium set to false in config.json it opens the classic pet menu instead (see Configuration).

/kspet summon <type>

Summons a collector pet by its pet type ID (the file name of the pet type, for example duck or dragon_frost).

• Only one collector pet can be out at a time. If one is already summoned you get a message; dismiss it first.
• The pet’s egg must be in your hotbar, storage or backpack. If you own several pets of that type, the first matching egg found (hotbar first) decides which one is summoned. The compendium lets you pick a specific copy.
• An old copy of an egg that an admin has replaced with /kspetadmin restore does not count.

/kspet summon duck

Combat pets are summoned with their battle rune or from the compendium, mounts with their horn, the compendium, /ksmount summon or the mount window (/kspet mount).

/kspet combat and /kspet mount

• /kspet combat opens the combat pet window for the combat pet you have summoned: its name, level, XP, damage, DPS, ranges and kills. See UI Pages.
• /kspet mount opens the mount window. It lists only the mounts you own, the one you rode last first. Clicking a mount summons exactly the one shown in that slot; like /ksmount summon and the compendium, it needs that mount’s horn in your hotbar, storage or backpack (“You need the pet item in your inventory to summon.” otherwise).

/kspet rename <name>

Renames the combat pet you have summoned. Spaces are allowed; names longer than 24 characters are cut to 24. Without a summoned combat pet the command answers “Only combat pets can be renamed.”

/kspet rename Fang the Brave

The compendium can rename any pet copy, summoned or not.

/kspet filter

Works on your summoned collector pet; if none is summoned, on your first collector pet. Without any collector pet the command tells you so. /kspet filter alone opens the pickup filter window; the words below change the same pet’s filter directly. How the filter decides is explained on Collector Pets.

Rule types for /kspet filter add <type> <value> (the value is one word, upper and lower case do not matter):

Type	Matches when	Example
name	the item ID contains the value; with * in the value the whole ID must match the pattern	/kspet filter add name Dirt
prefix	the item ID starts with the value	/kspet filter add prefix Ore_
category	the item ID starts with the value or contains _ + value	/kspet filter add category Food
property	the item has that property: weapon, armor, tool, consumable, block, glider, utility, ore, resource	/kspet filter add property weapon
quality	the item’s quality index is at least the number	/kspet filter add quality 3

Any other type word works like name.

/kspet filter remove <index> counts from 0: 0 is the first rule. An index that does not exist does nothing.

Presets (each one replaces all current rules):

Preset	Mode	Rules
no_junk	blacklist	Dirt, Sand, Stone, Gravel, Cobblestone, Mud
valuables	whitelist	weapons, armor, tools, consumables, IDs starting with Ore_
ores_only	whitelist	IDs starting with Ore_
pick_all	blacklist	no rules: the pet collects everything

/kspet filter mode whitelist
/kspet filter add prefix Ore_
/kspet filter remove 0
/kspet filter preset no_junk

---

/kscombatpet

Only registered when the combat module is on at server start.

Usage	What it does
/kscombatpet stats	Stats of your summoned combat pet in chat
/kscombatpet	Prints the command list

stats shows the pet’s name and level, damage per hit (including its Damage stat) and damage per second, attack range and aggro range, kill count and, when combat pet health is switched on (combatBalance.mortality.enabled), its current HP. Without a summoned combat pet it lists your defeated pets that are still recovering, with the time left. See Combat Pets.

---

/ksmount

Only registered when the mount module is on at server start.

Usage	What it does
/ksmount summon <type>	Spawns one of your mounts and puts you on it
/ksmount dismount	Gets you off your mount and removes it
/ksmount list	Lists every mount type: id - name [walk|fly|swim]
/ksmount	Prints the command list

summon needs a mount type ID (for example horse_mount), the mount’s horn in your hotbar, storage or backpack, and you must not be riding already. While riding you can also get off with the game’s dismount key (F). See Mounts.

/ksmount summon horse_mount

---

/kspetadmin

Requires ks.pet.admin. Without arguments, a player gets the admin window on its “Create pet” section; the console gets the command list. All replies are in the admin’s language (the console gets the server’s default language); command words, pet type IDs and instance IDs stay the same in every language.

Usage	Console	What it does
/kspetadmin	help only	Opens the admin window
/kspetadmin help	yes	Prints the command list
/kspetadmin creator or create	no	Admin window, section “Create pet”
/kspetadmin lootluck	no	Admin window, section “Blacklist”
/kspetadmin players	no	Admin window, section “Player pets”
/kspetadmin give <player> <type>	yes	Creates a new pet and gives its egg / rune / horn
/kspetadmin remove <player> <type | id>	yes	Deletes a pet for good; every copy of its item becomes void
/kspetadmin setlevel <player> <type | id> <level>	yes	Sets a pet’s level
/kspetadmin addxp <player> <type | id> <amount>	yes	Gives a pet XP
/kspetadmin reroll [<player> <type | id> | combat | collector | mount]	full form only	Rolls all stats again
/kspetadmin maxout [<player> <type | id> | combat | collector | mount]	full form only	Max level and every stat slot filled
/kspetadmin revive <player>	yes	Ends the recovery of all defeated combat pets of a player
/kspetadmin restore <player> [type | id]	yes	Lists pets with a lost item, or replaces the lost item
/kspetadmin inspect hand	no	Pet data of the item in your hand
/kspetadmin inspect <player>	yes	Pet items in a player’s inventory plus their pet records
/kspetadmin list	yes	All loaded pet types
/kspetadmin reload	yes	Reloads the config files, pet types and languages
/kspetadmin cleanup	yes	Removes pet and mount NPCs in the default world
/kspetadmin cleanworld	yes	Removes orphaned pet and mount NPCs in every world
/kspetadmin despawnall	yes	Sends every summoned collector pet home
/kspetadmin dbreload <player>	yes	Reloads one player’s pet data from disk and database
/kspetadmin dbflush	yes	Writes the SQLite journal into pets.db

/kspetadmin help lists every subcommand. The window subcommands and inspect hand answer “Must be a player.” in the console.

Naming the player and the pet

• <player> must be online right now, in any world. The name is not case-sensitive.
• Pet type IDs with several words can be typed with spaces: everything after the player name is joined with _ and lower-cased, so dragon frost means dragon_frost. For setlevel and addxp the last word is the number.
• <type | id> is resolved in this order:
  1. a full instance ID,
  2. the beginning of an instance ID with at least 4 characters, such as the 8-character ID that give prints (several matches: you get the list and need a longer prefix),
  3. a pet type ID: used when the player owns exactly one pet of that type; with several, the command lists their instance IDs so you can pick one.

Instance IDs are shown by give, by /kspetadmin inspect <player> and in the “Player pets” section of the admin window.

give <player> <type>

Creates a new pet of that type and puts its summon item (egg for collector pets, battle rune for combat pets, horn for mounts) into the player’s inventory, hotbar first. The pet gets the type’s display name as nickname, the default pickup filter from config.json and freshly rolled level 1 stats (combat stats only for combat pets). The success message prints the first 8 characters of the new instance ID.

Nothing is created when the type does not exist, the player is not loaded into a world, all of the player’s pet slots are used (maxPetsPerPlayer), the inventory is full or the database is not available; the message says which.

/kspetadmin give Steve duck
/kspetadmin give Steve wolf_combat
/kspetadmin give Steve horse_mount

remove <player> <type | id>

Deletes the pet for good and frees the slot:

1. Every copy of the pet’s item becomes void (its item generation is raised, as with restore). A copy in a chest, on the ground or with another player crumbles when it is used: “This pet was removed by an admin. Its item crumbles to dust.”
2. Every online player who has the pet out sends it home (collector pet, combat pet or mount) and loses the item from their inventory, with the message “An admin removed your pet Fox. Its item is gone.”
3. The pet’s database record is deleted.

The answer is “Removed pet fox from Steve. (95fe1234)”. If the pet database is not available or cannot be written, nothing is removed and the answer says why. A removed pet that is still listed in an old player file is dropped when that player joins.

Danger

remove cannot be undone. The pet, its level and its stats are gone.

/kspetadmin remove Steve 95fe1234

setlevel <player> <type | id> <level>

Sets the level (kept between 1 and the type’s max level) and resets the XP of the current level to 0. Raising the level rolls the stats of every unlock level that was passed. Buffs are re-applied when the pet is out; the item tooltip and the HUD update.

/kspetadmin setlevel Steve duck 25
/kspetadmin setlevel Steve dragon frost 30

addxp <player> <type | id> <amount>

Gives XP to exactly this pet, summoned or not, with normal level-ups. Combat pets roll combat stats on level-ups from this command. Other pets of the player are not touched.

/kspetadmin addxp Steve wolf_combat 5000

reroll and maxout

• reroll clears the pet’s stats and rolls them again for its current level: the level 1 stats plus one for every unlock level it has reached (combat pets only combat stats).
• maxout sets the pet to its max level and rolls every stat slot that is still empty. Stats the pet already has keep their values. The answer says so: “Maxed out Fox → Lv50 (5 stats: every stat slot filled, existing stats kept)”.

Both have a full form and self forms:

Form	Target
/kspetadmin reroll Steve duck	that pet of that player
/kspetadmin reroll	your own summoned pet (collector slot first, otherwise your combat pet)
/kspetadmin reroll combat	your summoned combat pet
/kspetadmin reroll collector (or pickup)	your summoned collector pet
/kspetadmin reroll mount	a mount in your collector slot

The self forms only work for players. For mounts use the full form: a ridden mount does not sit in the slot the mount keyword looks at, so the keyword answers “No active mount pet.”.

revive <player>

Ends the recovery time of every defeated combat pet of the player and says how many were revived. Only relevant when combat pet health is on (combatBalance.mortality.enabled, see Configuration).

restore <player> [type | id]

Replaces a lost egg, battle rune or mount horn. The pet keeps its level, stats and name.

• Without a pet argument it lists the player’s pets whose item is not in their inventory (hotbar, storage, backpack, tool and utility slots). Pets the player gave or traded away are listed too: restoring one voids the item the other player holds now.
• With a type ID it picks the pet of that type whose item is missing; if several are missing, use the instance ID.
• The player must be online and need a free inventory slot. If the pet’s current item is still in their inventory, the restore is refused.
• Every restore raises the pet’s item generation. All older copies of the item (dropped, in a chest, traded away) become void: they crumble with a message when used. Another online player who still has the pet summoned through an old copy sends it home. If the new item cannot be delivered, the old one stays valid.
• Every restore is written to the server log with the admin’s name.

/kspetadmin restore Steve
/kspetadmin restore Steve fox
/kspetadmin restore Steve 95fe1234

inspect hand and inspect <player>

• inspect hand reads the pet item in your hand: instance ID, type, level, XP, total XP, nickname, items collected, kills, combat mode, every stat (current value, base, per level, unlock level), the filter mode and rule count, the item generation and whether the item is stale (replaced by a restore).
• inspect <player> lists every pet item in the player’s hotbar, storage and backpack with the same data, then the player’s pet records: number of pets, active collector and combat pet, and every pet with level and full instance ID.

reload

Reloads config.json, loot_luck_blacklist.json, stat-pool.json, all pet type files and the language files. Which settings still need a restart is listed on Configuration.

list

Prints every loaded pet type as id - display name (rarity, maxLv=N).

cleanup, cleanworld and despawnall

Command	Effect
cleanup	Removes every pet and mount NPC of this plugin in the default world (summoned ones included) and sends the summoned collector pet of every online player home; pets standing in another world are despawned in their own world. Leftovers from earlier sessions may need a manual /kill.
cleanworld	Removes pet and mount NPCs that no player has summoned, in every loaded world. Summoned pets stay.
despawnall	Sends the summoned collector pet of every online player home. Combat pets and mounts are not touched; no data is lost.

dbreload <player> and dbflush

• dbreload <player> (player online): sends the player’s collector and combat pet home, saves pending changes, then reloads the player’s file data/players/<uuid>.json and their pets from pets.db. Use it after editing the database or the player file by hand.
• dbflush merges the SQLite journal (pets.db-wal) into pets.db, so an external sqlite3 session sees the current state.

---

/kslang

The KyuubiSoft language command. The first KyuubiSoft mod that loads registers it; Pets brings its own copy, so it also exists on a server with only Pets.

Usage	What it does
/kslang <code>	Sets your language, for example /kslang de-DE (also accepted without the hyphen: /kslang dede)
/kslang auto (or reset)	Removes your choice; the client language is used again
/kslang	Answers in chat: your current language (chosen by you or taken from your game), the available language codes and how to change it

Codes: en-US, de-DE, fr-FR, es-ES, pt-BR, it-IT, pl-PL, tr-TR, ru-RU. An unknown code prints the available ones. The choice is stored in mods/kslang/prefs.json and shared by all KyuubiSoft mods.

More on languages: Localization.