Install Mods on your Vintage Story Server

Mods allow you to enhance gameplay and customization of your Vintage Story server.

Locating the mod(s) you wish to install

First, navigate to the Vintage Story Mod Database. This site contains all the available mods for Vintage Story.

Install the Mod(s) through Command

After locating the mod you'd like to install, make sure to note its exact name. You'll use this name in the command so the server knows which mod to retrieve from the mod database.

Now that you've noted the mod's name, you can install it on the server. This can be done in-game or through the console by running /moddb install [modname], replacing [modname] with the name of the mod you wish to install. For example, the Floating Fish mod would be installed with /moddb install floatingfish. Once installed, restart the server to load the new mod.

If the server doesn't recognize the mod name, try opening the Files tab on the mod's page in the Vintage Story mod database. Find the version you want to install (usually shown as @[version] after the mod name), then run /moddb install [modname]@[version].

For example, the Floating Fish mod version 1.1.1 can be installed with: /moddb install floatingfish@1.1.1.

If the server still does not recognize the name, proceed with following the steps below to install the mod manually via SFTP.

Install the Mod(s) manually through SFTP

If you are looking to add mods in bulk, doing so through SFTP may prove faster than individually installing each mod via command. In this case, review our article on Using SFTP to login to your server's SFTP. Once you're there, upload the mod's .zip file into the data/Mods directory.

Restart the Server

Once you've added the mods you want, restart the server to load them. You'll then be able to play with those mods! Your players will be prompted to install the mods onto their client when they try to join the server.