Merge 'remotes/trunk'
[0ad.git] / binaries / system / readme.txt
blobcf0720d4b0a1c0e15f061650ce0d6f3b08281f77
1 COMMAND LINE OPTIONS
3 Basic gameplay:
4 -autostart=...      load a map instead of showing main menu (see below)
5 -editor             launch the Atlas scenario editor
6 -mod=NAME           start the game using NAME mod
7 -quickstart         load faster (disables audio and some system info logging)
9 Autostart:
10 -autostart="TYPEDIR/MAPNAME"    enables autostart and sets MAPNAME; TYPEDIR is skirmishes, scenarios, or random
11 -autostart-seed=SEED            sets randomization seed value (default 0, use -1 for random)
12 -autostart-ai=PLAYER:AI         sets the AI for PLAYER (e.g. 2:petra)
13 -autostart-aidiff=PLAYER:DIFF   sets the DIFFiculty of PLAYER's AI (0: sandbox, 5: very hard)
14 -autostart-aiseed=AISEED        sets the seed used for the AI random generator (default 0, use -1 for random)
15 -autostart-civ=PLAYER:CIV       sets PLAYER's civilisation to CIV (skirmish and random maps only)
16 -autostart-team=PLAYER:TEAM     sets the team for PLAYER (e.g. 2:2).
17 -autostart-nonvisual            disable any graphics and sounds
18 -autostart-victory=SCRIPTNAME   sets the victory conditions with SCRIPTNAME located in simulation/data/settings/victory_conditions/
19 -autostart-victoryduration=NUM  sets the victory duration NUM for specific victory conditions
20 Multiplayer:
21 -autostart-playername=NAME      sets local player NAME (default 'anonymous')
22 -autostart-host                 sets multiplayer host mode
23 -autostart-host-players=NUMBER  sets NUMBER of human players for multiplayer game (default 2)
24 -autostart-client=IP            sets multiplayer client to join host at given IP address
25  Random maps only:
26 -autostart-size=TILES           sets random map size in TILES (default 192)
27 -autostart-players=NUMBER       sets NUMBER of players on random map (default 2)
29 Examples:
30 1) "Bob" will host a 2 player game on the Arcadia map:
31  -autostart="scenarios/Arcadia" -autostart-host -autostart-host-players=2 -autostart-playername="Bob"
32 2) Load Alpine Lakes random map with random seed, 2 players (Athens and Britons), and player 2 is PetraBot:
33  -autostart="random/alpine_lakes" -autostart-seed=-1 -autostart-players=2 -autostart-civ=1:athen -autostart-civ=2:brit -autostart-ai=2:petra
35 Configuration:
36 -conf=KEY:VALUE     set a config value
37 -g=F                set the gamma correction to 'F' (default 1.0)
38 -nosound            disable audio
39 -noUserMod          disable loading of the user mod
40 -shadows            enable shadows
41 -vsync              enable VSync, i.e. lock FPS to monitor refresh rate
42 -xres=N             set screen X resolution to 'N'
43 -yres=N             set screen Y resolution to 'N'
45 Advanced / diagnostic:
46 -version            print the version of the engine and exit
47 -dumpSchema         creates a file entity.rng in the working directory, containing
48                       complete entity XML schema, used by various analysis tools
49 -entgraph           (disabled)
50 -listfiles          (disabled)
51 -profile=NAME       (disabled)
52 -replay=PATH        non-visual replay of a previous game, used for analysis purposes
53                       PATH is system path to commands.txt containing simulation log
54 -replay-visual=PATH visual replay of a previous game, used for analysis purposes
55                       PATH is system path to commands.txt containing simulation log
56 -writableRoot       store runtime game data in root data directory
57                       (only use if you have write permissions on that directory)
58 -ooslog             dumps simulation state in binary and ASCII representations each turn,
59                     files created in sim_log within the game's log folder. NOTE: game will
60                     run much slower with this option!
61 -serializationtest  checks simulation state each turn for serialization errors; on test
62                     failure, error is displayed and logs created in oos_log within the
63                     game's log folder. NOTE: game will run much slower with this option!
64 -rejointest=N       simulates a rejoin and checks simulation state each turn for serialization
65                     errors; this is similar to a serialization test but much faster and
66                     less complete. It should be enough for debugging most rejoin OOSes.
67 -unique-logs        adds unix timestamp and process id to the filename of mainlog.html, interestinglog.html
68                     and oos_dump.txt to prevent these files from becoming overwritten by another pyrogenesis process.
70 Windows-specific:
71 -wQpcTscSafe        allow timing via QueryPerformanceCounter despite the fact
72                     that it's using TSC and it may be unsafe. has no effect if
73                     a better timer (i.e. the HPET) is available.
74                     should only be specified if:
75                     - you are sure your system does not engage in
76                       thermal throttling (including STPCLK) OR
77                     - an "RDTSC patch" is installed
78                     this flag is also useful if all other alternatives are worse
79                     than a potentially risky or slightly broken TSC-based QPC.
81 -wNoMahaf           prevent any physical memory mapping or direct port I/O.
82                     this disables all ACPI-related code and thus some of the
83                     timer backends. specify this if problems are observed with
84                     one of the abovementioned subsystems.
86 Archive builder:
87 -archivebuild=PATH            system PATH of the base directory containing mod data to be archived/precached
88                                 specify all mods it depends on with -mod=NAME
89 -archivebuild-output=PATH     system PATH to output of the resulting .zip archive (use with archivebuild)
90 -archivebuild-compress        enable deflate compression in the .zip
91                                 (no zip compression by default since it hurts compression of release packages)