Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/ElectroGamesDev/HyCitizens/llms.txt

Use this file to discover all available pages before exploring further.

HyCitizens registers a small set of in-game commands that provide quick access to the Citizens management UI and server-side utilities. All commands require the hycitizens.admin permission and are available to any player who holds that permission node on your server.

Command Reference

CommandAliasesPermissionDescription
/citizens/citizen, /hycitizens, /hycitizenhycitizens.adminOpens the Citizens management UI on the Manage tab.
/citizens respawnallrespawn-all, respawn_allhycitizens.adminForce-respawns all Citizens on the server and responds with the count of respawned Citizens.

/citizens

Running /citizens (or any of its aliases) opens the Citizens Manager UI directly on the Manage tab. From there you can search, edit, clone, remove, and teleport to Citizens, as well as manage groups and access all configuration panels.

/citizens respawnall

Running /citizens respawnall despawns and re-spawns every Citizen registered on the server. The command responds with a green confirmation message showing how many Citizens were respawned, for example:
Respawned 12 citizens.
This is useful after making bulk changes outside the UI, or to recover from a situation where some NPCs have gone missing.

Permissions

Permission NodeDescription
hycitizens.adminRequired for all HyCitizens management commands and for opening the in-game management UI. Also required to receive the Citizen Stick item.
Permissions must be granted through your server’s permission system (for example, LuckPerms or a similar Hytale-compatible permission manager). HyCitizens does not manage permissions itself — it only checks whether the executing player holds the required node.

Troubleshooting

If /citizens returns an “unknown command” error, verify the following:
  1. The HyCitizens JAR file is placed in your server’s mods/ directory.
  2. The HyUI dependency mod is also present in mods/ — HyCitizens requires it to render the management UI.
  3. The server was fully restarted after adding the mod files (a reload is not sufficient).
  4. No errors related to HyCitizens appear in the server console on startup.
If the command runs but returns a permission error, ensure the following:
  1. Your player account has been granted the hycitizens.admin permission node through your server’s permission system.
  2. If you are using a permission plugin, confirm the node is applied to the correct player or group and that the permission system is active.
  3. Operator status alone may not grant hycitizens.admin depending on your server configuration — add the node explicitly if in doubt.

Build docs developers (and LLMs) love