Usage Instructions

This document provides instructions on how to use the Enshrouded Mod Loader to load and manage mods for the game Enshrouded.

There are currently two ways to use EML:

1. Using the Enshrouded Mod Loader Proxy DLL (recommended)
2. Using the Enshrouded Mod Manager CLI

Using the Proxy DLL (Recommended)

This is the recommended way to use EML as it provides a seamless experience for loading mods directly when launching the game. This works for both client and server installations of Enshrouded.

Prerequisites

• Ensure you have a legal copy of the game Enshrouded installed on your system.
• Download the latest version of the dbghelp.dll binary.
• If you used EML before with the dbghelp.dll proxy, make sure to remove it from your game directory to avoid conflicts.

Installation

1. Extract the contents of the downloaded archive.
2. Copy the dbghelp.dll file to the root directory of your Enshrouded installation.
3. Create a mods directory in the root directory of your Enshrouded installation if it doesn't already exist.
4. Place the mods you want to use in the mods directory.
5. For linux users, follow the additional instructions in the Linux Users section.
6. (Optional) Modify the eml.json configuration file.
   • Useful for enabling the console or export capabilities.
7. Launch the game.

IMPORTANT: If you used EML before with the dbghelp.dll proxy, make sure to remove it from your game directory to avoid conflicts.

Linux Users

Using dbghelp-proxy with Wine/Proton or on Steam requires some additional setup.

For clients on Steam, change the launch options (Enshrouded > Properties > General > Launch Options) to:

WINEDLLOVERRIDES="dbghelp=native,builtin" %command%

For servers or standalone execution, run the game executable with:

WINEDLLOVERRIDES="dbghelp=native,builtin" wine path/to/enshrouded.exe

or with Proton:

WINEDLLOVERRIDES="dbghelp=native,builtin" proton run path/to/enshrouded.exe

Troubleshooting

If you encounter issues on the client, try dinput8.dll instead of dbghelp.dll.

eml.json Configuration

This file is created automatically when you launch the game for the first time with the proxy DLL.

• enable_console (boolean, default: false): If set to true, a console window will be opened alongside the game for debugging purposes.
• use_export_flag (boolean, default: false): If set to true, the export capability will be enabled when launching the game. This is useful if you want to let mods export stuff when using the proxy DLL.
• export_directory (string, default: "export"): The directory where exported files will be saved. This path is relative to the game directory.

Using the CLI

This method allows you to load mods using the command line interface. Additionally, it can also be used to run mods with the export capability.

Prerequisites

• Ensure you have a legal copy of the game Enshrouded installed on your system.
• Download the latest version of the emm.exe binary.
• A terminal or command prompt of your choice.
• Basic knowledge of command line usage.

Loading Mods

To load mods using the CLI, follow these steps:

1. Open a terminal or command prompt.

2. Navigate to the directory where you extracted the emm.exe binary (or put it in your PATH)

3. Run the following command to run the mods:

   emm.exe run -g <game-dir> [OPTIONS]
   

   By default, this will only validate the mods and not actually run them. To actually run the mods, you need to pass feature flags for the capabilities you want to enable.

   For example, to enable the patch and export capabilities, you would run:

   emm.exe run -g <game-dir> --export --patch
   

4. Launch the game.