Skip to content

How to Add Mods to Your Unturned Server ​

Unturned comes with its own download system for the Steam Workshop: you add the file IDs of the mods and maps you want to the file WorkshopDownloadConfig.json, and your server downloads them automatically on startup.

The best part

Your fellow players do not have to install or subscribe to anything manually. When connecting, the client automatically downloads all mods configured on your server.

Find the file ID ​

  1. Open the Steam Workshop
    Open the Steam Workshop for Unturned and look for the mod or map you want.

  2. Copy the file ID
    The file ID is part of the URL of the Workshop page. Copy the number after ?id=.

    Example

    In the URL https://steamcommunity.com/sharedfiles/filedetails/?id=2136497468 the file ID is 2136497468.

Add mods to the server ​

  1. Stop the server
    Stop your server via the dashboard.

  2. Connect via SFTP
    Connect to your server via SFTP.

  3. Open the configuration file
    Open the following file:

    /Servers/<ServerID>/WorkshopDownloadConfig.json

    Which folder is mine?

    <ServerID> is the folder name inside /Servers/. It comes from your server's startup parameter – usually there is exactly one folder there.

  4. Enter the file IDs
    Add the IDs to the File_IDs section, separated by commas:

    json
    "File_IDs":
    [
        2136497468,
        1497352180
    ],

    Warning

    Only change the File_IDs section and leave the remaining entries of the file untouched. There must be no comma after the last ID, otherwise the file is invalid and your server will not start.

  5. Start the server
    Save the file and start your server. On startup all configured mods and their dependencies are downloaded and updated.

Use a Workshop map ​

A map from the Workshop needs two entries: the file ID so it gets downloaded, and the map name so the server actually loads it.

  1. Add the file ID
    Add the file ID of the map to WorkshopDownloadConfig.json as described above.

  2. Select the map
    Open the following file:

    /Servers/<ServerID>/Server/Commands.dat

    and enter the name of the map – one instruction per line:

    Map Elver
  3. Start the server
    Save both files and start your server.

Important

Switching the map starts the world from scratch. Create a backup of your current save beforehand.

MapFile ID
Elver2136497468
Carpat1497352180
Hawaii1753134636
Greece1702240229
Arid2683620106
Buak3000549606
A6 Polaris2898548949
Escalation3251926587
France1975500516
Ireland1411633953
Belgium1727125581
Kuwait2483365750
California1905768396
Rio de Janeiro3416057692

Further settings in the file ​

EntryMeaning
File_IDsThe list of mods and maps your server downloads
Ignore_Children_File_IDsDependencies that should deliberately not be downloaded
Use_Cached_DownloadsReuse files that have already been downloaded
Should_Monitor_UpdatesThe server watches whether an update is available for a mod
Shutdown_Update_Detected_TimerWaiting time in seconds before shutting down after a detected update (default 600)
Shutdown_Update_Detected_MessageMessage players see when an update is detected
Shutdown_Kick_MessageMessage shown when players are disconnected

Automatic update monitoring

When your server detects a Workshop update it warns the players and shuts down after the timer expires, so the mod is updated on the next start. If your server restarts on its own after a mod update, that is expected behaviour.

Remove mods ​

  1. Stop the server
    Stop your server via the dashboard.

  2. Delete the entry
    Remove the file ID from the File_IDs section and make sure there is no comma after the last remaining ID.

  3. Start the server
    Save the file and start your server.

Warning

Removing a mod also removes every item, vehicle and object from that mod that was placed in your world. Create a backup beforehand.

Common problems ​

Mod is not downloaded

Workshop content that has not been updated since the engine change in version 3.28 is not downloaded by the server. Check on the Workshop page when the mod was last updated and switch to a maintained alternative if necessary.

Do not upload mods manually

Do not upload mods manually via SFTP into the Workshop folder. Players only download the mods that are listed in WorkshopDownloadConfig.json automatically – manually uploaded mods are missing on the clients and joining fails. Always configure mods in WorkshopDownloadConfig.json.