How to install mods on your Enshrouded server

Yes, your Enshrouded server can load mods. It uses EML, the community Enshrouded Mod Loader. The loader is off until you turn it on, and you can turn it off again at any time.

What EML mods can do

EML mods change the game's data when the server starts, for example item stats, recipes or balancing. They cannot add console commands or run scripts while the game is running.

Turn the mod loader on

1. Open your server in the panel and click the Modding tab.
2. On the Enshrouded Mod Loader (EML) card, switch on Mod loader (EML).
3. Restart the server. The first start with the loader on downloads it, which takes a few seconds.

Add a mod

1. Download the mod. An EML mod is a folder with a file called mod.json in it, usually with a src folder beside it, or a .zip with mod.json at its top.
2. Click the Files tab and open the mods folder.
3. Upload the mod so that mods holds the mod's folder, or its .zip, directly. mods/my_mod/mod.json is right, mods/my_mod/my_mod/mod.json is one folder too deep.
4. Restart the server.

The Console shows what happened at each start:

• pnh-eml: on (EML v0.2.0), 1 mod(s) in mods/ when the server starts.
• pnh-eml: mods loaded (my_mod): Applied 1 patches when the mods were applied.

If the console says a folder is one folder too deep, or has no mod.json in it, fix that in Files and restart.

If a mod fails to load

If a mod fails to load, the server stops instead of starting. This is on purpose: your world is never opened without the mods it was played with. The console names the mod and the reason, for example:

pnh-eml: the mod my_mod failed to load, so the server stopped instead of opening your world without it. Reason: ...

The full details are in logs/<date>.eml.log, where the date is in UTC. To start again, remove or update that mod in mods, or turn the mod loader off, then start the server.

One mod that fails stops all of them, so when you add several mods at once and the server stops, the console tells you which one to look at. Mods made before Enshrouded 1.0 may not work on 1.0: check the mod's page for a version made for 1.0.

Do players need the mod too?

It depends on the mod. Check the mod's page to see whether players also need to install it on their own game.

Turn the mod loader off

Switch off Mod loader (EML) on the Modding tab and restart. The loader is removed and the game's original data is put back. Your mods stay in the mods folder, so turning the loader on again picks them up.

A world that was played with mods can lose modded items if you later play it without those mods. Make a backup before you remove a mod from a world you care about: see How to back up and restore your Enshrouded world.

Game updates

When Enshrouded updates, a mod or the mod loader itself may stop working until it is updated. If the server stops after a game update with mods on, the console says why. Turn the mod loader off to play without mods until an update is out.