Client startup parameters

From Vintage Story Wiki
Other languages:


This page was last verified for Vintage Story version 1.15.


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

Currently implemented 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

-o, --openWorld Opens given world. If it doesn't exist it will be created

-c, --connect Connect to given server

--pw Password for the server (if any)

--rndWorld Creates a new world with a random name. Use -p modifier to set playstyle

-p, --playStyle (Default: creativebuilding) Used when creating a new world. Possible values are "creativebuilding", "preset-surviveandbuild", "preset-exploration", and "preset-wildernesssurvival"

--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


Modding
Green Items require C# coding
Basics

Getting Started | Mod Types | Simple Examples | Theme Pack

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

Advanced

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

Setting Up Your Development Environment (General - Windows - Linux)

Advanced Blocks | Advanced Items | Item-Block Interactions | Block Behavior | Block Entities | Particle Effects | World Access | Inventory Handling | Chat Commands | GUIs | Server-Client Networking | Monkey patching (Harmony)

Data Management

Savegame Data Storage | ModConfig File | Chunk Data Storage | Tree Attribute

Worldgen

WorldGen Concepts | Terrain | Ores | Trees | WorldGen API

Rendering

Shaders and Renderers

Property Overview

Item | Entity | Block | Block Behaviors | Block Classes | Block Entities | Block Entity Behaviors

Workflows & Infrastructure

Modding Efficiency Tips | Mod-engine compatibility | Mod Extensibility | Load Order

Additional Resources

List of server commands | List of client commands | Client startup parameters | Creative Starter Guide | ServerBlockTicking | Bot System | WorldEdit | Cinematic Camera

Example Mods | API Docs | GitHub Repository