Command line arguments

From Soldat Community Wiki
Jump to: navigation, search

Command Line Arguments for Soldat Client (soldat.exe)

These are parameters that can be used when running soldat.exe:

  • soldat.exe -dedicated Starts a Soldat dedicated server.

  • soldat.exe -start Starts the game without entering the menu.

  • soldat.exe -join ip_address [port [password]] Runs the game and connects to ip_address (port and password are optional).

  • soldat.exe -joinurl server_url Runs the game and connects to server_url, which should have a format of Soldat URI (soldat://ip_address:port/password).
 soldat.exe -join
 soldat.exe -join 23073 tikikaka
 soldat.exe -joinurl soldat://

  • soldat.exe -demo name (freecam speed notexts extract) Runs the game and plays the demo specified by name. Optional parameters are:
    • freecam (0/1) - the user can freely change the camera (default 1)
    • speed (0-...%)- how quick the playback will be specified in percents (default 100%)
    • notexts (0/1) - no texts, menus or cursor will be displayed during playback (default 0)
    • extract (0/1) - extracts the demo to BMP files (default 0). Later they can be used to make an AVI file in a program like "Bmp2Avi".
    • The sound can be extracted with a program like "Total Recorder". Please note that this can take time and is not recommended on slower systems. For better results specify lower speed (like 50%).
 soldat.exe -demo demo12
 soldat.exe -demo demo19 1 200 1 0

  • soldat.exe -mod xxx Starts the game with a Soldat mod located in Soldat\mods\xxx

Commands Line Arguments for Soldatserver

When running your server from the command line, you can take advantage of what is known as command line arguments.

This is, basically, sending data to the binary on-the-fly from the interpreter (shell), such as MS-DOS or bash.

  • -d

Usage: ./soldatserver -d
Starts your server as a Daemon (runs in the background, even when you log off). Linux only.

  • -pid

Usage: ./soldatserver -pid
Sets the Process ID file name. Located in the /logs/ folder ( by default).

  • -m

Usage: ./soldatserver -m xx.txt
Sets the default mapslist file to xx.txt (mapslist.txt by default).

  • -c

Usage: ./soldatserver -c x.ini
Sets the default configuration file to x.ini (Soldat.ini by default).

  • -p

Usage: ./soldatserver -p 23073
Start the server on a specific port.

  • -l

Usage: ./soldatserver -l 12
Limits the number of players that can join the server.

  • -k

Usage: ./soldatserver -k "my clan only"
Sets a password that will be required by anyone who tries to join.

  • -b

Usage: ./soldatserver -b ""
Binds the server to a specific IP Address. Use with caution! You cannot bind to an IP that isn't assigned to your network card!

  • -s

Usage: ./soldatserver -s #
Enable/Disable the SoldatServer Scripting Engine. #: 1 = enabled, 0 = disabled.

  • -safe

Usage: ./soldatserver -safe #
Enable/Disable Safe Mode for Scripts (On by default). #: 1 = enabled, 0 = disabled.

  • -lock

Usage: ./soldatserver -lock #
Enable/Disable Locked Mode (Off by default). When Locked Mode is enabled, admins will not be able to type /loadcon, /password or /maxplayers. #: 1 = enabled, 0 = disable$

  • -disallow

Usage: ./soldatserver -disallow "GetURL,ReadFile"
Disable certain script functions from being used by scripts. Note that this will cause any scripts that use these functions to crash with an "unknown identifier GetURL" error.

  • -debug

Usage: ./soldatserver -debug #
Enable/Disable Debug Mode (See Debug_Mode in soldat.ini). #: 0 = No Debug, 1 = Lobby Debug, 2 = Advanced Debug, 3 = Script Core Debug If you find a bug and report it, please use Debug Mode 2. It helps us alot.

  • -ns

Usage: ./soldatserver -ns
Set the Nameserver your Soldat Server will use to resolve the Lobby DNS. Only use this if you know what you are doing! The server should automatically detect what Nameserver your computer uses!

  • -ls

Usage: ./soldatserver -ls #
Set the maximum number of scripts which can be loaded by this server.