Cmdline arguments

From Platinum Arts Sandbox Free 3D Game Maker
Revision as of 08:26, 12 June 2011 by Hirato (Talk | contribs)

Jump to: navigation, search

in sandbox (and in fact, pretty much all cube 2 related projects), there are universal, server and client command line options, this is just a list of them, and their accepted values, note all arguments must be prefixed with a '-', also one big difference compared to other programs, there can be no spaces between the argument and the given value, eg -gssp

to change which arguments are used on launch by default, edit...

Windows: edit the clickhere to start bat or use the launcher
Linux: edit the sandbox_unix script, or use the launcher

Linux/FreeBSD

Script only arguments, note that all but -g use two dashes. run the script with -h, --help or -? for more information.

g - sets which game module to use, valid arguments are fps, movie or ssp
-gfps
--help - displays the help
--debug - opens debug variants of binaries inside gdb using provided arguments; the user will need to launch ti manually
--server - launches a server as opposed to a normal client (only for supported modules)
--master - starts up a masterserver as opposed to a normal client (not included by default)

Universal

m - sets which webserver to use as it's masterserver to retrieve server listings and register your server on
-mkids.platinumarts.net

client

q - sets which directory to use as home, it saves all files here
-qprofiles/anonymous
k - adds a directory as if it's in the main branch, perfect for loading mods without overwriting existing files
-kmod
r - executes a configuration file before any real loading begins, executes init.cfg if no arguments are given
-rinit.cfg
d - run the client as a dedicated server, this is already true for the server executable
w - sets the window's width, note if it can't find -h, it'll multiple this value by 3 and divide by 4 and use that as -h
-w1600
h - sets the window's height, will multiply by 4 and divide by 3 and use the new value as -w if -w can't be found
-h1200
z - sets the value for depthbits, max at 32
-z24
b - sets the colour depth, the desktop depth is used when at 0
-b32
a - sets the value for antialiasing, should be a power of two, max at 16
-a4
v - sets vsync, vsync prevents frame tearing but also caps fps at your monitor's refresh rate
-v1
t - t0 or t by itself will made the game windowed, t1 will run fullscreen
-t1
s - sets the stencil bits, a power of two, above 0 and below 32, 1 is the default
-s1
f - f0 or f by itself will run sandbox in fixed-function mode (shaders are off), if given a number (1 or 2), it'll set the shader quality to that value (with shader on of course)
-f2
l - use as the start up map instead of the game module's default
-lvillage
x - execute the cubescript string at startup
-x"musicvol 0"

server

note the servers have additional options available for each game module

u - sets the maximum upload rate, best if left at 0
-u6000
c - sets the maximum amountof clients that can connect to the server
-c12
i - sets the ip to host the server on, if you possess multiple ips, best if left alone
-i123.45.67.89

fps server

n - sets a name for the server for when it shows in someone's server list
-n"This server is awesome"
p - sets the password needed to grab admin
-p123abc
o - sets whether people can grab master with or without the need for auth
-o1

movie server

n - sets a name for the server for when it shows in someone's server list
-n"This server is awesome"
p - sets the password needed to grab admin
-pabc123
o - sets whether people can grab master with or without the need for approval
-o1