DriversRecommendedOutdated drivers can make a good PC feel brokenScan driver issues before chasing fixes manually.Scan NowHalloween DealsAmazon USHalloween week deals: useful picks before month-endAmazon US: current deals, useful picks and tech finds.Check DealsWindows FixRecommendedWindows errors stealing your time? Find the fix fastScan stability, cleanup and performance issues.Fix Now×
FREEDOM251

Freedom251 › Blog › Command Line

Vintage Story Server Start Options and Launch Arguments: Complete Guide

By Freedom251 Team · · 9 min read

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.

Start a dedicated Vintage Story server by running the installed server executable with the arguments that match your operating system and deployment. The safest baseline is to verify the binary first with --version and --help, then launch it with a separate --dataPath. Use --ip, --port, --maxclients, --logPath, --addOrigin, and --addModPath for process-level settings. Keep gameplay and access rules in serverconfig.json or the in-game /serverconfig commands.

What Vintage Story server launch arguments control

Vintage Story has two configuration layers. Startup arguments tell the operating system how to run the server process: which executable to use, where its data and logs live, which address and port to bind, how many clients to allow, and where to find additional assets or mods. A second layer controls persistent server behavior such as passwords, advertising, whitelist mode, PvP, fire spread, entity spawning, tick rate, chunk radius, and spawn settings.

As an Amazon Associate I earn from qualifying purchases.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.

Use launch arguments when a setting belongs to the process or must differ between launch environments. Use /serverconfig or the server’s serverconfig.json when the setting describes the world or the rules players experience. Mixing the two layers can make troubleshooting difficult: a command-line override may take precedence for one launch, while a JSON edit may not be read until the process is restarted.

Check the options implemented by your installed build

The startup-parameter reference is version-specific. It was verified for Vintage Story 1.19.8, while the multiplayer setup documentation was verified for 1.20.0. Newer or older binaries can add, remove, or rename flags. The installed executable is therefore authoritative.

#1 Best Overall
What's Your Story? Memory Sharing Game
  • ENTERTAINING AND UNEXPECTED QUESTIONS: This handy box is filled with 140 surprising and engaging prompts to inspire reminiscences between family, friends, or couples!
  • FAMILY GAME NIGHT FUN: A special way to inspire intergenerational sharing. Great family game for kids and adults.
  • TAKE IT ANYWHERE: The portable box is the ideal size to throw in your bag to take on vacation or to a family get-together.
  • A FUN GIFT: Perfect for game night enthusiasts; kids, parents, and grandparents wanting to connect across the generations; anyone in search of birthday presents, anniversary gifts, or stocking stuffers for adults, teens, or the whole family.
  • EXPLORE THE ENTIRE SERIES: This game is part of the Games Room series, a collection of elegantly designed, geometrically patterned small boxes filled with engaging games to inspire lively conversation and endless laughs.
  1. Open a terminal or Command Prompt in the directory containing the dedicated-server executable.
  2. Run VintageStoryServer.exe --version on Windows, or the equivalent Linux command for the binary or .NET assembly.
  3. Run VintageStoryServer.exe --help and read the options printed by that exact build.
  4. Save the output with your server notes before building a long-running service or wrapper script.

The Vintage Story Wiki’s startup reference explicitly instructs administrators to call VintageStoryServer.exe --help from the game directory to obtain the currently implemented command-line arguments. Treat copied examples as starting points, not as a substitute for this check.

Launch argument reference

Argument Function Documented behavior or default
-v, --version Print the game version and exit. Exits after displaying the version.
-h, --help Print available startup parameters and exit. Output depends on the installed build.
-s, --standby Wait for the first connection attempt before fully launching. Useful when you want to defer full startup until a player connects.
--genconfig Create a fresh default serverconfig.json and exit. Warns that an existing configuration will be deleted.
--setconfig Set persistent configuration values and create serverconfig.json if it is absent. Uses the JSON-like syntax shown by the startup reference.
--withconfig Apply configuration values for the current launch. Launch-time override; it is not the same as permanently editing the file.
--dataPath Choose the directory for server saves, configuration, and related data. A separate path is recommended when the client and server share a machine.
--logPath Choose an absolute directory for logs. Path must be absolute.
--addOrigin Load additional assets from a specified path. Use for extra asset content outside the normal installation location.
--addModPath Load mods from one or more additional paths. Useful when mod files are maintained outside the default data directory.
--ip Bind the server to a particular IP address. Overrides the configured address for that launch.
--port Choose the listening TCP port. The documented default is 42420; an explicit value overrides configuration.
--maxclients Set the maximum number of simultaneous clients. The documented default is 16.
--archiveLogFileCount Set how many old log files are retained. The documented default is 5 archived files.
--archiveLogFileMaxSizeMb Set the maximum archive size. The documented default is 1024 MB.

The defaults in this table come from the startup reference and can change between releases. A missing default is not evidence that no default exists; it means the cited reference does not state one. Confirm behavior with --help and the generated configuration from your binary.

Free tools Windows power users keep installed

One-click scans. No signup required.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.

Use a dedicated data path

--dataPath is the most important option for a reliable installation. It keeps dedicated-server worlds, configuration, and logs separate from the client or single-player data on the same computer. That separation prevents a client update, profile change, or accidental file edit from affecting the server’s files.

Choose a directory that the account running the process can read and write. Back up that directory as a unit: it contains the world data and the configuration needed to restore the instance. If you run more than one server, give each instance its own data path and, preferably, its own log directory.

Rank #2
Disney Pixar Toy Story Cooperative Deck-Building Game | Family Board Game Featuring Characters and Artwork from Toy Story Movies and Short Films | Officially Licensed Disney Pixar Merchandise
  • HOWDY PARTNER - Welcome to Disney Pixar Toy Story Obstacles & Adventures, the cooperative deck-building game that brings the world of Toy Story to life! Play as your favorite characters from the films - Sheriff Woody, Buzz Lightyear, Jesse, Rex and Bo Peep
  • TO INFINITY, AND BEYOND - This family board game features artwork, characters, obstacles, and adventures from across all the Toy Story movies and television films - Toy Story, Toy Story 2, Toy Story 3, Toy Story 4, Toy Story of Terror!, and Toy Story That Time Forgot
  • THERE'S A SNAKE IN MY BOOT - Watch out for the hazards and obstacles that try and end playtime, While the toys may be cute, don't let them deceive you as there are serious challenges along the way
  • YOU'VE GOT A FRIEND IN ME - Work together in this cooperative group game as you build your deck and move along the 6 sequential games that build on their level of difficulty
  • 2-5 players | Ages 8+ | 30-90+ Min Play Time

The documented Linux/.NET form is:

dotnet VintagestoryServer.dll --dataPath /srv/vintagestory/data

The native Linux form is:

./VintagestoryServer --dataPath /srv/vintagestory/data

On Windows, quote a path containing spaces:

VintageStoryServer.exe --dataPath "C:VSDataMyServer"

The server creates or reads its configuration beneath the selected data location. If a command appears to have no effect, first verify that you are inspecting the configuration and logs under the same --dataPath used to launch the process.

Windows and Linux launch examples

Windows direct launch

The official self-hosting guidance describes a dedicated server as the server executable launched from the game’s installation path. A practical command combining documented options is:

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.
VintageStoryServer.exe --dataPath "C:VSDataMyServer" --port 42420 --maxclients 16

This line illustrates how options are combined; check the installed build’s help output before putting it into a permanent shortcut or service. Add --ip only when you need to bind to a specific local interface. Leaving the address at its configured value is usually simpler for a machine with one active network interface.

Linux with the .NET assembly

dotnet VintagestoryServer.dll --dataPath /srv/vintagestory/data

Use an absolute path for logs when adding --logPath:

Rank #3
It’s Kind of a Fun Story – Adult Party Game & Storytelling Card Game with 320 Conversation Cards for Friends, Couples, Families, Game Nights, Bachelorette Parties, Pre-Games, and Happy Hours
  • A WHOLE NEW WAY TO PARTY: Skip the small talk and spark unforgettable conversations with It’s Kind of a Fun Story, the adult party game where the story of your life earns you points. Perfect for adult game nights, pre-games, happy hours, bachelorette parties, or family gatherings.
  • EASY TO LEARN, FUN TO PLAY: Take turns drawing cards and answering questions to be the first player to earn seven points! Story Cards put you in the spotlight to tell a story from your life, but watch out, if another player thinks they have a better tale, they can play a Hear Me Out Card to try to steal your points. Left or Right, Point a Finger, and Everybody Answers cards keep every round fresh, fast-paced, and full of surprises.
  • FUN, HEARTFELT, AND FULL OF CONNECTION: With 320 conversation cards, every round is unique, hilarious, and full of exciting stories. More than just a funny adult card game, it brings people closer: laugh together, share embarrassing memories, and bond over stories that are silly, surprising, or even deep.
  • CUSTOMIZE YOUR VIBE: Keep it clean or make it spicy with the included R-Rated mini-expansion pack. Clearly marked R-Rated cards let you adjust to your group, and every player gets a Nope Card to skip any topic they’re not comfortable with. Everyone stays engaged and having fun. Perfect as a drinking game, icebreaker game, or casual conversation game.
  • PERFECT FOR EVERY OCCASION: Ideal for friends’ game nights, family gatherings, pre-games, happy hours, bachelorette parties, or adult game nights. It’s Kind of a Fun Story is the ultimate adult storytelling card game that gets everyone laughing, sharing, and connecting every time you play.
dotnet VintagestoryServer.dll --dataPath /srv/vintagestory/data --logPath /var/log/vintagestory

Linux native binary

./VintagestoryServer --dataPath /srv/vintagestory/data --port 42420

Make sure the binary is executable and that the service account owns or can write to the data and log directories. The assembly and native-binary forms are alternatives; use the one shipped for your installation.

Understand --genconfig, --setconfig, and --withconfig

--genconfig: reset to a new default

Run --genconfig when you intentionally need a newly generated default configuration. It exits after generating the file. The startup reference warns that an existing configuration is deleted, so stop the server and copy the current serverconfig.json before using this flag. This is a reset tool, not a routine startup option.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.

--setconfig: write persistent values

--setconfig changes configuration values and creates serverconfig.json when the file does not exist. The reference shows a JSON-like form:

VintageStoryServer.exe --setconfig="{ key: 3, foo:'value' }"

Use the exact spelling and value format accepted by your build’s help output. Shell quoting differs between Windows Command Prompt, PowerShell, and Linux shells, so test the command in the same shell that will run your automation. Because this option writes persistent settings, treat it like a configuration change and back up the file first.

Rank #4
Prey - PC
  • In Prey, you awaken aboard Talos I, a space station orbiting the moon in the year 2032.
  • You are the key subject of an experiment meant to alter humanity forever - but things have gone terribly wrong.
  • The space station has been overrun by hostile aliens and you are now being hunted.

--withconfig: override one launch

--withconfig applies values while the process starts without being the normal method for permanently editing the configuration. It is useful for a temporary test, a staging instance, or a launch profile that should differ from the saved world settings. Record the override in your service definition so another administrator does not mistake the on-disk file for the effective setting.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.

Put gameplay and access rules in server configuration

Use the in-game /serverconfig command for runtime changes supported by the server, or edit serverconfig.json for file-based administration. The command reference includes these patterns:

  • /serverconfig maxclients <number> changes the client limit through server configuration.
  • /serverconfig password <password> sets the server password.
  • /serverconfig advertise <true|false> controls whether the server is advertised.
  • /serverconfig WhitelistMode <default|off|on> selects whitelist behavior.
  • /serverconfig maxchunkradius <number> sets the chunk radius value.

Other persistent rules documented for this layer include PvP, fire spread, entity spawning, tick rate, and spawn point. The exact key capitalization matters when editing JSON or issuing commands, so copy names from the command reference or from the configuration generated by your version.

Stop the server before editing serverconfig.json. After saving a file change, relaunch the server so it reads the new values. A launch argument such as --maxclients can override the configured client limit for that process, so remove conflicting command-line values when you want the JSON setting to govern.

Best Value
3 PCS Metal Brain Teaser Puzzles Set for Present Gift
  • 3-Piece Premium Metal Puzzle Set for Adults 15+: This curated bundle has 3 unique vintage metal disentanglement puzzles for teens and adults craving brain challenges. Precision-cast high-strength alloy brings solid weight and smooth burr-free edges, no cheap plastic parts at all.
  • Durable Anti-Rust Build for Long-Term Play & Collection:Premium electroplated vintage metal coating resists scratches, fading and rust after months of repeated twisting. The sturdy structure won’t bend or break easily, making it a long-lasting collection piece for countless play sessions.
  • Boost Spatial Logic & Focus in a Screen-Free Way:This 3D IQ game trains your patience, spatial imagination and reverse thinking as you twist and explore hidden mechanisms. Gradual difficulty keeps you engaged for hours, melting work stress and keeping your mind sharp.
  • Pocket-Sized Fun for Travel, Parties & Gatherings:Compact and lightweight enough to slip into your bag or jeans pocket, it lets you enjoy brain teasers on commutes, trips or family game nights. It livens up group interactions and pulls everyone away from mindless scrolling.
  • Thoughtful Gift for Puzzle Lovers & Special Occasions:With clear illustrated instructions, this challenging disentanglement set is perfect for birthdays, anniversaries and holiday gifting. It’s more than a game — a fun, memorable way to share quality time with friends and partners.

Dedicated servers use whitelisting by default as of version 1.20 according to the dedicated-server guide. Check the generated configuration and your access policy before opening a new instance to players, especially when migrating from an older release.

What’s actually slowing this PC down?

Pick the symptom - the matching free tool is one click away.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.
Independent reader supportYour contribution helps us test, update, and keep practical guides available for everyone.Support on Ko-Fi

Choose a process and lifecycle method

Approach Best for Operational trade-off
Direct executable or dotnet process Testing, occasional play, and manual administration. Simple, but the server stops when the terminal or user session ends unless you provide your own persistence.
Linux server.sh Operators who want a documented wrapper for routine lifecycle actions. The Wiki documents start, stop, status, update, restart, setup, and command; you still manage the host and its permissions.
systemd Always-on Linux servers that should start at boot and be supervised. Requires a service definition, a dedicated account, correct working and data paths, and log/upgrade planning.
Managed hosting Owners who do not want to maintain the operating system or lifecycle scripts. The provider is still operating the same executable, data directory, configuration, and restart layer. Verify supported Vintage Story versions, mod handling, backups, network settings, and commercial terms before committing.

An ad-hoc world opened to LAN is different from a dedicated server. The official self-hosting guidance describes the dedicated mode as keeping the server available by launching VintageStoryServer.exe from the installation path, rather than relying on a player to open a world through the client.

Practical startup recipes

Isolated Windows instance

VintageStoryServer.exe --dataPath "C:VSDataSurvival" --logPath "C:VSDataSurvivallogs" --port 42420 --maxclients 16

Use this profile when the server shares a Windows machine with the game client. The explicit data and log paths make backups and diagnosis straightforward.

Minimal Linux instance

dotnet VintagestoryServer.dll --dataPath /srv/vintagestory/survival

Start minimally, confirm that the world loads and the process listens, then add a custom log path, bind address, or mod path one at a time. Incremental changes make a bad path or incompatible asset easier to identify.

Temporary staging override

./VintagestoryServer --dataPath /srv/vintagestory/staging --withconfig="{ advertise:false }"

This pattern illustrates a launch-only configuration change. Confirm the accepted syntax in your binary and shell before using it in automation.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.

Troubleshoot failed or unexpected starts

The command is rejected or an option is unknown

  • Run the executable with --help from its installation directory.
  • Check --version and compare it with the documentation you followed.
  • Confirm spelling, capitalization, hyphens, and whether your shell stripped quotation marks.

The server starts with the wrong world or settings

  • Print or inspect the complete launch command and verify --dataPath.
  • Look for multiple copies of serverconfig.json and edit the one beneath the active data path.
  • Remove a temporary --withconfig or conflicting process-level override when testing persistent settings.
  • Stop the process before editing JSON, then relaunch it.

Players cannot connect

  • Confirm the process is listening on the intended --ip and --port.
  • Check that another service is not already using the port.
  • Verify host firewall and router rules separately; a successful local launch does not prove Internet reachability.
  • Check whitelist mode, password, and advertising settings in the server configuration.

Logs are missing or disk usage grows

  • Verify that --logPath is an absolute, writable directory.
  • Use --archiveLogFileCount to control the number of retained archives.
  • Use --archiveLogFileMaxSizeMb to cap the archive size and monitor the filesystem.

Mods or extra assets are not loaded

  • Check each path passed to --addModPath or --addOrigin.
  • Use absolute paths while diagnosing permissions and working-directory problems.
  • Read the startup log for path, file, or version errors before changing gameplay settings.

Pre-launch checklist

  • Record the output of --version and --help.
  • Create a dedicated, writable --dataPath and back it up.
  • Choose an absolute --logPath if logs should live outside the data directory.
  • Set --ip, --port, and --maxclients only when you need to override configuration.
  • Keep gameplay and access rules in /serverconfig or serverconfig.json.
  • Stop the server before editing JSON and relaunch afterward.
  • For Linux, select direct execution, server.sh, or systemd based on the required persistence.
  • For a managed host, confirm version, data-path access, backups, mods, and restart policy in the provider’s terms.

Version and default caveats

The documented startup defaults are configuration defaults, not performance guarantees: port 42420, 16 maximum clients, five archived logs, and a 1024 MB archive-size limit. No independent benchmark establishes how many players a particular machine can support. CPU, memory, storage, world generation, mods, network conditions, and chosen simulation settings all affect practical capacity.

Because the startup page and multiplayer guides cover different releases, re-check every copied command after an update. A reliable upgrade routine is to stop the process, back up the data directory and configuration, run the new binary with --version and --help, then start with the same explicit data path and inspect the first log for warnings.

Quick Recap

Bestseller No. 4
Prey - PC
Prey - PC
In Prey, you awaken aboard Talos I, a space station orbiting the moon in the year 2032.; The space station has been overrun by hostile aliens and you are now being hunted.
$7.99

Product prices and availability are accurate as of the date/time indicated and are subject to change. Any price and availability information displayed on Amazon at the time of purchase will apply.

Command LineGame ServersLinuxserver administrationVintage StoryWindows

Leave a Reply

Your email address will not be published. Required fields are marked *

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.

Recommended PC Tool
Recommended PC Tool
Windows Errors? Fix Them Before They SpreadFree repair scan
Outdated Drivers Are Slowing You DownFree scan - exact matches

Two free Windows tools

One Free Minute Could Fix That PC

Before you go - each of these free tools takes about a minute and tackles what quietly slows a Windows PC down.

Special offer. View Outbyte info, uninstall instructions, EULA, and Privacy Policy.