ShroudForge

Welcome!

ShroudForge is the loader that finds, checks, and starts mods for Enshrouded. A mod is a separate add-on that changes or adds something in the game. You can use mods made by other players, or create your own. Read how ShroudForge works for a clear explanation of how the loader and mods fit together.

New to mods? Start with the illustrated guide. It explains everything in simple steps, in English and German:

• English: install ShroudForge, add mods, and make your first mod
• Deutsch: ShroudForge einrichten, Mods hinzufügen und den ersten Mod bauen

The guide includes separate instructions for your PC and game server, pictures of the Modloader, a first-mod lesson, and an interactive preview for mod settings.

Quickstart: use ShroudForge

1. Close Enshrouded.

2. Download the Latest release:

   

3. Right-click the downloaded ZIP and choose Extract All.

4. Open the Enshrouded folder that contains enshrouded.exe.

5. Copy the files from the ZIP into that folder, beside enshrouded.exe.

6. Start Enshrouded and press F9 to open the Modloader.

A common Steam folder is:

C:\Program Files (x86)\Steam\steamapps\common\Enshrouded

The Modloader is the ShroudForge window inside the game. It shows your mods and lets you switch them on or off. Press F10 to read messages if something does not work.

Add a mod

Follow the mod creator's instructions. Unpack the mod download, then copy the mod folder into mods, beside enshrouded.exe. Keep any folder structure and extra files the creator includes.

Open the game, press F9, find the mod, and switch it on. Some mods need a game restart. Mods that change game files must prepare those changes before the game starts.

Read the full PC quickstart for screenshots and help with each step.

Multiplayer server quickstart

Note

The extra environment setting below is only for the Proton Docker image. It is not needed for the Windows game or the Enshrouded Dedicated Server installed through Steam.

Install ShroudForge and the mod on your PC and on the server.

1. Stop the server and back up your world.

2. Download the latest ShroudForge release.

3. Right-click the ZIP file and choose Extract All.

4. Open the server folder containing enshrouded_server.exe.

5. Copy the ShroudForge files from the ZIP into that folder, beside enshrouded_server.exe.

6. Unpack the mod you want to use, then copy its folder into the server's mods folder.

7. If you use the Proton Docker image mornedhels/enshrouded-server, add the environment setting below. It lets Proton load ShroudForge's DLLs.

   For an existing docker run setup, add this option to its command:

   -e 'WINEDLLOVERRIDES=dbghelp=native,builtin;winmm=native,builtin' \

   For Docker Compose, add the setting under environment, as shown in this complete example:

   services:
     enshrouded:
       image: mornedhels/enshrouded-server:dev-proton
       restart: unless-stopped
       ports:
         - "15637:15637/udp"
       volumes:
         - ./gamefiles:/opt/enshrouded
       environment:
         - "WINEDLLOVERRIDES=dbghelp=native,builtin;winmm=native,builtin"

   Keep your existing image, ports, volume, and other settings. After changing the environment, recreate the Docker container. The normal server port is 15637/udp.

8. Start the server again.

See the English server guide or the German server guide for the full Docker steps, including how to find and inspect an existing container before recreating it.

Make your first mod

Start with the mod template. It gives you the files for a small mod and explains what to change.

The website's first-mod lesson walks through a complete example. When you are ready, try the mod settings guide: edit an example on the left and see the Modloader-style preview on the right. It also shows how extended.mod.json exposes a setting and how Lua reads it with shroudforge.settings.get.

To look up functions or Enshrouded game information, open the searchable API reference.

Contribute translations

Help bring ShroudForge to players worldwide by contributing translations in Fink. Submit your changes as a GitHub pull request. Read the translation guide for the steps.

Repository structure

Product code is grouped by responsibility under modules/. Each module owns its behavior and its UI where needed. The module guide and code ownership guide describe the current boundaries.

modules/
  entrypoints/loader/       # Loader application and startup entrypoints
  modloader/                # Find, validate, configure, and order mods
  mod-runtime/              # Prepare and run mods, Lua APIs, callbacks, and reloads
  game-files/               # Game-file backups, status, and asset transactions
  game-runtime/             # Native game access, Rust bridge, compatibility, and profiles
  runtime-diagnostics/      # Runtime diagnostic jobs and measurements
  updater/                  # System updates and mod package updates
  transport/                # Steam networking
  world-editor/             # World editing features
  commands/                 # Command-line actions
  debug-console/            # In-game log and diagnostics window
  loader-config/            # Loader settings and game paths
  logging/                  # Log writing and display
  notifications/            # News events and notifications
  ui-resources/             # Shared UI resources and translations
.github/                    # GitHub workflows
dev/                        # Build actions, parser setup, tests, and profile tools
docs/                       # Guides, examples, evidence, and website source
website/                    # Static download website for shroudforge.net
mods/                       # Mod source included with the repository
kfc-parser/                 # Direct Git submodule for the KFC parser
assets/                     # Repository images and branding
build/                      # Generated build and website output
target/                     # Cargo build output

License and support

ShroudForge is shared under the MIT License.

Buy Me A Coffee

If this project has helped you in any way, do buy me a coffee so I can continue to build more of such projects in the future and share them with the community!