Client startup parameters

From Vintage Story Wiki
Revision as of 13:47, 24 January 2022 by Mirotworez (talk | contribs) (Marked this version for translation)

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

Icon Sign.png

Wondering where some links have gone?
The modding navbox is going through some changes! Check out Navigation Box Updates for more info and help finding specific pages.

Modding
Modding Introduction Getting Started Theme Pack
Content Modding Content Mods Developing a Content Mod Basic Tutorials Intermediate Tutorials Advanced Tutorials Content Mod Concepts
Code Modding Code Mods Setting up your Development Environment
Property Overview ItemEntityEntity BehaviorsBlockBlock BehaviorsBlock ClassesBlock EntitiesBlock Entity BehaviorsCollectible BehaviorsWorld properties
Workflows & Infrastructure Modding Efficiency TipsMod-engine compatibilityMod ExtensibilityVS Engine
Additional Resources Community Resources Modding API Updates Programming Languages List of server commandsList of client commandsClient startup parametersServer startup parameters
Example ModsAPI DocsGitHub Repository