How to Configure Citizens on a Minecraft Server
Create stable NPCs with skins, commands, waypoints, traits, and permissions while keeping click actions safe. This guide covers install order, first startup, LuckPerms permissions, config files, use-case presets, integrations, performance checks, common failures, and admin FAQ.
Audience
Admins building hubs, quest NPCs, shops, tutorials, and server selectors.
Install Jar
Citizens.jar.
Tested Stack
Paper or Purpur 1.20.6 to 1.21.x, Java 21, LuckPerms for permissions, and a staging server before production changes.
What Citizens Does
Citizens should be treated as part of your server architecture, not as a random jar dropped into production. The safe workflow is to define the job the plugin owns, decide which groups can touch it, test the generated files on staging, then move only the reviewed configuration to the live server.
For Citizens, the main job is: Create stable NPCs with skins, commands, waypoints, traits, and permissions while keeping click actions safe. That means every setting should support a concrete player workflow or staff workflow. If a setting does not have an owner, a test, and a rollback path, leave it at the generated default until you have a reason to change it.
The most common failure pattern is configuring the plugin as OP, seeing it work, and assuming players are ready. Operators bypass too much. For every section below, create a temporary non-OP account in the target LuckPerms group and test the exact command or interaction that normal players will use.
Keep a small audit note beside the config. Record the plugin version, the file paths changed, the exact permissions granted, the test account used, the commands verified, and the rollback file or database backup to restore. When another plugin depends on Citizens, repeat the same test after updates because the failing part may be the bridge, provider, world context, or display plugin rather than Citizens itself. Keep the note in your operations runbook.
Installation and First Startup
Back up the server before installing Citizens. At minimum, keep a copy of the existing plugins folder, the world data if the plugin touches worlds or claims, and any database used by related plugins. Upload Citizens.jar. into the plugins folder, then perform a full restart so Bukkit, Paper, or Purpur loads the plugin cleanly.
On first startup, do not edit every generated file immediately. Let the plugin create its folder, read the startup log, then run a small command or player action to prove the plugin is alive. The first goal is a known-good baseline. After that, make one config change at a time.
First startup checklist
- Run /citizens after startup.
- Create one test NPC in a staging area.
- Run /citizens save after editing NPCs.
- Test click commands as a normal player.
LuckPerms Permission Setup
Configure Citizens permissions through groups. A clean setup usually has default, trusted, helper, moderator, admin, and owner groups. Default players get only the commands required for normal gameplay. Staff groups get narrow operational permissions. Owner keeps destructive, economy-changing, rollback, purge, import, or wildcard permissions.
Use this pattern for every permission below. Replace the group and permission with the row you are granting. Run the command from console or as an owner, then test with a non-OP player in that group.
/lp group <group> permission set <permission> true
/lp group <group> permission check <permission>
/lp user <player> parent add <group>citizens.npc.createGrant to admin: Allows creating NPCs.
citizens.npc.commandGrant to admin: Click commands can run sensitive actions.
citizens.npc.skinGrant to builder: Allows trusted builders to style NPCs.
citizens.adminGrant to owner: Broad administrative access.
Command Workflows
Commands are not just a reference list. They are the operational workflows your staff will use under pressure. Write the exact command patterns into your runbook and include which group may run each one. For sensitive commands, test with a preview, a limited radius, a staging world, or a throwaway account before using them live.
/npc create GuideCreate a basic NPC.
/npc skin <player>Apply a player skin.
/npc command add -p warp tutorialRun a player command on click.
/npc lookcloseMake an NPC look at nearby players.
/npc tpMove the selected NPC to your location.
/citizens savePersist NPC and config changes.
/citizens reloadReload supported configuration changes.
Config File Deep Dive
The config files below are the parts of Citizens most likely to matter on a real server. Do not copy a random full config from another network. Generated files change between plugin versions, and old examples can silently disable modern safeguards. Keep the generated comments, change only the setting you understand, then reload or restart using the plugin-specific path.
For every setting, write down the old value, the new value, why it changed, and how to back out. This is slower than editing blindly, but it prevents mystery behavior three weeks later when another admin tries to debug the server.
config.yml
plugins/Citizens/config.yml
Controls global NPC behavior and command-related safety settings.
Recommendation: Change one setting at a time and save NPCs before restart.
max-permission-checks
plugins/Citizens/config.yml
Limits permission checks when using NPC limits.
Recommendation: Leave default unless official support points to permission limit issues.
global-delay-seconds
plugins/Citizens/config.yml
Adds a global delay between click commands.
Recommendation: Use a delay to prevent click spam on command NPCs.
saves.yml
plugins/Citizens/saves.yml
Stores NPC definitions, locations, and traits.
Recommendation: Do not hand-edit unless you have a backup and the server is stopped.
Trait configuration
NPC traits
Traits add behavior such as commands, waypoints, equipment, and look close.
Recommendation: Use only the traits needed for each NPC.
Use-Case Configs
A good Citizens setup depends on the type of server. Survival wants stability and player trust. Creative wants build speed and plot safety. Skyblock and economy modes care about item generation and abuse loops. Use these presets as decision checklists, then convert them into exact config changes for your own server.
Server guide NPC
A safe guide opens help, tutorial, or rules commands.
- Create NPC.
- Set skin.
- Add player-run command.
- Add click cooldown.
- Test as default group.
Shop NPC
An NPC can open a shop command or menu plugin.
- Create NPC at shop.
- Add command from player context.
- Check permissions.
- Add signage fallback.
Quest hub
Citizens can provide the visual NPC layer while quest plugins handle logic.
- Create NPCs.
- Install quest plugin.
- Attach quest trait or commands.
- Test reconnect and restart persistence.
Plugin Integrations
Most Minecraft plugin problems happen at the boundary between plugins. Citizens may load correctly while the full workflow still fails because a dependency, bridge, economy provider, permission group, display plugin, or world manager is missing. Check integrations during startup and after every plugin update.
Denizen
Adds scripting and complex NPC behaviors.
LuckPerms
Controls which staff can create NPCs or attach commands.
PlaceholderAPI
Can be used by command or text plugins around NPC workflows.
ProtocolLib
Often appears in NPC stacks for packet-heavy features in related plugins.
Performance and Maintenance
Performance tuning starts with scope. Do not enable every module, world, render, placeholder, command, or log type just because the plugin supports it. Enable the parts that support your server design, measure the impact, and keep a short maintenance checklist for future updates.
- Keep NPC count reasonable in high-traffic hubs.
- Avoid command NPCs that trigger expensive commands on every click.
- Use click cooldowns for public NPCs.
- Save after bulk editing, then restart staging to verify persistence.
Common Errors and Fixes
When Citizens misbehaves, separate facts from guesses. Capture the command used, player group, world, plugin version, and console output. Then work through the smallest reproducible test instead of changing five settings at once.
NPC disappears after restart
- You ran /citizens save.
- saves.yml is writable.
- Console has save errors.
- World name still exists.
Fix: Restore from backup if saves.yml is damaged, then recreate and save on staging.
Click command does nothing
- Command was added to selected NPC.
- Player has permission.
- Command uses player or server context correctly.
- Cooldown is not blocking repeat clicks.
Fix: Use a simple test command first, then add the real command after context is confirmed.
Skin does not update
- Skin username exists.
- Mojang skin services are reachable.
- NPC was saved.
- Client cache is not stale.
Fix: Reapply the skin, save, and reconnect with a test client.
Citizens FAQ
Should I configure Citizens on a live production server?
Use a staging copy for the first setup, then move the finished configuration to production during a quiet period. Citizens may read files, register commands, or touch player data during startup, so testing on a copy prevents avoidable downtime.
Can I use /reload after changing Citizens?
Avoid the global /reload command. Use /citizens reload or /citizens save followed by restart when the plugin supports it, or schedule a normal restart when the change affects dependencies, database settings, worlds, generated regions, or plugin jars.
Where should I keep backups before changing Citizens?
Back up the plugin data folder, the jar you are replacing, and any database tables used by the plugin. Keep the backup outside the live plugins folder so a later cleanup or plugin scan cannot accidentally load it.
How should I grant permissions for Citizens?
Grant permissions to LuckPerms groups, not individual players. Use a small default group, a trusted staff group, and an owner group. Temporary exceptions should use LuckPerms temporary permissions with a clear expiration.
Why does Citizens work for operators but not normal players?
Operators bypass many checks, so OP testing is not enough. Test with a non-OP account in the default group and watch the console for missing permission messages or plugin-specific deny output.
How do I know whether Citizens loaded correctly?
Check the startup log for the plugin name, run the main info command, confirm the data folder was created, and test one normal player workflow. Do not assume the plugin is ready just because it appears in /plugins.
Should I edit generated config files by hand?
Yes, but keep comments, indentation, and encoding intact. YAML and HOCON are strict enough that one bad indent or missing quote can stop a plugin from loading its configuration.
How often should I review Citizens settings?
Review the config after major Minecraft updates, plugin major releases, and changes to your server mode. Survival, skyblock, creative, and proxy networks usually need different defaults.
What is the safest way to update Citizens?
Read the changelog, back up the existing jar and data folder, test the new version on staging, then replace the jar during a normal restart. Do not hot swap core plugins that hold data or hook deeply into server internals.
How do I document the final Citizens setup?
Write down the plugin version, config files changed, permissions granted, commands staff use, and rollback steps. Store that note beside your server runbook so another admin can recover the setup later.
Official References
Check the upstream documentation before changing version-specific settings. This tutorial avoids full copied configs because plugin defaults and generated comments can change between releases.