How to Add Mods to Your CryoFall Server

Mods in CryoFall are individual .mpk files. You upload them into the /Data/Mods/ folder and then activate them in the file /Data/ModsConfig.xml. Without an entry in that file an uploaded mod is not loaded.

Get the mod

1. Choose a mod
   You can find mods in the official CryoFall forum or on the websites and Discord servers of the respective mod authors.

2. Check the tag
   Mod authors state where their mod has to be installed:

   Tag	Meaning
   [Server]	Runs on the server only. Your players do not have to install anything.
   [Client]	Pure player-side mod. It has no effect on the server.
   [Client+Server]	Has to be installed on the server and on every player's PC.

3. Note the mod ID
   Write down the mod ID given by the author – often including a version number, for example duality_1.2.1. That exact ID is what you enter into ModsConfig.xml later on.

4. Check the version
   Make sure the mod matches the game version of your server. Mods built for another version can prevent the server from starting.

Upload the mod

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

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

3. Open the mods folder
   Go to the following directory:

   /Data/Mods/
   

4. Upload the .mpk file
   Upload the .mpk file directly into this folder. Do not create any subfolders.

Activate the mod

1. Open ModsConfig.xml
   Open the following file:

   /Data/ModsConfig.xml
   

2. Add the mod
   Add one line per mod containing its mod ID:

   <?xml version="1.0" encoding="utf-8" standalone="yes"?>
   <mods>
     <mod>core_1.0.0</mod>
     <mod>cnei</mod>
   </mods>
   

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

4. Check the console
   On startup your server reports the loaded mods in the console. If your mod does not show up there, the mod ID usually does not match the file name in the Mods folder.

Mods on your players' side

Remove mods

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

2. Delete the entry
   Remove the line of that mod from the file /Data/ModsConfig.xml.

3. Delete the file
   Delete the matching .mpk file from the /Data/Mods/ folder.

4. Start the server
   Start your server again.