8dfbd04
.TH 0AD "6" "Sep 24 2022" "0ad 0.0.26 Zhuangzi" "User Commands"
b8284a1
b8284a1
.SH NAME
8dfbd04
0ad \- manual page for 0ad 0.0.26 Zhuangzi
b8284a1
.SH SYNOPSIS
b8284a1
.B 0ad
b8284a1
[\fIoptions\fR]
b8284a1
.SH DESCRIPTION
b8284a1
0 A.D. (pronounced "zero ey-dee") is a free, open-source, cross-platform
b8284a1
real-time strategy (RTS) game of ancient warfare. In short, it is a
b8284a1
historically-based war/economy game that allows players to relive or rewrite
b8284a1
the history of Western civilizations, focusing on the years between 500 B.C.
b8284a1
and 500 A.D. The project is highly ambitious, involving state-of-the-art 3D
b8284a1
graphics, detailed artwork, sound, and a flexible and powerful custom-built
b8284a1
game engine.
b8284a1
b8284a1
The game has been in development by Wildfire Games (WFG), a group of volunteer,
b8284a1
hobbyist game developers, since 2001.
b8284a1
.PP
b8284a1
Basic gameplay:
b8284a1
.TP
2ed0214
\fB\-autostart\fR=...
b8284a1
load a map instead of showing main menu (see below)
b8284a1
.TP
b8284a1
\fB\-editor\fR
b8284a1
launch the Atlas scenario editor
b8284a1
.TP
2ed0214
\fB\-mod\fR=\fINAME\fR
b8284a1
start the game using \fINAME\fR mod
b8284a1
.TP
b8284a1
\fB\-quickstart\fR
b8284a1
load faster (disables audio and some system info logging)
b8284a1
b8284a1
.PP
b8284a1
Autostart:
b8284a1
.TP
2ed0214
\fB\-autostart\fR="\fITYPEDIR\fR/\fIMAPNAME\fR"
2ed0214
enables autostart and sets \fIMAPNAME\fR; \fITYPEDIR\fR is \fIskirmishes\fR,
2ed0214
\fIscenarios\fR, or \fIrandom\fR
b8284a1
.TP
3dbdf1f
\fB\-autostart-seed\fR=\fISEED\fR:\fIAI\fR
3dbdf1f
sets randomozation seed value (default 0, use -1 for random)
3dbdf1f
.TP
b8284a1
\fB\-autostart-ai\fR=\fIPLAYER\fR:\fIAI\fR
2ed0214
sets the \fIAI\fR for \fIPLAYER\fR (e.g. 2:petra)
5d924be
.TP
3dbdf1f
\fB\-autostart-aidiff\fR=\fIPLAYER\fR:\fIDIFF\fR
3dbdf1f
sets the \fIDIFF\fRiculty of \fIPLAYER\fR's \fIAI\fR (0: sandbox, 5: very hard)
3dbdf1f
.TP
3dbdf1f
\fB\-autostart-aiseed\fR=\fIAISEED\fR
3dbdf1f
sets the seed used for the \fIAI\fR random generator (default 0, use -1 for
3dbdf1f
random)
2ed0214
.TP
3dbdf1f
\fB\-autostart-civ\fR=\fIPLAYER\fR:\fICIV\fR
2ed0214
sets \fIPLAYER\fR's civilisation to \fICIV\fR (skirmish and random maps only)
b821e70
.TP
3dbdf1f
\fB\-autostart-team\fR=\fIPLAYER\fR:\fITEAM\fR
3dbdf1f
sets the team for \fIPLAYER\fR (e.g. 2:2).
3dbdf1f
.TP
3dbdf1f
\fB\-autostart-ceasefire\fR=\fINUM\fR
3dbdf1f
sets a ceasefire duration \fINUM\fR (default 0 minutes)
3dbdf1f
.TP
3dbdf1f
\fB\-autostart-nonvisual\fR
3dbdf1f
disable any graphics and sounds
3dbdf1f
.TP
3dbdf1f
\fB\-autostart-victory\fR=\fISCRIPTNAME\fR
3dbdf1f
sets the victory conditions with \fISCRIPTNAME\fR located in
3dbdf1f
simulation/data/settings/victory_conditions/ (default conquest). When the
3dbdf1f
first given \fISCRIPTNAME\fR is "endless", no victory conditions will apply.
3dbdf1f
.TP
3dbdf1f
\fB\-autostart-wonderduration\fR=\fINUM\fR
3dbdf1f
sets the victory duration \fINUM\fR for wonder victory condition (default
3dbdf1f
10 minutes)
3dbdf1f
3dbdf1f
.TP
3dbdf1f
\fB\-autostart-relicduration\fR=\fINUM\fR
3dbdf1f
sets the victory duration \fINUM\fR for relic victory condition (default
3dbdf1f
10 minutes)
3dbdf1f
.TP
3dbdf1f
\fB\-autostart-reliccount\fR=\fINUM\fR
3dbdf1f
sets the number of relics for relic victory condition (default 2 relics)
3dbdf1f
.TP
3dbdf1f
\fB\-autostart-disable-replay\fR
3dbdf1f
disable saving of replays
b8284a1
b8284a1
.PP
b8284a1
Multiplayer:
b8284a1
.TP
b8284a1
\fB\-autostart-playername\fR=\fINAME\fR
2ed0214
sets local player \fINAME\fR (default 'anonymous')
b8284a1
.TP
b8284a1
\fB\-autostart-host\fR
2ed0214
sets multiplayer host mode
b8284a1
.TP
2ed0214
\fB\-autostart-host-players\fR=\fINUMBER\fR
2ed0214
sets \fINUMBER\fR of human players for multiplayer games (default 2)
b8284a1
.TP
2ed0214
\fB\-autostart-client\fR=\fIIP\fR
2ed0214
sets multiplayer client to join host host at given \fIIP\fR address
b8284a1
b8284a1
.PP
b8284a1
Random maps only:
b8284a1
.TP
b8284a1
\fB\-autostart-size\fR=\fITILES\fR
2ed0214
sets random map size in \fITILES\fR (default 192)
b8284a1
.TP
b8284a1
\fB\-autostart-players\fR=\fINUMBER\fI
2ed0214
sets \fINUMBER\fR of players on random map (default 2)
b8284a1
b8284a1
.PP
3dbdf1f
RL client:
3dbdf1f
.TP
3dbdf1f
\fB\-rl-interface\fR
3dbdf1f
Run the RL interface (see source/tools/rlclient)
3dbdf1f
3dbdf1f
.PP
b8284a1
Configuration:
b8284a1
.TP
2ed0214
\fB\-conf\fR=\fIKEY\fR:\fIVALUE\fR
2ed0214
set a config value
b8284a1
.TP
b8284a1
\fB\-nosound\fR
b8284a1
disable audio
b8284a1
.TP
5d924be
\fB-noUserMod\fR
5d924be
disable loading of the user mod
b8284a1
.TP
b8284a1
\fB\-shadows\fR
b8284a1
enable shadows
b8284a1
.TP
b8284a1
\fB\-vsync\fR
b8284a1
enable VSync, i.e. lock FPS to monitor refresh rate
b8284a1
.TP
b8284a1
\fB\-xres\fR=\fIN\fR
b8284a1
set screen \fIX\fR resolution to '\fIN\fR'
b8284a1
.TP
b8284a1
\fB\-yres\fR=\fIN\fR
b8284a1
set screen \fIY\fR resolution to '\fIN\fR'
b8284a1
b8284a1
.PP
3dbdf1f
Installing modes:
3dbdf1f
\fBPATHS\fR
3dbdf1f
install mods located at \fIPATHS\fR. For instance:
3dbdf1f
"./pyrogenesis mod1.pyromod mod2.zip"
3dbdf1f
3dbdf1f
.PP
b8284a1
Advanced / diagnostic:
b8284a1
.TP
3dbdf1f
\fB\-version\fR
3dbdf1f
print the version of the engine and exit
3dbdf1f
.TP
b8284a1
\fB\-dumpSchema\fR
5d924be
creates a file \fIentity.rng\fR in the working directory, containing
b8284a1
complete entity XML schema, used by various analysis tools
b8284a1
.TP
93b350a
\fB\-entgraph\fR
93b350a
(disabled)
93b350a
.TP
93b350a
\fB\-listfiles\fR
93b350a
(disabled)
93b350a
.TP
93b350a
\fB\-profile\fR=\fINAME\fR
93b350a
(disabled)
93b350a
.TP
b8284a1
\fB\-replay\fR=\fIPATH\fR
b8284a1
non-visual replay of a previous game, used for analysis purposes
2ed0214
\fIPATH\fR is system path to \fIcommands.txt\fR containing simulation log
b8284a1
.TP
3dbdf1f
.TP
3dbdf1f
\fB\-replay-visual\fR=\fIPATH\fR
3dbdf1f
visual replay of a previous game, used for analysis purposes
3dbdf1f
\fIPATH\fR is system path to \fIcommands.txt\fR containing simulation log
3dbdf1f
.TP
b8284a1
\fB\-writableRoot\fR
b8284a1
store runtime game data in root data directory
b8284a1
(only use if you have write permissions on that directory)
93b350a
.TP
93b350a
\fB\-ooslog\fR
93b350a
dumps simulation state in binary and ASCII representations each turn,
341ea6d
files created in sim_log within the game's log folder. \fBNOTE\fR: game will
93b350a
run much slower with this option!
93b350a
.TP
93b350a
\fB-serializationtest\fR
93b350a
checks simulation state each turn for serialization errors; on test
93b350a
failure, error is displayed and logs created in oos_log within the
93b350a
game's log folder. \fBNOTE\fR: game will run much slower with this option!
3dbdf1f
.TP
3dbdf1f
\fB\-rejointest\fR=\fIN\fR
3dbdf1f
simulates a rejoin and checks simulation state each turn for serialization
3dbdf1f
errors; this is similar to a serialization test but much faster and
3dbdf1f
less complete. It should be enough for debugging most rejoin OOSes.
3dbdf1f
.TP
3dbdf1f
\fB\-unique-logs\fR
3dbdf1f
adds unix timestamp and process id to the filename of mainlog.html,
3dbdf1f
interestinglog.html and oos_dump.txt to prevent these files from becoming
3dbdf1f
overwritten by another pyrogenesis process.
3dbdf1f
.TP
8dfbd04
\fB\-hashtest-full\fR=\fIX\fR
3dbdf1f
whether to enable computation of full hashes in replaymode (default true).
3dbdf1f
Can be disabled to improve performance.
3dbdf1f
.TP
3dbdf1f
\fB\-hashtest-quick\fR=\fIX\fR
3dbdf1f
whether to enable computation of quick hashes in replaymode (default false).
3dbdf1f
Can be enabled for debugging purposes.
b8284a1
b8284a1
.PP
b8284a1
Archive builder:
b8284a1
.TP
b8284a1
\fB\-archivebuild\fR=\fIPATH\fR
3dbdf1f
system \fIPATH\fR of the base directory containing mod data to be
3dbdf1f
archived/precached specify all mods it depends on with \fB-mod\fR=\fINAME\fR
b8284a1
.TP
b8284a1
\fB\-archivebuild-output\fR=\fIPATH\fR
3dbdf1f
system \fIPATH\fR to output of the resulting .zip archive (use with
3dbdf1f
archivebuild)
b8284a1
.TP
b8284a1
\fB\-archivebuild-compress\fR
b8284a1
enable deflate compression in the .zip
b8284a1
(no zip compression by default since it hurts compression of release packages)
b8284a1
2ed0214
.SH "EXAMPLES"
2ed0214
.TP
2ed0214
\fB1)\fR "Bob" will host a 2 player game on the Arcadia map:
2ed0214
.nf
2ed0214
-autostart="scenarios/Arcadia 02" -autostart-host -autostart-host-players=2 -autostart-playername="Bob"
2ed0214
.fi
3dbdf1f
"Alice" joins the match as player 2:
3dbdf1f
.nf
3dbdf1f
-autostart="scenarios/Arcadia" -autostart-client=127.0.0.1 -autostart-playername="Alice"
3dbdf1f
.fi
3dbdf1f
The players use the developer overlay to control players.
2ed0214
.TP
3dbdf1f
\fB2)\fR Load Alpine Lakes random map with random seed, 2 players (Athens
3dbdf1f
and Britons), and player 2 is PetraBot:
2ed0214
.nf
2ed0214
-autostart="random/alpine_lakes" -autostart-seed=-1 -autostart-players=2 -autostart-civ=1:athen -autostart-civ=2:brit -autostart-ai=2:petra
2ed0214
.fi
3dbdf1f
.TP
3dbdf1f
\fB3)\fR Observe the PetraBot on a triggerscript map:
3dbdf1f
.nf
3dbdf1f
 -autostart="random/jebel_barkal" -autostart-seed=-1 -autostart-players=2 -autostart-civ=1:athen -autostart-civ=2:brit -autostart-ai=1:petra -autostart-ai=2:petra -autostart-player=-1
3dbdf1f
.fi
2ed0214
b8284a1
.SH "REPORTING BUGS"
5d924be
Bugs should be reported on Trac. For information on reporting problems
5d924be
and finding logs, see http://trac.wildfiregames.com/wiki/ReportingErrors
b8284a1
b8284a1
.SH COPYRIGHT
b8284a1
0 A.D. is released as open source: you can freely use, copy, modify and
b8284a1
distribute the game's source code and data files, as long as you include
b8284a1
attribution to Wildfire Games and let anyone freely modify and distribute any
b8284a1
of your own modifications to the game's files.