Server startup parameters: Difference between revisions

From Vintage Story Wiki
No edit summary
m (Updated game version and extra startup params.)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
{{GameVersion|1.18.15}}
{{GameVersion|1.19}}
<languages/><translate>
<languages/><translate>
<!--T:1-->
To get a list of all the startup parameters (command line arguments) currently implemented, go to your game directory and call <code>VintageStoryServer.exe --help</code>. Parameters with multiple values can be supplied with the values separated by space, for example: <code>VintageStoryServer.exe --addModPath="path/to/dir1" "path/to/dir2"</code>
To get a list of all the startup parameters (command line arguments) currently implemented, go to your game directory and call <code>VintageStoryServer.exe --help</code>. Parameters with multiple values can be supplied with the values separated by space, for example: <code>VintageStoryServer.exe --addModPath="path/to/dir1" "path/to/dir2"</code>


<!--T:2-->
Currently implemented server startup parameters are:
Currently implemented server startup parameters are:


<!--T:3-->
<code>-v, --version</code> Print game version and exit
<code>-v, --version</code> Print game version and exit


<!--T:4-->
<code>-h, --help</code> Print help info and exit
<code>-h, --help</code> Print help info and exit


<!--T:5-->
<code>--tracelog</code> Print log also via Trace.WriteLine() to get it to show up in the visual studio output window
<code>--tracelog</code> Print log also via Trace.WriteLine() to get it to show up in the visual studio output window


<!--T:6-->
<code>--append</code> Do not overwrite log files
<code>--append</code> Do not overwrite log files


<!--T:7-->
<code>--genconfig</code> Generate a new default serverconfig.json and exit. Warning, this deletes any existing config.
<code>--genconfig</code> Generate a new default serverconfig.json and exit. Warning, this deletes any existing config.


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


<code>--withconfig</code> Can be used to override any config value. Launches the server. Use the format --setconfig="{ key: 3, foo: 'value' }"
<!--T:9-->
<code>--dataPath</code> Set a custom data path, default is Environment.SpecialFolder.ApplicationData
<code>--dataPath</code> Set a custom data path, default is Environment.SpecialFolder.ApplicationData


<!--T:10-->
<code>--logPath</code> Default logs folder is in dataPath/Logs/. This option can only set an absolute path.
<code>--logPath</code> Default logs folder is in dataPath/Logs/. This option can only set an absolute path.


<!--T:11-->
<code>--addOrigin</code> Tells the asset manager to also load assets from this path
<code>--addOrigin</code> Tells the asset manager to also load assets from this path


<!--T:12-->
<code>--addModPath</code> Tells the mod loader to also load mods from this path
<code>--addModPath</code> Tells the mod loader to also load mods from this path


<!--T:13-->
<code>--ip</code> Bind server to given ip, overwrites configured value (default: all ips)
<code>--ip</code> Bind server to given ip, overwrites configured value (default: all ips)


<!--T:14-->
<code>--port</code> Bind server to given port, overwrites configured value (default: 42420)
<code>--port</code> Bind server to given port, overwrites configured value (default: 42420)


<!--T:15-->
<code>--maxclients</code> Maximum quantity of clients to be connected at the same time, overwrites configured value (default 16)
<code>--maxclients</code> Maximum quantity of clients to be connected at the same time, overwrites configured value (default 16)


<!--T:16-->
<code>--help</code> Display this help screen.
<code>--help</code> Display this help screen.


<!--T:17-->
<code>--version</code> Display version information.
<code>--version</code> Display version information.
</translate>
</translate>
{{Navbox/modding|Vintage Story}}{{Game navbox}}
{{Navbox/modding|Vintage Story}}{{Game navbox}}

Latest revision as of 16:46, 19 February 2024

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.

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 ItemEntityBlockBlock BehaviorsBlock ClassesBlock EntitiesBlock Entity 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


Wiki Navigation
Vintage Story Guides[[::Category:Guides| ]]Frequently Asked Questions Soundtrack Versions Controls
Game systems Crafting Knapping Clay forming Smithing Cooking Temperature Hunger Mining Temporal stability Mechanical power Trading Farming Animal husbandry
World World generation Biomes Weather Temporal storms
Items Tools Weapons Armor Clothing Bags Materials Food
Blocks Terrain Plants Decorative Lighting Functional Ore
Entities Hostile entities Animals NPCs Players
Miscellaneous List of client commands List of server commands Creative Starter Guide Bot System WorldEdit Cinematic Camera Adjustable FPS Video Recording ServerBlockTicking