HyCitizens is a Hytale server plugin that gives you complete control over NPCs — called Citizens — directly in-game. No config files required for day-to-day management: open the Citizens UI, create an NPC, configure its appearance, behavior, and interactions, and it persists automatically across server restarts. For advanced use cases, HyCitizens ships a Java API that lets other plugins listen to NPC events and programmatically control Citizens at runtime.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.
Installation
Download and install HyCitizens on your Hytale server in minutes.
Quickstart
Create your first Citizen and configure interactions step by step.
In-Game UI
Learn how to use the Citizens management interface inside Hytale.
Developer API
Integrate HyCitizens into your own plugin with the Java API.
What You Can Do
HyCitizens supports a wide range of NPC features out of the box:Custom Appearance
Set any model, scale, player skin, armor, and held items.
Movement Behaviors
Idle, wander, patrol named paths, or follow other Citizens.
Interaction Actions
Run commands and send messages when players interact with an NPC.
Combat System
Passive, neutral, or aggressive attitudes with full combat tuning.
Daily Schedules
Give Citizens time-based routines that move them between locations.
Patrol Paths
Define multi-waypoint patrol routes that Citizens follow automatically.
Get Started
Install the plugin
Download HyCitizens from CurseForge and place the JAR in your server’s
mods/ folder.Launch your server
Start the Hytale server. HyCitizens will initialize automatically and create its data directory at
mods/HyCitizensData/.Open the Citizens UI
In-game, run
/citizens (requires the hycitizens.admin permission) to open the management interface.HyCitizens depends on HyUI. Make sure HyUI is installed before loading HyCitizens.