Server startup parameters

From Vintage Story Wiki
This page contains changes which are not marked for translation.

This page was last verified for Vintage Story version 1.19.

Other languages:

To get a list of all the startup parameters (command line arguments) currently implemented, go to your game directory and call VintageStoryServer.exe --help. Parameters with multiple values can be supplied with the values separated by space, for example: VintageStoryServer.exe --addModPath="path/to/dir1" "path/to/dir2"

Currently implemented server startup parameters are:

-v, --version Print game version and exit

-h, --help Print help info and exit

--tracelog Print log also via Trace.WriteLine() to get it to show up in the visual studio output window

--append Do not overwrite log files

--genconfig Generate a new default serverconfig.json and exit. Warning, this deletes any existing config.

--setconfig Set a config value. Generates a serverconfig.json if it doesn't exist. Use the format --setconfig="{ key: 3, foo:'value' }"

--withconfig Can be used to override any config value. Launches the server. Use the format --setconfig="{ key: 3, foo: 'value' }"

--dataPath Set a custom data path, default is Environment.SpecialFolder.ApplicationData

--logPath Default logs folder is in dataPath/Logs/. This option can only set an absolute path.

--addOrigin Tells the asset manager to also load assets from this path

--addModPath Tells the mod loader to also load mods from this path

--ip Bind server to given ip, overwrites configured value (default: all ips)

--port Bind server to given port, overwrites configured value (default: 42420)

--maxclients Maximum quantity of clients to be connected at the same time, overwrites configured value (default 16)

--help Display this help screen.

--version Display version information.


Modding
Green Items require C# coding
Basics

Getting Started | Basic Examples | Theme Pack

Asset System | Textures | Items | Recipes | Blocks | Entities | Model Creator | Animation Basics | VTML & Icons | Packaging & Release | Modinfo | Debugging

Advanced

JSON Patching | Advanced JSON Item | The Remapper | Server-Client Considerations | Compatibility with other mods

Setting up your Development Environment

Advanced Blocks | Advanced Items | Block and Item Interactions | Block Behavior | Block Entity | Particle Effects | World Access | Inventory Handling | Commands | GUIs | Network API | Monkey patching (Harmony)

Data Management

Savegame Data Storage | ModConfig File | Chunk Data Storage | TreeAttribute

Worldgen

WorldGen Concepts | Terrain | Ores | Trees | WorldGen API | NatFloat | EvolvingNatFloat | Json Random Generator

Rendering

Shaders and Renderers

Property Overview

Item | Entity | Block | Block Behaviors | Block Classes | Block Entities | Block Entity Behaviors | World properties

Workflows & Infrastructure

Modding Efficiency Tips | Mod-engine compatibility | Mod Extensibility | VS Engine

Additional Resources

List of server commands | List of client commands | Client startup parameters | Server startup parameters | Creative Starter Guide | ServerBlockTicking | Bot System | WorldEdit | Cinematic Camera | Adjustable FPS Video Recording

Example Mods | API Docs | GitHub Repository