How to Add Mods to Your Eco Server

Eco comes with its own mod system. Mods are installed on the server only – your fellow players do not have to download anything, the client receives everything it needs from the server when joining.

Warning

Stop your server before adding or removing mods. The server only reads the mod folder on startup.

Download mods

The official platform for Eco mods is mod.io.

Open mod.io
Go to mod.io/g/eco and pick the mod you want.
Check the version
Make sure the mod matches the version of your server. After a game update, older mods can cause errors or prevent the server from starting.
Download the mod
Download the mod. Usually you get a ZIP file containing one or more .dll files and possibly its own configuration files.
Read the mod instructions
Have a look at the mod description. It tells you which folder the files belong in and whether the mod requires other mods.

Upload the mods

Stop the server
Stop your server via the dashboard.
Connect via SFTP
Connect to your server via SFTP.
Extract the mod
Extract the downloaded ZIP file on your PC. You upload the extracted files – a ZIP file is not processed by the server.
Upload the files
Upload the files into the following directory:
```
/Mods/
```
Watch out for subfolders
Most mods go directly into the Mods folder. Some mods ask you to use the subfolder Mods/UserCode/ instead. Always follow the instructions of the respective mod.
Start the server
Start your server. The mods are loaded on startup.

Translations

Translation files do not belong in the main folder but in /Mods/Translations/.

Remove mods

Stop the server
Stop your server via the dashboard.
Delete the files
Delete the files or the folder of the mod from /Mods/.
Start the server
Restart your server so the mod is unloaded completely.

Important

Mods can add items, recipes and world objects. If you remove a mod from a running world, all content depending on it disappears. Create a backup beforehand.

Control mods through the configuration

The file /Configs/ModKit.eco defines how the server handles mods:

Setting	Meaning
`WhitelistEnabled`	Defines whether only selected mods are loaded. If the option is disabled, the server loads all available mods
`Whitelist`	List of `.dll` file names that should be loaded
`SubscribedMods`	List of mod.io mod ids this server is subscribed to
`MaxNumberOfDownloadRequests`	How many clients may download mods at the same time

File does not exist?

For every configuration, /Configs/ also contains a file ending in .eco.template. This template only holds the default values and is not read by the server. If ModKit.eco is missing, copy ModKit.eco.template and rename the copy to ModKit.eco.

Warning

Changes to the configuration files only take effect after a restart of the server.

Do players have to install the mods?

Note

No. Mods that also affect the client – such as new items or models – only need to be installed on the server. The client automatically receives the information it needs when connecting. The first join can take a little longer because of this.

Individual mods may still require a client component according to their own description. Check the instructions of the respective mod.

How to Add Mods to Your Eco Server ​

Download mods ​

Upload the mods ​

Remove mods ​

Control mods through the configuration ​