Server Configuration Guide
Vintage Story offers extensive server configuration options allowing you to customize your gaming experience. This comprehensive guide covers all available settings, their effects, and how to configure them through the Supercraft panel or directly in configuration files.
Configuration Overview
Vintage Story uses JSON configuration file for server configuration. Settings can be adjusted through the Supercraft configuration panel or by editing files directly. The main configuration file is typically located at vintagestoryserver.json in your server directory.
Configuration Methods
- Supercraft Panel: User-friendly web interface with validation
- Direct File Edit: Manual JSON editing for advanced users
- Command Line: Startup parameters for temporary overrides
Basic Server Settings
| Setting | Type | Default | Description |
|---|---|---|---|
ServerName |
String | "Vintage Story Server" | `ServerName` Valid values: Server display name |
ServerDescription |
String | Empty | `ServerDescription` Valid values: Server description |
WelcomeMessage |
String | "Welcome {0}!" | `WelcomeMessage` Valid values: Join message (`{0}` = player name) |
Password |
strProp` | Empty | `Password` Valid values: Join password |
ServerLanguage |
Select | "en" | `ServerLanguage` Valid values: Server language |
World Settings
| Setting | Type | Default | Description |
|---|---|---|---|
PassTimeWhenEmpty |
Boolean | `false` | `PassTimeWhenEmpty` Valid values: Time passes when empty |
World Configuration
| Setting | Type | Default | Description |
|---|---|---|---|
PlayStyle |
Select | `surviveandbuild`, `creativebuilding`, `exploration`, `wildernesssurvival` | `WorldConfiguration.playStyle` Valid values: Game mode |
WorldType |
Select | `standard`, `superflat` | `WorldConfiguration.worldType` Valid values: World generation |
StartingClimate |
Select | Various | `WorldConfiguration.startingClimate` Valid values: Climate zone |
SpawnRadius |
Integer | 50 | `WorldConfiguration.spawnRadius` Valid values: Spawn area size |
GraceTimer |
Integer | 0 | `WorldConfiguration.graceTimer` Valid values: Grace period (days) |
DeathPunishment |
Select | `drop`, `keep`, etc. | `WorldConfiguration.deathPunishment` Valid values: Death penalty |
Security Settings
| Setting | Type | Default | Description |
|---|---|---|---|
WhitelistMode |
Select | `Default` | `WhitelistMode` Valid values: Whitelist behavior |
DefaultRoleCode |
Select | `suplayer` | `DefaultRoleCode` Valid values: Default player role |
Frequently Asked Questions
How do I set a password for my Vintage Story server?
Set a server password in the Basic Server Settings section. Enter your desired password in the 'Server Password' field. Leave it empty for a public server without password protection. Save and restart your server.
How do I set a custom world seed?
Set a custom world seed in the World Settings section before first starting your server. Enter your desired seed value in the 'World Seed' or 'Map Seed' field. Note that changing the seed after world generation will not affect existing worlds.
Why aren't my configuration changes applying?
Configuration changes require a server restart to take effect. After saving your settings in the Supercraft panel, restart your server. If changes still don't apply, verify the configuration file syntax is correct and check server logs for errors.
Can I upload a custom configuration file?
Yes, you can upload custom configuration files through the Supercraft file manager. Navigate to the configuration directory, upload your file, and restart the server. Ensure your file follows the correct format for your game.
Do I need to restart the server after changing settings?
Yes, most configuration changes require a server restart to take effect. Some games support hot-reloading for specific settings, but it's recommended to always restart after making configuration changes.
Using the Supercraft Configuration Panel
Our platform provides a user-friendly interface for managing your Vintage Story server configuration without editing files manually.
- Log in to your Supercraft panel at https://supercraft.host/my-account
- Navigate to your Vintage Story server from the deployments list
- Click the "Configuration" tab
- Adjust settings using the intuitive form controls
- Click "Save Configuration" to apply changes
- Restart your server for changes to take effect
The configuration panel validates your inputs and prevents invalid values, ensuring your server starts correctly.
Troubleshooting
Settings not applying after save
Ensure you've restarted the server after saving configuration changes. Most settings require a full server restart. Check the server logs for any configuration errors that might prevent the server from starting.
Configuration file validation errors
Verify that your configuration file follows the correct format for your game. Check for syntax errors like missing quotes, incorrect separators, or invalid values. Use the Supercraft configuration panel to validate settings before applying them.
Server won't start after config change
Revert to the previous working configuration using the Supercraft file manager's backup feature. Check server logs for specific error messages. Common issues include invalid port numbers, malformed file paths, or out-of-range numeric values.
Performance Optimization
Server Performance Settings
For optimal server performance, consider these key settings:
- Max Chunk Radius: Lower values reduce memory usage
- Simulation Distance: Controls active area size
- Entity Activation Range: Limits entity processing distance
- Auto-Save Interval: Balance between safety and performance
Network Optimization
Improve player experience with these network settings:
- Update Distance: Adjust based on player bandwidth
- Compression Level: Balance CPU usage vs bandwidth
- Client Send Rate: Control update frequency
- Timeout Settings: Configure connection stability
Advanced Configuration
Custom World Generation
Vintage Story offers extensive world customization:
- Terrain Scale: Adjust world size and feature density
- Climate Settings: Control temperature and rainfall patterns
- Resource Distribution: Customize ore and material placement
- Structure Generation: Modify village and ruin frequency
References
- Vintage Story Wiki - Server Config
- Vintage Story Wiki - Dedicated Server
- Server Startup Parameters
- World Generation Configuration
- Performance Tuning Guide