Startup parameters: Difference between revisions

Latest revision as of 15:51, 25 April 2024

This page has been revised for the current stable version (41.78.16).

Help by adding any missing content. [edit]

Project Zomboid has customizable startup parameters, as either JVM arguments or game arguments. This can be used to override "vmArgs" in the .json file. JVM arguments must end with a --, even if there are no game arguments.

Create shortcut

Navigate to the game folder
With Microsoft Windows 10, found in Program Files (x86):
C:\Program Files (x86)\Steam\steam\games
Create a shortcut of the executable file (ProjectZomboid32.exe/ProjectZomboid64.exe)
Add the appropriate JVM arguments in the "Target:" line
Example: C:\ProjectZomboid64.exe -Xmx1024m -Xms1024m -- -nosteam

Steam application

Right-click the game in the Library
Select "Properties..."
Add desired options under "LAUNCH OPTIONS"

StartServer64.bat Parameters

Open the StartServer64.bat file with a text editor
Add any appropriate JVM arguments after the -Xmx line in the .bat contents
Add any appropriate Game Parameters after the %1 %2 text inside the .bat contents, which is at the end of the file before PAUSE.

Examples:

-Xmx16g -Duser.home=C:\Zomboid

%1 %2 -nosteam -servername MySecondServer -adminpassword YourPasswdXYZ

Game arguments

Client & server

Arguments	Description	Example
`-nosteam`	Disables Steam integration on client/server.
`-cachedir=<path>`	Sets the path for the game data cache dir.	`-cachedir="C:\Zomboid`"
`-modfolders`	Option to control where mods are loaded from. Any of the 3 keywords may be left out and may appear in any order.	`-modfolders workshop,steam,mods`
`-debug`	Launches the game in the debug mode.

Client

Arguments	Description	Example
`+connect <ip:port>`	Server address to connect, when joining a server using Steam.	`+connect 127.0.0.1:16261`
`+password <password>`	Server password to connect, when joining a server using Steam.	`+password ServersPassword`
`-debugtranslation`	Writes possible translation issues to homedir "/Zomboid/translationProblems.txt"
`-safemode`	Launches the game with reduced resolution and disables some graphical effects to reduce strain on lower-end graphics cards.
`-nosound`	Disables the game audio

Server

Arguments	Description	Example
`-adminpassword`	Option to bypasses the enter-a-password prompt when creating a server.	`-adminpassword YourPasswdXYZ`
`-servername`	You can choose a different servername by using this option when starting the server.	`-servername MySecondServer`
`-ip <ip>`	Option to handle multiple network cards. Example:	`-ip 127.0.0.1`
`-port <port>`	Option which overrides the .ini option "DefaultPort".	`-port 16261`
`-udpport <port>`	Option which overrides the .ini option "UDPPort".	`-port 16262`
`-steamvac <true/false>`	Option to enable/disable VAC on Steam servers. On the server command-line use -steamvac true/false. In the server's INI file, use SteamVAC=true/false.
`-steamport1 <port>` `-steamport2 <port>`	Steam servers require two additional ports to function (I'm guessing they are both UDP ports, but you may need TCP as well). These are in addition to the DefaultPort= setting. These can be specified in two ways: In the server's INI file as SteamPort1= and SteamPort2=. Using command-line options -steamport1 and -steamport2.

JVM arguments

Client & server

Arguments	Description	Example
`-Xmx`	Maximum amount of Memory. (1024m=1Gig, 2048m=2Gig, 4096m=4Gig)	`-Xmx1024m`
`-Xms`	Initial/Minimum Memory allocation. (1024m=1Gig, 2048m=2Gig, 4096m=4Gig)	`-Xms1024m`
`-Dzomboid.steam=<boolean>`	Disables/enables Steam integration on client/server. (0=disabled, 1=enabled)	`-Dzomboid.steam=1`
`-Duser.home=<path>`	overwrites the "/Zomboid" homedir to whatever path you want.	`-Duser.home=C:\Zomboid`
`-Dsoftreset`	option to perform a soft reset (this does not work as of 41.78.16, the issue was reported and most likely be fixed in future versions^[1]
`-Ddebug`	enables debugging

Server

Arguments	Description	Example
`-Dorg.sqlite.lib.path=<path>`	Windows users: When the Server starts, a temporary sqlite file will be created in "TEMP", however it will not be deleted after stopping the Server. A way to avoid this is by adding a JVM option `-Dorg.sqlite.lib.path=natives` and put a copy of the .dll called sqlitejdbc.dll in the server's natives/ directory. It will then use that one instead of extracting the .dll from the .jar file every time.	`-Dorg.sqlite.lib.path=natives`

References

↑ Dedicated Server Soft Reset :: Project Zomboid General Discussions

@@ Line 1: / Line 1: @@
-{{languages}}
+{{Header|Project Zomboid|Multiplayer}}
-<div style="float:right;"> __TOC__ </div>
+{{Page version|41.78.16}}
-Project Zomboid has customisable '''startup parameters''', as either JVM arguments or game arguments. This can be used to override "vmArgs" in the .json file. JVM arguments must end with a <code>--</code>, even if there are no game arguments.
+{{toc|right}}
+Project Zomboid has customizable '''startup parameters''', as either JVM arguments or game arguments. This can be used to override "vmArgs" in the .json file. JVM arguments must end with a <code>--</code>, even if there are no game arguments.
 ;Create shortcut:
-# Navigate to the game folder
+#Navigate to the game folder<br>With Microsoft Windows 10, found in Program Files (x86):<br>C:\Program Files (x86)\Steam\steam\games
-# Create a shortcut of the executable file (ProjectZomboid32.exe/ProjectZomboid64.exe)
+#Create a shortcut of the executable file (ProjectZomboid32.exe/ProjectZomboid64.exe)
-# Add the appropriate Jvm arguments in the "Target:" line<br>Example: <code>C:\ProjectZomboid64.exe -Xmx1024m -Xms1024m -- -nosteam</code>
+#Add the appropriate JVM arguments in the "Target:" line<br>Example: <code>C:\ProjectZomboid64.exe -Xmx1024m -Xms1024m -- -nosteam</code>
-;Steam application:
+;[[Steam]] application:
-# Choose the game shortcut in Steam Library
+#Right-click the game in the Library
-# Right-click the game
+#Select "Properties..."
-# Select "Properties"
+#Add desired options under "LAUNCH OPTIONS"
-# Hit "Set launch options..."
+;StartServer64.bat Parameters:
+#Open the StartServer64.bat file with a text editor
+#Add any appropriate JVM arguments after the -Xmx line in the .bat contents
+#Add any appropriate Game Parameters after the %1 %2 text inside the .bat contents, which is at the end of the file before PAUSE.
+Examples:
+<code>-Xmx16g -Duser.home=C:\Zomboid</code>
+<code>%1 %2 -nosteam -servername MySecondServer -adminpassword YourPasswdXYZ</code>
 ==Game arguments==
+===Client & server===
-===Client & Server===
+{| class="wikitable theme-blue"
-{| class="pztable-com"
 |-
 ! Arguments
-! width="50%" | Description
+! style="width: 50%;" | Description
 ! Example
 |-
 | <code>-nosteam</code>
 | Disables Steam integration on client/server.
 |
 |-
 | <code>-cachedir=<path></code>
 | Sets the path for the game data cache dir.
-| <code>-cachedir=C:\Zomboid</code>
+| <code>-cachedir="C:\Zomboid</code>"
 |-
 | <code>-modfolders</code>
@@ Line 37: / Line 46: @@
 |-
 | <code>[[Debug mode|-debug]]</code>
-| Launches the game in debug mode.
+| Launches the game in the [[debug mode]].
 |
 |}
 ===Client===
-{| class="pztable-com"
+{| class="wikitable theme-blue"
 |-
 ! Arguments
-! width="50%" | Description
+! style="width: 50%;" | Description
 ! Example
 |-
 | <code>+connect <ip:port></code>
 | Server address to connect, when joining a server using Steam.
 | <code>+connect 127.0.0.1:16261</code>
 |-
 | <code>+password <password></code>
 | Server password to connect, when joining a server using Steam.
 | <code>+password ServersPassword</code>
 |-
 | <code>-debugtranslation</code>
 | Writes possible translation issues to homedir "/Zomboid/translationProblems.txt"
 |
 |-
 | <code>-safemode</code>
 | Launches the game with reduced resolution and disables some graphical effects to reduce strain on lower-end graphics cards.
 |
 |-
 | <code>-nosound</code>
 | Disables the game audio
 |
 |}
 ===Server===
-{| class="pztable-com"
+{| class="wikitable theme-blue"
 |-
 ! Arguments
-! width="50%" | Description
+! style="width: 50%;" | Description
 ! Example
 |-
 | <code>-adminpassword</code>
 | Option to bypasses the enter-a-password prompt when creating a server.
 | <code>-adminpassword YourPasswdXYZ</code>
 |-
 | <code>-servername</code>
 | You can choose a different servername by using this option when starting the server.
 | <code>-servername MySecondServer</code>
 |-
 | <code>-ip <ip></code>
 | Option to handle multiple network cards. Example:
 | <code>-ip 127.0.0.1</code>
 |-
 | <code>-port <port></code>
 | Option which overrides the .ini option "DefaultPort".
 | <code>-port 16261</code>
+|-
+| <code>-udpport <port></code>
+| Option which overrides the .ini option "UDPPort".
+| <code>-port 16262</code>
 |-
 | <code>-steamvac <true/false></code>
 | Option to enable/disable VAC on Steam servers. On the server command-line use -steamvac true/false. In the server's INI file, use SteamVAC=true/false.
 |
 |-
 | <code>-steamport1 <port></code> <br> <code>-steamport2 <port></code>
 | Steam servers require two additional ports to function (I'm guessing they are both UDP ports, but you may need TCP as well). These are in addition to the DefaultPort= setting. These can be specified in two ways: In the server's INI file as SteamPort1= and SteamPort2=. Using command-line options -steamport1 and -steamport2.
 |
-|-
 |}
 ==JVM arguments==
+===Client & server===
-===Client & Server===
+{| class="wikitable theme-blue"
-{| class="pztable-com"
 |-
 ! Arguments
-! width="50%" | Description
+! style="width: 50%;" | Description
 ! Example
 |-
@@ Line 124: / Line 135: @@
 |-
 | <code>-Duser.home=<path></code>
 | overwrites the "/Zomboid" homedir to whatever path you want.
 | <code>-Duser.home=C:\Zomboid</code>
 |-
 | <code>-Dsoftreset</code>
-| option to perform a Soft Reset
+| option to perform a soft reset (this does not work as of {{Current version|stable}}, the issue was reported and most likely be fixed in [[Build 42|future versions]]<ref>[https://steamcommunity.com/app/108600/discussions/0/3191367619812018387/ Dedicated Server Soft Reset :: Project Zomboid General Discussions]</ref>
 |
 |-
 | <code>-Ddebug</code>
 | enables debugging
 |
-|-
 |}
 ===Server===
-{| class="pztable-com"
+{| class="wikitable theme-blue"
 |-
 ! Arguments
-! width="50%" | Description
+! style="width: 50%;" | Description
 ! Example
 |-
@@ Line 147: / Line 157: @@
 | '''Windows users:''' When the Server starts, a temporary sqlite file will be created in "TEMP", however it will not be deleted after stopping the Server. A way to avoid this is by adding a JVM option <code>-Dorg.sqlite.lib.path=natives</code> and put a copy of the .dll called sqlitejdbc.dll in the server's natives/ directory. It will then use that one instead of extracting the .dll from the .jar file every time.
 | <code>-Dorg.sqlite.lib.path=natives</code>
-|-
 |}
+==References==
+<references />
+==See also==
+{{Navbox modding}}
 [[Category:Multiplayer]]