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.

Installing HyCitizens takes only a few minutes. The plugin ships as a single self-contained JAR — HyUI is bundled inside it, so there are no separate dependencies to install. Once the JAR is in your mods/ folder, HyCitizens automatically creates its data directory on first run and is ready to use.

​
Installation Steps

1

Install HyCitizens

Download the latest HyCitizens JAR from CurseForge and place it in your server’s mods/ directory.
mods/
└── HyCitizens-<version>.jar
HyCitizens is compiled with Java 25 targeting the Hytale Server SDK (>=0.5.0-pre.9 <0.6.0). Ensure your server runtime matches this version range.
2

Start your server

Start your Hytale server. On first run, HyCitizens automatically creates the mods/HyCitizensData/ directory, which is where all Citizen data will be stored and persisted across restarts.
mods/
├── HyCitizens-<version>.jar
└── HyCitizensData/
    └── data.json
3

Grant admin permission

Grant the hycitizens.admin permission to any operator or role that should be allowed to manage Citizens. This permission is required to open the Citizens UI and run management commands such as /citizens and /citizens respawnall.Without this permission, players will not be able to access the management UI.

​
Verify the Installation

Once the server has started, join as a player with the hycitizens.admin permission and run: 
/citizens
The Citizens management UI should open immediately. If the UI does not open, check your server console for errors. You can also use the command aliases /citizen, /hycitizens, or /hycitizen — all open the same management UI.

Build docs developers (and LLMs) love

Get started for freeTalk to us