Skip to main content

Permissions

All permission nodes used by the KyuubiSoft Pets mod. Permissions use Hytale's native hasPermission() system.

Permission Nodes​

PermissionDefaultDescription
ks.pet.user.usetrueUse the /kspet command and all player subcommands (summon, dismiss, rename, stats, filter, collection, bestiary)
ks.pet.user.combattrueUse the /kscombatpet command for combat pet management
ks.pet.user.mounttrueUse the /ksmount command for mount summoning and dismounting
ks.pet.adminfalseUse the /kspetadmin command (all admin subcommands)
Default Behavior

All player permissions default to true -- every player can use pets, combat pets, and mounts out of the box. Only the admin permission (ks.pet.admin) must be explicitly granted.

Permission Details​

ks.pet.user.use​

Grants access to the main pet system. Without this permission, the player cannot:

  • Open the Pet Menu (/kspet)
  • Summon or dismiss pickup pets
  • Rename pets
  • View pet stats
  • Configure pickup filters
  • Open the Collection or Bestiary pages
  • Open Combat Pet or Mount pages via /kspet combat and /kspet mount

ks.pet.user.combat​

Grants access to the standalone combat pet command. Without this permission, the player cannot:

  • Use /kscombatpet stats to view combat pet statistics in chat

Note: The /kspet combat subcommand (which opens the combat UI page) is gated by ks.pet.user.use, not this permission.

ks.pet.user.mount​

Grants access to the standalone mount command. Without this permission, the player cannot:

  • Use /ksmount summon <type> to summon mounts via command
  • Use /ksmount dismount to dismount via command
  • Use /ksmount list to list available mounts

Note: The /kspet mount subcommand (which opens the mount selection UI) is gated by ks.pet.user.use, not this permission.

ks.pet.admin​

Grants access to all admin commands. This permission is enforced at the command registration level via requirePermission(). Without it, the /kspetadmin command is completely hidden from the player.

Admin capabilities include:

  • Giving and removing pets from players
  • Setting pet levels and granting XP
  • Rerolling and maxing out pet stats
  • Inspecting pet items and player data
  • Opening the Pet Creator UI
  • Reloading configuration
  • Cleaning up orphaned NPCs
  • Listing all registered pet types

Permission Setup Examples​

Allow all players to use pets (default)​

No configuration needed. All ks.pet.user.* permissions default to true.

Restrict mounts to a specific rank​

Remove the default mount permission and grant it only to premium players:

# Deny mount access by default
ks.pet.user.mount: false

# Grant to premium group
group.premium:
  ks.pet.user.mount: true

Admin-only setup​

# Grant admin permissions to staff
group.admin:
  ks.pet.admin: true

Language Command​

The /kslang command has no permission check -- all players can use it to change their display language. This is by design, as language selection is a personal preference.

Item Interactions​

Pet Eggs, Battle Runes, Mount Horns, and Scroll items (Reroll/Refine) do not have separate permission checks. Any player who possesses the item can right-click it to use it. Access control is managed by controlling who receives the items (via loot tables, shops, or admin commands).