Hytale servers are coming soon
Hytale's licence is for personal, non-commercial use, and Hypixel Studios approves hosting companies through its Game Server Provider registration. Hytale opens on Wilderack once that registration is approved. These guides are ready for the day we open.
Hytale mods run on the server, so your friends don’t install anything to join. Add mods from the Mods tab with one tap, or upload .jar and .zip files to the mods folder, then restart.
How Hytale mods work
Hypixel built Hytale so that all modding happens on the server. It doesn’t support client mods. A player joining a modded server gets what they need from the server.
There are two main kinds of mod. Both go in the same mods folder:
| Kind | File | What it changes |
|---|---|---|
| Plugins | .jar |
Java code that adds features to the server: commands, minigames, protection, economy |
| Packs | .zip |
Content made with Hytale’s tools: blocks, items, creatures, models, sounds, world generation |
Many mods include both. Some plugins also create a settings folder inside mods the first time they load.
Where mods come from. CurseForge is the main site for Hytale mods. Since Update 6, Hytale also has an in-game mod browser on the main menu, which installs mods for your own worlds. For a server, use the Mods tab or upload the files.
Install a mod from the Mods tab
- Open Mods in the panel.
- Search for a mod by name, or browse.
- Pick it. The panel shows whether it works with your server’s Hytale version.
- Press install. You’ll see a short plan: the files, any other mods it needs, and any warnings.
- Confirm. We make a backup first, then download the files from the mod’s official source into
mods. - Restart the server to turn the mod on.
This works while the server is asleep too. The mod loads the next time the server starts.
Some mod authors don’t allow other apps to download their files. The panel then links to the mod’s page, so you can download it there and upload it.
Install a mod by hand
- Download the mod’s
.jaror.zipfile from its page, such as on CurseForge. - In the panel, open Files and go into the
modsfolder. - Upload the file. You can also use SFTP: your server’s address, port
2022, and the login from the SFTP card in Files. - Restart the server.
- Open Console and read the startup lines. A mod that fails to load prints an error with its name.
Don’t unzip .zip mods. Hytale reads them as they are.
Early plugins
A few mods are “early plugins”, which load before the rest of the server. Hytale only loads them when you add --accept-early-plugins under Settings > Startup. Hypixel says early plugins are unsupported and may make the server unstable, so only use one when you need it, and follow the mod’s own setup notes.
What your friends need
Nothing. They join with your address and port as usual. Hypixel’s goal is that players can join any modded server without downloading external mods or packs.
They still need the same Hytale version as the server, like any other join.
Bring mods from your single-player world
If you built a world with mods in single player, bring the same mods so your world loads properly.
- In the Hytale launcher, open settings, then Open Directory… > User Data.
- Mods used by every world are in the
Modsfolder there. Mods for one world are in themodsfolder inside that world’s folder inSaves. - Upload those files to the server’s
modsfolder, or install the same mods from the Mods tab. - Restart.
The backups guide covers moving the world itself.
Updates and version matching
Hytale is in Early Access and updates often. The game and the server must be on the same protocol version, or players can’t join. When an update changes the protocol, plugins need a new build from their authors.
- Mods never update on their own on Wilderack. The Mods tab shows when updates are available, with an Update all button that makes one backup first.
- Your server updates Hytale on its own by default, so players with the newest game can always join.
- After a big Hytale update, check your mods’ pages for new versions. Since Update 6, the server stops if a core plugin fails to load, rather than running half broken. The Console shows which mod failed.
- Pinning a version in Settings > Game version keeps old mods working, but players on the newer game can’t join until you update. Only pin for a short time.
Mods that add blocks or items save them into your world. If you remove such a mod, those parts of the world may break. Make a backup in Backups before you remove a big content mod.
Mods and server rules
Plugins that sell ranks, items or crates must follow Hypixel’s Server Operator Policies. Paid random items, for example, are not allowed on All Ages servers. The rules are summed up in rules for server owners.
If a mod breaks the server
- Open Console and find the first error after startup. It usually names the mod.
- Remove that mod in Mods, or delete its file from
modsin Files. - Start the server again.
- If the world itself is damaged, restore the automatic backup made before the mod was installed, in Backups.
See the server stops right after a mod is added for more.
Questions
Do my friends need to install mods to join my modded Hytale server?
No. Hytale mods run on the server. Hypixel's aim is that players can join any modded server without downloading anything extra, and the game gets what it needs when they join.
Where do Hytale server mods go?
In the mods folder in the server's main folder. Both plugins (.jar files) and content packs (.zip files) go there. Restart the server to load them.
Where can I find Hytale mods?
CurseForge is the main home for Hytale mods, and you can search it from the Mods tab in the panel. Hytale's own in-game mod browser, added in Update 6, is for your single-player worlds.
Why did my Hytale server stop after an update?
Big updates can change Hytale's network protocol, and plugins built for the old version must be rebuilt by their authors. Since Update 6 the server stops if a core plugin fails to load. Update the mod, or remove it from the mods folder.
Sources we checked
- Hytale Modding Strategy and StatusHypixel Studios
- Hytale Server ManualHypixel Studios
- Update 6 Patch NotesHypixel Studios
- How to install mods for HytaleCurseForge
