Permissions

Version: 1.12.1

KyuubiSoft Pets uses four permission nodes and checks them with Hytale’s permission system. Command syntax is on the Commands page.

Permission Nodes

Permission	Default	Gates
ks.pet.user.use	allowed	/kspet (aliases pet, pets) with all its subcommands: compendium or pet menu, summon, dismiss, rename, stats, pickup filter, collection, bestiary, combat and mount windows
ks.pet.user.combat	allowed	/kscombatpet (aliases combatpet, cpet), that is /kscombatpet stats
ks.pet.user.mount	allowed	/ksmount (alias mount): summon, dismount, list
ks.pet.admin	not granted	/kspetadmin (alias petadmin) with every subcommand, and through it the admin window

How the defaults work:

• The three ks.pet.user.* nodes are checked as “allowed unless set”. Every player can use the player commands out of the box; to block one, set the node to false for that player or group. A blocked player gets “No permission.”.
• ks.pet.admin is the required permission of the /kspetadmin command. Players without it cannot run it. Give it to staff only.
• /kslang has no permission: every player may choose their language.

What the Nodes Do Not Cover

• Items. Pet eggs, battle runes, mount horns and the scrolls (reroll, refine, reroll all, refine all, Battle Pet Revival Scroll) have no permission check. Whoever holds the item can use it. Control access through who gets the items (loot, shops, /kspetadmin give).
• The compendium. /kspet (gated by ks.pet.user.use) opens the compendium, which can summon combat pets and mounts. ks.pet.user.combat and ks.pet.user.mount only gate the standalone commands /kscombatpet and /ksmount.
• The admin window opens through /kspetadmin or, with KyuubiSoft Core installed, through its tile in the /ksadmin hub. Both need ks.pet.admin; the hub itself needs Core’s ks.admin.
• The KyuubiSoft Panel status page (with KyuubiSoftAPI) uses the panel’s own account permissions, not Hytale permission nodes. See Admin Panel.

To take a whole pet kind away from everyone, switch its module off in config.json (modules.collector, modules.combat, modules.mount, see Configuration) instead of using permissions.

LuckPerms Examples

Staff gets the admin tools

/lp group admin permission set ks.pet.admin true
/lp user Steve permission set ks.pet.admin true

Only VIPs may use /ksmount

/lp group default permission set ks.pet.user.mount false
/lp group vip permission set ks.pet.user.mount true

Players of the default group can still ride a mount from its horn or the compendium; this only blocks the /ksmount command.

Hide /kscombatpet from a group

/lp group guest permission set ks.pet.user.combat false

No pet commands at all for a group

/lp group guest permission set ks.pet.user.use false
/lp group guest permission set ks.pet.user.combat false
/lp group guest permission set ks.pet.user.mount false

Everything default (no setup)

Nothing to do: the player nodes are allowed when they are not set, and ks.pet.admin is only granted where you add it.