Setting up a modded Vintage Story dedicated server
Tutorials

Vintage Story Modded Server: How to Set One Up

A modded Vintage Story server in seven steps from the game’s own documentation: the dedicated server, choosing a version, the Mods folder and ModPaths, dependencies, the same mods for every player, the 1.20 whitelist, and updates.

Want your own server? Vintage Story server hosting — plans, specs and regions.

November 16, 20266 min read
Share

On This Page

A modded Vintage Story server is three things: a dedicated server, the mods in its Mods folder, and the same mods on every player's game. None of it is hard, but the order matters, and one shortcut is closed: the developer's own server rental "does not support 3rd party mods, meaning mods not created by Anego Studios directly cannot be installed". This guide walks through setting up a modded server from scratch, using the game's own documentation.

Step 1: get a dedicated server

The game ships with a dedicated server program. On Linux you download the server archive from the developer's site and start it with a data folder of its own:

./VintagestoryServer --dataPath /path/to/data

The data folder is where the server keeps its worlds, mods and settings. If you host at home, the game's wiki says to forward port 42420, for TCP and, since version 1.20, for UDP too. For hardware, the wiki's "rough, conservative estimate" is 1 GB of memory plus 300 MB per player, and 4 CPU threads.

Want these mods on a server tonight?

Search the Mod DB from your dashboard and install: we pick the release for your game version, add the mods it depends on, and list every mod's exact version for your players. Backups, file manager and SFTP on every plan.

Start a modded Vintage Story server

Step 2: choose the game version, then the mods

Every mod release on the Mod DB is tagged with the game versions it was built for, and the game's wiki advises checking that a mod matches the version you play. So pick the game version first. The current stable release is 1.22.7.

Then build your list from releases tagged for that version. After a big update, this is the slow part: when 1.22.0 came out, 72 of the 200 most-downloaded mods had a release for it on day one, 116 within a week and 150 within 30 days. If a mod you depend on is missing, that is a reason to stay on the older version a little longer. Our list of the best Vintage Story mods for a multiplayer server names the 1.22 release of each pick.

Step 3: put the mods on the server

The server looks for mods in the folders listed under ModPaths in its serverconfig.json. The first entry, Mods, loads the base game itself, and the wiki warns not to remove it. Add your data folder's Mods directory as a second entry if it is not there already.

Then, with the server stopped, copy each mod's .zip into that folder. Do not extract it. Start the server, and the mods load with it.

The game also has a console installer, /moddb install, but on 1.22.7 the built-in installer currently errors. Copying the files is the reliable route for now.

Step 4: don't forget dependencies

A mod's modinfo.json can list other mods it depends on, with versions. Libraries are the usual case: Config lib is a settings library for content mods, and Pet AI is a framework for tameable creatures that "does nothing on its own". Check each mod's page and install what it needs in the same folder.

Step 5: give your players the same mods

Most mods run on both the server and the player's game, and by default the game requires such a mod on the player's side. So every player needs the same mods, in the same versions. Send your group the exact list: name, version and Mod DB link for each. Players put the zips, unextracted, in their own Mods folder:

  • Windows: %appdata%\VintagestoryData\Mods
  • Linux: ~/.config/VintagestoryData/Mods
  • macOS: ~/Library/Application Support/VintagestoryData/Mods

The game's Mod Manager has an Open Mods Folder button that goes straight there. Mods marked as server-side only stay on the server, and client-side mods, such as a HUD tweak, are each player's own choice.

Step 6: settings for a modded group

Since version 1.20, a new dedicated server is invite-only: in its own start-up message, servers "are invite-only (whitelisted) out of the box". Add each player with /player PlayerName whitelist on, or turn the whitelist off and set a password instead. Two settings in serverconfig.json are for mods: ModIdBlackList keeps out players who have a listed mod enabled, and DisabledMods, under WorldConfig, tells the world to ignore installed mods by ID.

Step 7: keep it working through updates

The game's wiki lists three times to back up your world: before adding mods, before removing one, and before updating the game. When a new game version comes out, update the server, its mods and every player's game and mods together. The game's troubleshooting guide puts it simply: update all of your mods at the same time, though some keep working.

The faster way

On Vintage Story server hosting at Connect, steps 1 and 3 are already done: the official server is installed in under a minute, with one port and a data/Mods folder ready, and you reach every file through the file manager or SFTP.

The Mods tab handles steps 2 to 5: search the Mod DB, click install, and we pick the release for your game version and add its dependencies. The same tab lists each mod's exact name, version and link, ready to send to your players.

New servers start with the whitelist off, so your group can join as soon as they have the mods.

Frequently Asked Questions

Can the official Vintage Story server run mods?

Not third-party ones. The developer's server rental "does not support 3rd party mods". A modded server has to be your own dedicated server.

Where is the mod folder on a Vintage Story server?

In the folder listed under ModPaths in serverconfig.json, usually the Mods folder inside the server's data folder. On a Connect server it is data/Mods.

Do I unzip mods for the server?

No. The game's wiki says not to extract mod zips: copy the .zip file itself into the Mods folder.

Do players have to install the server's mods?

For most mods, yes, in the same version. Only mods marked as server-side, or whose authors say players can join without them, can be left off.

Why won't my players connect after I added mods?

Usually a missing or out-of-date mod on their side. A mod author can stop players with an older version of the mod from joining. Compare their Mods folder with the server's. Our players can't join guide has the full checklist.

Mods from the official Mod DB, one click each

Search the Mod DB from your dashboard and install: we pick the release for your game version, add the mods it depends on, and list every mod's exact version for your players. Backups, file manager and SFTP on every plan.

Start a modded Vintage Story server

Or see plans, specs and regions on Vintage Story server hosting.

Related Help Articles

Need step-by-step instructions? Check out these guides in our Help Center.