Skip to content

Permissions

KyuubiSoft mods use the ks.<mod>.<scope>.<action> permission scheme.

  • User nodes — ks.<mod>.user.<action> — granted by default (absence means “allowed”). Admins only need to touch them to take a command away from a group.
  • Admin nodes — ks.<mod>.admin — not granted by default. Give them to staff groups only.
  • The console node — ks.core.admin.dialog.console — not granted by default, also not to holders of ks.admin. See Console Commands.
  • Dynamic nodes — per-item or per-content permissions you set in config files (NPC interaction permissions, Info Hub sections, …). See Dynamic Permissions.

The server console may run every command.

PermissionModCommand(s)
ks.core.user.settingsCore/kssettings (KS settings window)
ks.itemupdate.user.useCore/ksitemupdate (item update window)
ks.shop.user.useCoreCore NPC shops (/ksnpcshop) while ks.core.shop.user.use is not set
ks.citizen.user.repairCore/kscitizen repair (item repair window)
ks.quest.user.useQuests/ksquest (Questbook)
ks.quest.user.settingsQuests/ksquestsettings
ks.achievements.user.useAchievements/ksachievements
ks.achievements.user.rewardsAchievements/ksrewards
ks.achievements.user.titlesAchievements/kstitles
ks.info.user.useInfo Hub/ksinfo, /ksinfoitem, section and page commands
ks.seasonpass.user.useSeason Pass/ksseasonpass
ks.bank.user.openBank/ksbank open
ks.bank.user.pageBank/ksbank page
ks.bank.user.upgradeBank/ksbank upgrade
ks.bank.user.historyBank/ksbank history
ks.pet.user.usePets/kspet (compendium, summon, dismiss, rename, pickup filter)
ks.pet.user.combatPets/kscombatpet
ks.pet.user.mountPets/ksmount
ks.lootbag.user.useLootbags/kslootbags (catalog)
ks.graveyard.user.useGraveyard/ksgraveyard menu, list, locate
ks.item.user.browseItem Control/ksitem browse (item browser)
ks.item.user.compareItem Control/ksitem compare
ks.item.user.soulboundItem Control/soulbound (inspect your held item)
ks.shop.user.browsePlayer ShopsBrowse player shops
ks.shop.user.createPlayer ShopsCreate your own shop
ks.shop.user.editPlayer ShopsEdit your own shop
ks.shop.user.collectPlayer ShopsCollect sold items and coins
ks.shop.user.deletePlayer ShopsDelete your own shop
ks.shop.user.ratePlayer ShopsRate shops
ks.nameplate.user.useNameplates/ksnameplate
ks.dungeon.user.useDungeons/ksdungeon open, play, leave, party
ks.dungeon.user.map.useDungeons/ksdungeon maps, mapinfo, using dungeon maps
ks.dungeon.user.stone.useDungeonsUsing dungeon stones
ks.claims.user.<action>Claims/ksclaim and each subcommand, one node per action (open, claim, unclaim, info, list, rename, home, sethome, trust, untrust, ban, unban, transfer, accept, delete, buychunks, border, help)
ks.guilds.user.openGuilds/ksguild (guild window; inside it the guild’s rank rights decide)
ks.guilds.user.create, ks.guilds.user.invite, ks.guilds.user.accept, ks.guilds.user.deny, ks.guilds.user.join, ks.guilds.user.request, ks.guilds.user.withdraw, ks.guilds.user.leaveGuilds/ksguild create, invite, accept, deny, join, request, withdraw, leave
ks.guilds.user.kick, ks.guilds.user.promote, ks.guilds.user.demote, ks.guilds.user.transfer, ks.guilds.user.disbandGuilds/ksguild kick, promote, demote, transfer, disband
ks.guilds.user.info, ks.guilds.user.contribute, ks.guilds.user.helpGuilds/ksguild info, contribute, help
ks.guilds.user.lock, ks.guilds.user.unlock, ks.guilds.user.lockinfo, ks.guilds.user.autolockGuilds/ksguild lock, unlock, lockinfo, autolock
ks.guilds.user.home, ks.guilds.user.sethomeGuilds/ksguild home, /ksguild sethome (also the Set here button)
ks.guilds.user.landGuilds/ksguild land add, remove, list (with Claims 2.0)
ks.guilds.user.chatGuilds/gc and the guild chat mode
ks.heirlooms.user.openHeirlooms/ksheirloom (story window)
ks.whisperstone.user.useWhisperstone/kswhisper and using the Whisperstone item
ks.whisperstone.user.messageWhisperstoneRaven rune, writing messages and sharing positions
ks.whisperstone.user.callWhisperstoneFarcall rune, calling and being called
ks.whisperstone.user.mapWhisperstoneStar Map rune and the stone’s world map markers
ks.chat.user.useChatPlus/kschat
ks.chat.user.msgChatPlus/msg, /r, /ksmail, /ignore
ks.chat.user.rpChatPlusRoleplay commands (/me, /do, /ooc, /whisper, /shout)
ks.mastery.user.useWeapon Mastery/ksmastery
ks.showcase.user.useShowcase/ksshowcase

/kslang has no permission check. VoiceHub’s player commands have no permission nodes; every player may use them.

PermissionModCommand
ks.adminCore/ksadmin hub, /ksadmin reload, /ksadmin testsound, the NPC shop editor, “Back to Core” from other mods’ admin windows; also accepted for all NPC tools
ks.admin.cleanupCore/ksadmin cleanup nametags (+ kyuubisoft.admin in game)
ks.admin.migrateCore/ksadmin migrate-storage ... (+ kyuubisoft.admin in game)
ks.admin.xpCore/ksadmin addxp, removexp (+ kyuubisoft.admin in game)
ks.admin.editorCore/kseditor, /kstrusteditor, /ksapplyconfig (+ kyuubisoft.editor in game)
ks.admin.devCore/ksdev (+ dev.admin in game)
ks.citizen.adminCore/kscitizen subcommands, NPC management, skin editor, NPC viewer, dialog editor (ks.admin and the old citizen.admin work too)
ks.core.admin.dialog.consoleCore and othersAnything that runs as the server console, see below
ks.quest.adminQuests/ksquestadmin (alias /qadmin) and the Quests admin window
ks.achievements.adminAchievements/ksachievementadmin (alias /acadmin) and the admin window
ks.info.adminInfo Hub/ksinfoadmin and the admin window (the old infohub.admin still works)
ks.seasonpass.adminSeason Pass/ksseasonpassadmin (alias /spadmin)
ks.bank.adminBank/ksbank admin, give, adminupgrade, reset, log, reload
ks.pet.adminPets/kspetadmin (alias /petadmin) and the admin window
ks.lootbag.adminLootbags/kslootbagsadmin (alias /lbadmin) and the admin panel
ks.graveyard.adminGraveyard/ksgraveyard admin subcommands (admin_list, admin_clear, admin_remove, admin_tp, admin_stats, design_give, design_revoke, particle_give, particle_revoke, reload)
ks.item.adminItem Control/ksitem admin subcommands (together with kyuubisoft.itemcontrol.admin; /ksitem inv with kyuubisoft.itemcontrol.inventory)
ks.item.admin.clearslotItem ControlClear, Clear slot and /ksitem inv clear. Not part of ks.item.admin, but part of ks.item.admin.*
ks.item.admin.removeallItem Control/ksitem inv wipe and Remove item from everyone. Not part of ks.item.admin, but part of ks.item.admin.*
ks.item.giveItem Control/ksitem give (together with kyuubisoft.itemcontrol.give), and Give Item in the Item Browser with the admin-give module
ks.shop.adminPlayer Shops/ksshopadmin (alias /kssa) and the Shop Admin window (ks.admin alone is not enough)
ks.rental.rent, ks.rental.bidPlayer ShopsRent shops, bid on rentals
ks.shop.list.free, ks.shop.list.permanentPlayer ShopsListing perks
ks.nameplate.adminNameplates/ksnameplate admin (together with kyuubisoft.nameplates.admin, configurable)
ks.dungeons.adminDungeons/ksdungeon givemap, givestone, testmap, browseprefabs
kyuubisoft.voicehub.adminVoiceHub/ksvoice admin, /ksvoice proximity (node name configurable)
ks.claims.adminClaims/ksclaimadmin and every subcommand, the admin window, the Claims tile in the /ksadmin hub
ks.claims.admin.bypassClaimsIgnores the protection of every claim and server zone
ks.guilds.adminGuilds/ksguild admin, the admin window and its /ksadmin tile; change, remove and break any lock (does not open locks)
ks.guilds.admin.bypassGuildsOpen, use and break every locked chest, door and gate
ks.heirlooms.adminHeirlooms/ksheirloom admin, test, check, clear, wear, reload and the admin window
ks.whisperstone.adminWhisperstone/kswhisper give, reload, demo, demo ring
ks.chat.adminChatPlus/kschatadmin
ks.mastery.adminWeapon Mastery/ksmasteryadmin
ks.mobcontrol.adminMob Control/ksmobcontrol
ks.oreregen.adminOre Regeneration/ksoreregen
ks.showcase.adminShowcase/ksshowcase savepack

The /ksadmin hub needs ks.admin. Most mod tiles in it also check that mod’s own admin node (for example ks.pet.admin, ks.bank.admin, ks.lootbag.admin, ks.shop.admin).

ks.core.admin.dialog.console protects everything that runs a command as the server console. Admins without it can still see these commands and edit everything else; existing console commands keep running. Grant it only to people you would also give console access.

ModWhat needs the node (on top of the mod’s admin node)
CoreNPC commands run as console (interact, death, proximity), dialog commands run as console, NPC shop entries run as console and the permissions that guard them, web editor imports that touch any of these
QuestsConsole commands in quest rewards and NPC profiles
AchievementsConsole command rewards
Info HubQuick tiles with runAsConsole
Season PassCommand rewards in tiers, the shop and prestige levels
Item ControlCommand blocks that run as the console

See each mod’s permission page for the details.

These are not hardcoded; server operators set them per item, NPC or section in config files.

PatternModUsed in
ks.core.shop.user.useCore shopsAccess to all Core NPC shops; decides when set (granted or denied)
shop / entry permissionCore shopsPer-shop or per-item purchase gate (optional)
citizen.interact.<custom>Core citizensPer-NPC interaction gate (optional, any string)
infohub.bypass.commandfilterInfo HubBypass the command browser filter (configurable)
section and category permissionsInfo HubPer-section and per-category access gates (any string)
ks.claims.chunks.<n>, ks.claims.claims.<n> (and .unlimited)ClaimsQuota tiers; the tested values come from quota.chunkTiers / quota.claimTiers in config.json

These nodes don’t have to follow the ks.* scheme because you write them yourself. Admins can name them whatever they like (shop.vip, citizen.interact.blacksmith, …); the mod passes them to the permission check as they are.

Each mod has its own permission page with the complete command table and showcase/console notes:

Earlier releases used a mixed scheme (questbook.admin, bank.admin, pets.admin, kyuubisoft.admin, citizen.admin, …). Most of these were replaced by the ks.* nodes above, but a few are still checked in addition, or still accepted:

Older nodeStatus
kyuubisoft.adminStill checked in game for /ksadmin cleanup, migrate-storage, addxp, removexp. No longer needed for /ksadmin and /ksadmin reload.
ks.admin.reloadNo longer used; /ksadmin reload needs ks.admin.
kyuubisoft.editorStill checked in game for the web editor commands.
dev.adminStill checked in game for /ksdev.
citizen.adminStill accepted instead of ks.citizen.admin.
infohub.adminStill accepted instead of ks.info.admin.
kyuubisoft.itemcontrol.*Still checked together with the ks.item.* admin nodes.
kyuubisoft.nameplates.adminStill checked together with ks.nameplate.admin (configurable).
ks.claim.user.use, ks.claim.admin, ksclaim.adminNo longer checked since Claims 2.0.0; use the ks.claims.* nodes.