Guides for Kiln.
Get a mod running in your game, build your first C# mod, or set up a dedicated server.
Browse the official wiki
Install and enable a mod
Use Enshrouded from Steam and the launcher for your platform. Use a separate local world and character for this check. Back up your saves if you’re changing an existing setup.
- Close the game and open Kiln. If your installation is missing, select Add a folder and choose the game folder. On Play, select Install and confirm.
- For this walkthrough, choose the UI sample ZIP for your runtime from the release assets. Import it with Add mods and confirm UI sample is enabled.
- Select Play, open your test world and press F8. The UI sample window should open.
If the sample window doesn’t open
Open Logs and look for a fresh mod uisample 1.0.0 loaded entry. If Kiln reports an unverified game build, check for a matching runtime before opening your regular world. On Linux or Steam Deck, follow the Proton setup for your version. If the sample itself causes a problem, close the game and switch the sample off.
Build your first C# mod
The example below uses the archived dev.27 kit and runtime with .NET 10 and API 0.2.2. It places Kiln.Api, Kiln.Sdk and Kiln.Templates in one local feed folder. For a new setup, use the matching kit for your release and follow the official quickstart.
Replace both example paths. Check that the first command lists a .NET 10 SDK, then run each line after the previous one succeeds.
dotnet --list-sdks
kiln new mod MyMod --feed "/path/to/kiln-feed" --server "/path/to/test-server" --set tests=true
cd MyMod
kiln build
kiln deploy --server "/path/to/test-server"
Start the test server. Check the log for a fresh mod my-mod 0.1.0 loaded entry and run the template test.
kiln logs --mod my-mod --server "/path/to/test-server"
kiln test my-mod --server "/path/to/test-server"
If the build fails, check the SDK, feed path and package versions. If the new mod fails to load, stop the server and remove the deployed mod folder. Restore its previous copy if you replaced one, then check the log after restarting.
Official quickstart · Archived dev.27 C# API reference · CLI reference
Set up a dedicated server
Use an Enshrouded Dedicated Server test instance. Stop it and back up its saves, configuration, existing kiln/ folder and loader files. If dinput8.dll is present, check the loader setup before replacing it.
Hosted server
Confirm you can upload custom DLLs, restart the server and read its logs. Follow the README in the server pack. Upload dinput8.dll and kiln/ next to enshrouded_server.exe while the instance is stopped. If the host runs Wine and no log appears, ask your provider about the DLL override.
Your own Windows server
Install Enshrouded Dedicated Server from Steam Tools. With it stopped, follow the server pack README and extract the pack into the game server folder. Start the server as usual or use Servers in the launcher for a local instance.
Headless Linux
Install SteamCMD and GE-Proton or Wine. Check the ntsync requirements in the wiki. The commands below are an archived dev.27 example. For a new setup, choose the matching binary and runtime bundle and follow the current headless Linux instructions.
install -Dm755 ./kilnctl "$HOME/.local/bin/kilnctl"
"$HOME/.local/bin/kilnctl" init kiln-test --dir "$HOME/srv/enshrouded/kiln-test" --port 15637
"$HOME/.local/bin/kilnctl" install kiln-test
"$HOME/.local/bin/kilnctl" prefix kiln-test
"$HOME/.local/bin/kilnctl" deploy kiln-test --bundle "$PWD/kiln-runtime-0.2.0-dev.27.zip"
"$HOME/.local/bin/kilnctl" preflight kiln-test
"$HOME/.local/bin/kilnctl" start kiln-test
"$HOME/.local/bin/kilnctl" status kiln-test
For system Wine, add --wine system to init. Headless Linux instructions
Verify boot and connection
Check kiln/logs/kiln.log for a verified game build and boot complete. Review warnings and join with a test client before inviting players. Before an update, stop the instance and keep the previous package and a fresh backup. If the new runtime fails to boot, restore the previous working files and configuration before restarting.