How to Add Mods to Your Mindustry Server

Mindustry distinguishes two kinds of extensions, and both go into the same folder:

Type	Effect
Mod	Adds content such as blocks, units or items. Must be installed on the server and on every player's client.
Plugin	Runs on the server only, usually for extra commands or game modes. Players do not need it.

Obtain the mod file

1. Choose a mod
   Look for the mod you want in the in-game mod browser or on the mod author's page.

2. Download the file
   Your server accepts the following formats:

   Format	Note
   .jar	Typical for Java mods and plugins
   .zip	Typical for mods built with JSON or HJSON
   Extracted folder	Must directly contain a mod.json, mod.hjson, plugin.json or plugin.hjson

3. Check the version
   Make sure the mod matches the game version of your server. Mods built for a different 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
   Change into the following directory:

   /config/mods/
   

4. Upload the file
   Upload the file directly into this folder.

5. Start the server
   Start your server via the dashboard. Changes in the mods folder are only read on server start – there is no command to reload mods.

6. Check the mods
   Open the console in the dashboard and enter:

   mods
   

   The server lists all loaded mods with version and status and finally prints the mod directory it uses. For details about a single mod use:

   mod <name>
   

Mods on the players' side

That is why every player installs the mods themselves – through the in-game mod browser or manually in the mod menu. There is no download from the server.

Plugins

Plugins are Java extensions that only run on servers. They typically add new commands or game modes and can be recognised by their meta file plugin.json or plugin.hjson.

Remove mods

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

2. Delete the file
   Delete the corresponding file from the /config/mods/ folder.

3. Start the server
   Start your server again.