Commands
Commands
Section titled “Commands”All citizen management commands use the /kscitizen prefix. The alias /npc can be used as a shorthand.
:::warning Permissions
All commands require the citizen.admin permission. Regular players cannot use any of these commands.
:::
Command Reference
Section titled “Command Reference”/kscitizen list [group]
Section titled “/kscitizen list [group]”Lists all registered citizens with their spawn status.
/kscitizen list/kscitizen list quest_npcsOutput:
=== Citizens (18) ===● oasis_healer [quest_npcs] (-21, 0, 3)● desert_scout [quest_npcs] (-65, -10, 4)○ example_npc (0, 65, 0)- Green dot = currently spawned
- Red dot = not spawned (different world or hidden)
- Optional
groupparameter filters by the citizen’sgroupfield.
/kscitizen create <id>
Section titled “/kscitizen create <id>”Creates a new citizen at your current position.
/kscitizen create town_guardThe new citizen is created with these defaults:
- Player model (
isPlayerModel: true) - Your current position and world
- Your facing direction (rotY)
- Passive attitude, idle movement
- Scale 1.0
The NPC spawns immediately after creation. Edit the JSON to customize appearance and behavior, then reload.
/kscitizen remove <id>
Section titled “/kscitizen remove <id>”Permanently removes a citizen from the configuration and despawns its entity.
/kscitizen remove town_guard/kscitizen tp <id>
Section titled “/kscitizen tp <id>”Teleports you to the citizen’s configured position.
/kscitizen tp oasis_healerThis teleports you to the NPC’s spawn coordinates, regardless of whether the NPC is currently spawned. Useful for finding NPCs in large worlds.
/kscitizen respawn <id>
Section titled “/kscitizen respawn <id>”Despawns and re-spawns a specific citizen.
/kscitizen respawn desert_scoutUse this after making changes that require a fresh spawn, such as:
- Changing the skin
- Modifying equipment
- Adjusting scale
- Fixing position issues
/kscitizen reload
Section titled “/kscitizen reload”Reloads the entire citizen configuration from disk.
/kscitizen reloadThis:
- Despawns all citizens.
- Re-reads
citizens.jsonandcustom/custom_citizens.json. - Prefetches any missing skins.
- Citizens are respawned when a player is in the appropriate world.
Output:
Citizens config reloaded! (18 citizens)/kscitizen info <id>
Section titled “/kscitizen info <id>”Displays detailed information about a specific citizen.
/kscitizen info oasis_healerOutput:
=== Citizen: oasis_healer ===Name: ZaraGroup: noneWorld: Forgotten_TemplePosition: -21.3, 0.0, 3.0Model: Player (Darkelf)Role: Citizen_Interactable_RoleMovement: IDLEStatus: SpawnedShows: name, group, world, position, model type, NPC role, movement type, spawn status, dialog count and shop ID (if configured).
/kscitizen marker <citizenId> [! | ? | off]
Section titled “/kscitizen marker <citizenId> [! | ? | off]”Sets or removes a per-player quest marker above a citizen. This is primarily a testing command.
/kscitizen marker oasis_healer ! # Show quest available marker/kscitizen marker oasis_healer ? # Show quest turn-in marker/kscitizen marker oasis_healer off # Remove marker- The marker is only visible to the player who runs the command.
- Defaults to
!if no marker type is specified. - Must be run by a player (not from the console).
/kscitizen viewer
Section titled “/kscitizen viewer”Opens the NPC Viewer admin page. This page scans all NPCs in loaded chunks and displays them in a categorized list (registered, orphaned, world NPCs). Provides buttons to teleport, summon, despawn, or inspect any NPC entity.
/kscitizen viewerThe NPC Viewer is useful for finding orphaned NPC entities that exist in the world but are no longer linked to a citizen config entry.
/kscitizen respawnall
Section titled “/kscitizen respawnall”Despawns and re-spawns all registered citizens at once.
/kscitizen respawnallThis runs on the default world thread and processes all citizens sequentially. If any individual citizen fails to spawn, an error is shown but the remaining citizens continue to process.
Waypoint Recording Commands
Section titled “Waypoint Recording Commands”These commands allow recording NPC patrol paths by walking through the world. The recorded waypoints define the NPC’s PATH movement route.
/kscitizen wprecord <citizenId>
Section titled “/kscitizen wprecord <citizenId>”Starts waypoint recording mode for a citizen. Opens a HUD overlay showing the recording status.
/kscitizen wprecord town_patrolAfter starting, walk through the world and use the following commands to build the path:
/kscitizen wpadd [seconds]
Section titled “/kscitizen wpadd [seconds]”Adds a waypoint at your current position. Optionally specify a pause time in seconds (0-30) for the NPC to wait at this waypoint.
/kscitizen wpadd # Add waypoint, no pause/kscitizen wpadd 5 # Add waypoint, NPC pauses 5 seconds here/kscitizen wpundo
Section titled “/kscitizen wpundo”Removes the last recorded waypoint.
/kscitizen wpundo/kscitizen wpdone
Section titled “/kscitizen wpdone”Stops recording and saves all waypoints to the citizen config.
/kscitizen wpdoneCommand Aliases
Section titled “Command Aliases”| Full Command | Alias |
|---|---|
/kscitizen | /npc |
Examples:
/npc list/npc create my_npc/npc reloadConsole Usage
Section titled “Console Usage”Most commands can be run from the server console, except:
/kscitizen create— Requires a player (uses the player’s position)./kscitizen tp— Requires a player (teleports the player)./kscitizen marker— Requires a player (per-player visibility)./kscitizen viewer— Requires a player (opens UI page)./kscitizen respawn— Requires a player (needs world context)./kscitizen wprecord/wpadd/wpundo/wpdone— Requires a player (uses player position).