Installation

Get HyCitizens installed on your Hytale server in just a few steps.

Requirements

A running Hytale server
The NPC plugin enabled on your server
Server operator / admin access

Step 1: Download

Download the latest release of HyCitizens from CurseForge:

https://www.curseforge.com/hytale/mods/hycitizens

Download the .jar file from the Files tab on the CurseForge page.

Step 2: Install the Mod

Place the downloaded .jar file into your server's mods/ folder:

your-server/
└── mods/
    └── HyCitizens.jar   ← place it here

Step 3: First Start

Start your server normally. On the very first run, HyCitizens will automatically create its required asset pack and then shut the server down. This is expected and only happens once.

⚠️

Expected First-Run Shutdown

You will see a warning in your server console that reads "HYCITIZENS IS PERFORMING A ONE-TIME SHUTDOWN". This is completely normal. Simply start the server again and it will run as expected from then on.

Step 4: Start Again

Restart your server. HyCitizens will now fully load and you'll see it in the mod list. The following folders will have been created:

your-server/
└── mods/
    ├── HyCitizensData/     ← citizen configs are saved here
    └── HyCitizensRoles/    ← auto-generated NPC roles

✓

You're Ready!

HyCitizens is now installed. Head to the Creating Citizens guide to make your first citizen.