wesnoth(6)

1WESNOTH(6)                    Battle for Wesnoth                    WESNOTH(6)
2
3
4

NAME

6       wesnoth - Battle for Wesnoth, a turn-based fantasy strategy game
7

SYNOPSIS

9       wesnoth [OPTIONS] [PATH_TO_DATA]
10

DESCRIPTION

12       Battle for Wesnoth is a turn-based fantasy strategy game.
13
14       Defeat  all  enemy  leaders using a well-chosen cadre of troops, taking
15       care to manage your resources of gold  and  villages.  All  units  have
16       their own strengths and weaknesses; to win, deploy your forces to their
17       best advantage while denying your foes the chance to do  the  same.  As
18       units  gain experience, they acquire new abilities and become more pow‐
19       erful. Play in your own language and test your skill  against  a  smart
20       computer  opponent,  or join Wesnoth's large community of on-line play‐
21       ers. Create your own custom units, scenarios or  campaigns,  and  share
22       them with others.
23

OPTIONS

25       --bpp number
26              sets BitsPerPixel value. Example: --bpp 32
27
28       -c, --campaign
29              goes directly to the campaign selection menu.
30
31       --config-dir name
32              sets the user configuration directory to name under $HOME or "My
33              Documents\My Games" for windows.
34
35       --config-path
36              prints the path of the user configuration directory and exits.
37
38       -d, --debug
39              enables additional command mode options in-game  (see  the  wiki
40              page  at http://www.wesnoth.org/wiki/CommandMode for more infor‐
41              mation about command mode).
42
43       -e, --editor file
44              start the in-game map editor directly.  If  file  is  specified,
45              equivalent to -e --load
46
47       --fps  displays  the  number of frames per second the game is currently
48              running at, in a corner of the screen.
49
50       -f, --fullscreen
51              runs the game in full screen mode.
52
53       --gunzip infile.gz
54              decompresses a file which should be in gzip format and stores it
55              without the .gz suffix. The infile.gz will be removed.
56
57       --gzip infile
58              compresses  a  file  in  gzip format, stores it as infile.gz and
59              removes infile.
60
61       -h, --help
62              displays a summary of command line options to  standard  output,
63              and exits.
64
65       -l, --load file
66              loads  the  savegame file from the standard save game directory.
67              If the -e or --editor option is used as well, starts the  editor
68              with  the  map  from file open. If it is a directory, the editor
69              will start with a load map dialog opened there.
70
71       --log-level=domain1,domain2,...
72              sets the severity level of the log domains.  all can be used  to
73              match   any   log   domain.   Available   levels:   error, warn‐
74              ing, info, debug.  By default the error level is used.
75
76       --logdomains
77              Dumps a list of all log domains and exits.
78
79       --max-fps
80              the number of frames per second the game  can  show,  the  value
81              should be between the 1 and 1000, the default is 50.
82
83       -m, --multiplayer
84              runs  a  multiplayer game. There are additional options that can
85              be used together with --multiplayer  as  explained  below.  Only
86              these additional options can follow --multiplayer.
87
88       --no-delay
89              runs  the game without any delays for graphic benchmarking. This
90              is automatically enabled by --nogui.
91
92       --nocache
93              disables caching of game data.
94
95       --nomusic
96              runs the game without music.
97
98       --nosound
99              runs the game without sounds and music.
100
101       --path prints the name of the game data directory and exits.
102
103       -r XxY, --resolution XxY
104              sets the screen resolution. Example: -r 800x600
105
106       --smallgui
107              allows to use screen resolutions down to 800x480 and  resizes  a
108              few interface elements.
109
110       -s, --server [host]
111              connects  to the specified host if any, otherwise connect to the
112              first  server  in  preferences.  Example:  --server  server.wes‐
113              noth.org
114
115       -t, --test
116              runs the game in a small test scenario.
117
118       --validcache
119              assumes that the cache is valid. (dangerous)
120
121       -v, --version
122              shows the version number and exits.
123
124       -w, --windowed
125              runs the game in windowed mode.
126
127       --with-replay
128              replays the game loaded with the --load option.
129

Options for --multiplayer

131       The  side-specific  multiplayer options are marked with number.  number
132       has to be replaced by a side number. It usually is 1 or 2  but  depends
133       on the number of players possible in the chosen scenario.
134
135       --ai_confignumber=value
136              selects  a  configuration file to load for the AI controller for
137              this side.
138
139       --algorithmnumber=value
140              selects a non-standard algorithm to be used by the AI controller
141              for this side. Available values: idle_ai and sample_ai.
142
143       --controllernumber=value
144              selects  the  controller  for this side. Available values: human
145              and ai.
146
147       --era=value
148              use this option to play in  the  selected  era  instead  of  the
149              Default  era.  The era is chosen by an id. Eras are described in
150              the data/multiplayer/eras.cfg file.
151
152       --exit-at-end
153              exits  once  the  scenario  is  over,  without  displaying  vic‐
154              tory/defeat dialog which requires the user to click OK.  This is
155              also used for scriptable benchmarking.
156
157       --nogui
158              runs the game without the GUI. Must appear before  --multiplayer
159              to have the desired effect.
160
161       --parmnumber=name:value
162              sets additional parameters for this side. This parameter depends
163              on the options  used  with  --controller  and  --algorithm.   It
164              should  only  be  useful for people designing their own AI. (not
165              yet documented completely)
166
167       --scenario=value
168              selects a multiplayer scenario by id. The default scenario id is
169              multiplayer_The_Freelands.
170
171       --sidenumber=value
172              selects  a faction of the current era for this side. The faction
173              is chosen by an id. Factions are described  in  the  data/multi‐
174              player.cfg file.
175
176       --turns=value
177              sets the number of turns for the chosen scenario. The default is
178              50.
179

EXIT STATUS

181       Normal exit status is 0. An exit status of 1 indicates an (SDL,  video,
182       fonts,  etc)  initialization  error.  An  exit status of 2 indicates an
183       error with the command line options.
184

AUTHOR

186       Written by David White <davidnwhite@verizon.net>.
187       Edited by Nils Kneuper <crazy-ivanovic@gmx.net>, ott <ott@gaon.net> and
188       Soliton <soliton.de@gmail.com>.
189       This   manual   page   was   originally   written   by  Cyril  Bouthors
190       <cyril@bouthors.org>.
191       Visit the official homepage: http://www.wesnoth.org/
192

COPYRIGHT

194       Copyright © 2003-2009 David White <davidnwhite@verizon.net>
195       This is Free Software; this software is licensed under the GPL  version
196       2, as published by the Free Software Foundation.  There is NO warranty;
197       not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
198