Getting Started
Welcome to HyCitizens! This section will get you from a fresh installation to having your first citizen up and running in your Hytale world.
Recommended Path
Install the mod → restart your server once → open the in-game Citizens UI → create your first citizen. That's it!
What is HyCitizens?
HyCitizens is a Hytale server mod that lets you create and manage NPC citizens in your world. Citizens are fully customizable — you can give them names, skins, animations, patrol routes, messages, commands, combat behaviors, death drops, and much more, all without touching any code.
Key Concepts
- Citizen: An NPC entity spawned in your world. Each citizen has its own config stored in
mods/HyCitizensData/. - Role: The underlying NPC role generated for each citizen. Roles are auto-generated and stored in
mods/HyCitizensRoles/. - Interaction: What happens when a player presses F (Use) or left-clicks on a citizen. Can trigger messages and/or commands.
- Behavior: How a citizen moves and acts — idle, wander, or following a patrol path.
Topics in This Section
- Installation: Download, install, and complete the one-time first-run setup.
First Time?
The very first time you install HyCitizens, the server will automatically shut down once to generate required asset pack files. This is completely normal — just restart the server and everything will be ready.
The very first time you install HyCitizens, the server will automatically shut down once to generate required asset pack files. This is completely normal — just restart the server and everything will be ready.