DriversRecommendedOutdated drivers can make a good PC feel brokenScan driver issues before chasing fixes manually.Scan NowOctober DealsAmazon USOctober deal check: compare before you payAmazon 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×
Skip to content
VGSources
Blog

Vintage Story Server Config and serverconfig.json Explained

A practical guide to Vintage Story’s serverconfig.json: file locations, networking, passwords, whitelist modes, roles, performance, mods, WorldConfig, and troubleshooting.
Length9 min Posted Quest giverVGSources Team
Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.

serverconfig.json is the central configuration file for a Vintage Story dedicated server. It controls the server’s name, network binding and port, public listing, passwords, player access, roles, performance limits, mods, logging, and the WorldConfig section used when a world is created.

For Vintage Story 1.20.0, the usual Windows location is %appdata%/VintageStoryData/serverconfig.json; the usual Linux location is /var/vintagestory/data/serverconfig.json. The active file is determined by the server’s configured data path, so a different startup path can place it elsewhere.

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.

Where serverconfig.json is stored

The file belongs to the server data directory, not necessarily the directory containing the game executable. If you run more than one server instance, each instance can have its own data path and its own configuration.

Platform Default documented path Important qualification
Windows %appdata%/VintageStoryData/serverconfig.json The path is relative to the Windows user profile running the server.
Linux /var/vintagestory/data/serverconfig.json The actual location follows the server’s configured data path; systemd or custom launch scripts may use another directory.

If you cannot find the file, start the server once, check the data directory used by its launch command, and look for the generated configuration there. Do not create a second copy in a convenient-looking folder unless the server is configured to read that folder.

#1 Best Overall
Sale
Gaoye Blue Light Blocking Glasses
  • BLUE LIGHT BLOCKING GLASSES: Our blue light glasses for women boast UV400 protection, blocking harmful blue rays from computer screens. With these bluelight glasses women, you can enjoy gaming, reading, or watching TV with no worries of eye strain.
  • EYE RELIEF: Our blue light glasses are engineered to reduce blurry vision or strain caused by prolonged screen time. These womens blue light glasses aid in better sleep by preventing blue light from disrupting your natural sleep cycle, helping you fall asleep faster and enjoy a more restful night's sleep, making them the perfect christmas present.
  • COMFORTABLE: Crafted from durable material, our trendy blue light glasses for woman or blue light glasses men ensure long-lasting comfort. The high-transmittance lenses accessories, gamer gifts for men, help keep your eyes relaxed. Perfect stocking stuffers, gifts for gamers men, christmas gifts for men, halloween costumes.
  • LIGHTWEIGHT: These clear blue light glasses feature a lightweight frame, meaning they’ll stay comfy for long-term wear. Perfect as blue blockers glasses for women or mens blue light glasses, these non-prescription fake glasses for men can be worn throughout the day. The blue light blocking glasses women feature polycarbonate HD lenses, which are anti-reflective and restore true color.
  • WORRY-FREE PURCHASE: If you experience any issues, our support team is ready to assist you quickly. These are the perfect costume glasses for cosplay dressing up.

How to edit the file safely

  1. Stop the dedicated server cleanly. Editing while it is running can leave your changes overwritten or partially applied.
  2. Make a backup copy of both serverconfig.json and the world save before changing anything.
  3. Open the JSON file in a text editor that does not add rich-text formatting.
  4. Change one related group of settings at a time. Keep quotation marks, braces, and commas intact; JSON does not allow a trailing comma after the final property in an object.
  5. Save the file, then relaunch the server. Configuration changes do not take effect until the server is relaunched.
  6. Read the startup console for JSON or permission errors. If the server fails to start, restore the backup and reapply changes individually.

Supported values can also be changed through console or in-game commands. That approach is useful for routine changes such as the name, password, public advertising, UPnP, or whitelist mode, but it does not eliminate the need to restart for settings that are read only during startup.

Core server settings

The exact file contains comments and additional entries, but these are the settings most administrators change.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.
Setting What it controls Documented behavior or default
ServerName The name shown to players and in listings. Set a clear name that identifies the community or purpose of the server.
ServerDescription Descriptive text displayed with the server. Use it for rules, version expectations, or a short theme description.
WelcomeMessage Text displayed when a player joins. The {0} placeholder is replaced by the player’s nickname.
Ip The network interface on which the server listens. If omitted, the server listens on all interfaces. Binding to a specific address can restrict exposure to one interface.
Port The TCP/UDP game port used by the server. The documented default is 42420. A non-default port must be allowed through the host firewall and forwarded if players connect from the internet.
Upnp Whether the server attempts automatic router port forwarding. Automatic forwarding depends on router support and network policy; manual forwarding is more predictable.
AdvertiseServer Whether the server is published in the public server list. For Vintage Story 1.20 and later, public advertising is disabled by default. Set it to false for a private server.
Password A password required to join. A non-null value enables password authentication. Use a long, unique password rather than reusing an account password.
MaxClients The maximum number of simultaneous players. The documented default is 16. Higher values increase RAM and CPU requirements.
MaxChunkRadius How far around players the server keeps chunks active or available. The documented default is 12. Increasing it improves viewing or travel context at the cost of additional RAM and processing.
ClientConnectionTimeout How long a connection can take before timing out. The documented example value is 150 seconds.

Changing the port and making the server reachable

Set a different listening port

Stop the server and change the numeric Port value, for example from 42420 to another unused port. Save the file and relaunch. Players must enter the same port when connecting.

A port change has three separate pieces:

  • The Vintage Story Port setting.
  • An operating-system firewall rule allowing that port for the server process.
  • A router port-forwarding rule when players connect from outside the local network.

If Upnp is enabled, the server may request the router to create the forwarding rule automatically. UPnP can fail on locked-down routers, carrier-grade NAT, double-NAT networks, or networks where automatic mappings are disabled. In those cases, forward the chosen port manually to the host’s local IP address or use a network arrangement that provides an inbound address.

Choose an interface with Ip

Leaving Ip unset makes the server listen on all available interfaces, which is the simplest option for most hosts. Setting it to a specific local address is useful on a machine with multiple network adapters, but an incorrect or changed address can make the server appear offline. If local players can connect while remote players cannot, check the firewall and router before changing the bind address.

Rank #2
Windex Gaming Cleaning Wipes, Pre-Moistened Wipes to Instantly Clean all Gaming Gear and Electronics, Resealable Packaging for a Freshness Lock, 25 count (Pack of 1)
  • WINDEX GAMING WIPES: effortlessly clean all your gaming gear and gaming electronics in one easy step with our new Windex Gaming Wipes
  • AMMONIA FREE: our ammonia-free formula is safe to use on all of your favorite gaming equipment like consoles, headsets, controllers, screens, keyboards, and more
  • PRE-MOISTENED WIPES: each wipe instantly removes dust, dirt, and stubborn smudges and fingerprints leaving a streak-free shine
  • ANTI-STATIC: great for cleaning and wiping down your gaming gear and electronics leaving behind no visible residue
  • COMPACT RESEALABLE PACKAGE: store your pack of Windex Gaming Wipes anywhere in your home for whenever a quick and easy wipedown is needed

Passwords, public listing, and whitelisting

Password protection

Set Password to a non-null string when every connecting player should know a shared password. A password is convenient for a small private group, but it is not a substitute for per-player access control: anyone who learns it can attempt to join.

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.

Public advertising

AdvertiseServer controls publication in the public server list. Keep it false when the server is intended for invited players, internal testing, or a private community. Advertising does not by itself grant access, but it makes the endpoint easier to discover.

WhitelistMode in version 1.20 and later

Access-control names changed between versions. The Dedicated Server guide states that dedicated servers use whitelisting by default as of game version 1.20 and documents WhitelistMode values off, on, and default. The older OnlyWhitelisted field is obsolete for 1.20 onward.

For a 1.20-or-newer server, select the documented WhitelistMode behavior rather than adding the obsolete field. Then manage individual players with the player command, for example:

/player <username> whitelist on

Replace <username> with the exact in-game name. If a player still cannot join, verify the mode, spelling, password requirement, and whether the server was relaunched after the file edit.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.
Rank #3
Sale
LISEN Cell Phone Stand Phone Holder for Desk, Office Decor Gadgets for Men
  • Ergonomic & Adjustable Design: Fight "text neck" and improve your posture. Designed for comfort, it offers an adjustable height (7.1in-8.5in) (1.4in adjustable range) and angle (5°-85°) Please note: cell phone stand is only 9 inches tall—the length of a standard pencil
  • Without blocking subtitles Perfect for office desk Tiktok Face Time Zoom video—this is the ultimate kitchen desk essential for phones! Perfect viewing experience while reducing neck back strain, A must-have for gamers streamers desk, and anyone who values both style and support!
  • Sleek & Stable Design fits Otterbox Case: Say goodbye to bent cables, tangles, and tip-overs! LISEN’s stylish adjustable desk phone holder features a built-in charging hole and smart cable management, keeping your phone secure and your workspace clutter-free cool gadgets for men
  • ANTI-SLIP DESIGN free hands: The under 10.00 items easy gadgets back and the bottom of this kitchen essentials for women are fully covered by anti-skid silicone, which LISEN stand up desk decor can provide maximum protection device from any scratches and slides
  • Your Perfect Viewing Companion:If your product arrives damaged or breaks within 365 days, reach out to LISEN for a quick and hassle-free solution. Struggling with assembly, like tightening the screw? We’ve got your back! Your experience matters to us. (Product including: phone Holder stand*1, screw*1, hexagon screwdriver*1, specification*1)

Assign a default role

DefaultRoleCode determines the role given to new players. The documentation uses suplayer as the normal survival-player role and suvisitor as an example of a more restricted role. Choose the least-privileged default that fits the server, then grant elevated privileges deliberately through controlled console or startup commands.

Performance limits and capacity planning

MaxClients and MaxChunkRadius are independent settings, but both can increase resource use. A higher player limit creates more simultaneous entity, inventory, network, and simulation work. A larger chunk radius keeps more terrain active around players and therefore consumes more memory and CPU.

  • Start with the documented defaults: MaxClients: 16 and MaxChunkRadius: 12.
  • Increase one value at a time and observe memory use, tick stability, and player latency.
  • Do not treat the default player limit as a performance guarantee; the suitable value depends on hardware, world complexity, mods, and player activity.
  • If the server becomes unstable, reduce the radius or client limit before adding unrelated changes.

The ClientConnectionTimeout value shown in the official example is 150 seconds. A timeout that is too short can punish players on slow links; a very long timeout can leave dead connections around longer. Change it only when connection behavior gives you a reason.

Mods and the ModPaths setting

ModPaths tells the server where to search for mods. Keep server-side and universal mods in locations the server scans, and make sure every required version is compatible with the server’s Vintage Story version.

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

The dedicated-server documentation distinguishes how mods reach clients:

Rank #4
Ledagic IC+RGBW USB Powered Led Light Bar with App & Remote Control, 2 Pack
  • Easy Installation: Our gaming lights have been designed to enhance your entertainment experience. Simply position the led light bar next to your TV or game console to create a game room environment with ease. They come with USB power and a 60 inch cord for direct mounting and mobility
  • Audio Syncing & Extensive Mode: The built-in high-sensitivity music sensor allows you to sync the TV led lights to your favorite music. Lights react and move to the beat of music, film and game audio, creating an incredible immersive sound and light experience – and all without the need for an additional hub. You can choose from 64+ patterns, including strobe, illusion, jump, energy, gradient, running, chasing, fluttering mode etc. Each mode can be applied to different scenes
  • 64+ Chasing IC+RGB & W Effect: The independent control design of IC+RGB and white all-in-one multifunctional rgbw led bar lights monitor backlight allows you to easily switch the led lights for desk between IC+RGB and white to enjoy a variety of lighting effects, you can choose white lighting mode with high brightness for better illumination when working, etc. Choose IC+RGB lighting mode when you need to create an entertaining atmosphere for the light show, 16 million colours of Color changing rgb light bar let you dance to the beat and create a dynamic party atmosphere
  • Dynamic and Dimmable Lights: 1%-full brightness free brightness adjustment gives you the flexibility to adjust dimmable led light bar for room decorations or a variety of occasions
  • USB Powered: USB light bars for room can be powered by powernank, usb charger, TV, Monitor, laptop PC mainframe, making behind TV led lighting bar easy to install in any location.TV led lights are powered by the TV usb interface / PC mainframe, can be turned on/off synchronously with TV / PC
  • Server-side mods run only on the server.
  • Universal mods can be offered by the server for client download.
  • Client-side mods must be installed by each player separately.

A player who connects successfully but sees missing content may need a client-side installation even when the server’s ModPaths is correct. After adding or removing mods, restart the server and have players verify that their client-side set matches the server’s requirements.

Understanding WorldConfig

The nested WorldConfig object describes the save and the options used when a new world is created. Common entries include:

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.
  • SaveFileLocation: the .vcdbs save file used by the server.
  • WorldName: the world’s name.
  • WorldType: the selected world type.
  • PlayStyle: the chosen play style.
  • WorldConfiguration: world-generation and gameplay values such as game mode, climate, seasons, death punishment, days per month, and cave-ins.

Use a prepared single-player world

The most reliable way to build a customized world is to create it in single-player using the advanced world-creation options, then copy it to the server while the server is stopped. Rename the save to default.vcdbs, or set WorldConfig.SaveFileLocation to the chosen .vcdbs file. Back up the existing server save before replacing it.

New-world settings versus an existing save

Many generation values are applied when the world is created. Changing them in serverconfig.json does not regenerate terrain that already exists. For an established world, use the documented world-configuration commands where supported, and treat any generation change as a migration decision rather than a simple reload.

Independent reader supportYour contribution helps us test, update, and keep practical guides available for everyone.Support on Ko-Fi

Console commands for routine changes

When supported by the running version, these commands avoid manual JSON editing for common server properties:

Best Value
Sale
HUANUO FlowLift™ Dual Monitor Stand, Fully Adjustable Gaming Monitor Desk Mount for 13–32″ Computer Screens, Full Motion VESA 75x75/100x100 with C-Clamp & Grommet Base, Each Arm Holds 4.4 to 19.8 lbs
  • Compatible with Wide Screens - To ensure compatibility with the dual monitor mount, your each monitor must meet three conditions at the same time: First, computer screens size range: 13 to 32 inches. Second, screen weight range: 4.4 to 19.8 lbs. Third, the back of the monitor screen must have VESA mounting holes with a pitch of 75x75mm or 100x100mm.
  • Regarding the compatibility with desks - Your desk must meet three conditions at the same time: First, desk material: Only wooden desks are recommended, plastic or glass desks cannot be used. Second, desk thickness range: 0.59" - 3.54". Third, the bottom of the desk should not have any cross beams or panels, as this will interfere with installation. We recommend carefully checking that your desk and monitors meets all above conditions before purchasing.
  • Dual C-Clamp Hold - Worried your dual monitors might wobble or slip? Our upgraded base uses a larger platform plus a dual C-clamp structure to lock the dual monitor arm firmly to your desk. Each arm safely keeps your screens steady while you type, click and game—no shaking, no sliding, just a clean and secure setup you can trust every day. It also provides Grommet Mounting installation choice, both options ensure stable and secure fixation for your 0.59" - 3.54" desk.
  • Full-Motion Adjustment For Comfortable View - Pull the screen closer when you’re deep in a spreadsheet, push it back to watch videos, or rotate to portrait for coding — moving everything smoothly with just one hand. The monitor stand offers +85°/-50° tilt, ±90° swivel and 360° rotation. Raise your monitor up to 15.75″ to support a healthy sitting posture. Whether you’re working from home, gaming through the night, or switching between video calls and documents, getting the screens to your natural line of sight helps relieve neck, shoulder and back strain so you can stay focused longer with less fatigue.
  • Keep Your Desk Organized: By lifting both screens off the desktop, this dual monitor stand opens up valuable space for your keyboard, notebook, docking station or a simple, clutter-free work area. Built-in cable management guides wires along the arms, keeping cords out of sight and out of the way. Enjoy a tidy, modern workstation that looks as good as it feels to use.
  • /serverconfig name
  • /serverconfig password
  • /serverconfig advertise
  • /serverconfig upnp
  • /serverconfig WhitelistMode

Use the command’s documented syntax and confirm the resulting value in the console. If a setting is evaluated only during startup, stop and relaunch the server after issuing the command or editing the file.

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.

Troubleshooting changes that do not apply

The server starts with the old value

Confirm that you edited the active data directory, saved the file, and fully relaunched the server. A second installation, service account, container, or systemd unit may be reading a different data path.

The server will not start after editing

Validate JSON punctuation, restore the backup, and reapply the change. Typical mistakes are a missing comma between properties, an unclosed quote, a misspelled property name, or a value with the wrong type.

Players cannot connect after a port change

Check that the client uses the new port, the host firewall allows it, the router forwards it to the correct machine, and the server is listening on the intended interface. If UPnP did not create a mapping, configure forwarding manually.

Whitelist behavior is unexpected

Check the Vintage Story version first. On 1.20 and later, use WhitelistMode; do not rely on the obsolete OnlyWhitelisted field. Then verify the player’s exact username and relaunch after file changes.

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

World options appear unchanged

Determine whether the option affects only world creation. Existing terrain is not regenerated simply because an initial-generation value was edited. Use a new save or a supported world-configuration command where appropriate.

Practical security checklist

  • Use a strong, unique password when password access is enabled.
  • Leave AdvertiseServer set to false for a private server.
  • Use the version-appropriate whitelist mode and add players deliberately.
  • Grant administrator roles only through controlled console or startup commands.
  • Back up the configuration and world save before edits, migrations, or mod changes.
  • Expose only the required network port and review router forwarding rules periodically.

Self-hosting decisions that affect this file

Whether the server runs on a personal Windows machine, a Linux host, or managed infrastructure, the same operational questions matter: can you control the data path, restore backups, open or forward the port, access the console, install and synchronize mods, and allocate enough CPU and RAM for the chosen MaxClients and MaxChunkRadius? Linux administrators may also want systemd supervision and a documented update procedure. A managed host reduces routine operating-system work, while self-hosting provides direct control over files, backups, and startup commands.

Make those operational choices before tuning the JSON. A perfectly edited configuration cannot compensate for a service that starts under the wrong account, stores data in an unexpected directory, or lacks the network access required by the port setting.

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.

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

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.

More quests from Patch Notes

  1. How to Set Up a RedM (RDR2) Server in 2026: License Key, txAdmin and server.cfg, Step by StepBlog11min
  2. Best RedM (RDR2) Server Hosting in 2026: Comparing Four Hosts on Slots, Memory and PriceBlog10min
  3. How to Host a Mindustry Server in 2026: server-release.jar, Port 6567 and the Commands That MatterBlog7min
Recommended PC Tool
Recommended PC Tool
Crashes, No Sound, or Screen Glitches?Free driver scan
Windows Errors? Fix Them Before They SpreadFree repair scan

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.