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 online players.
21       Create your own custom units, scenarios or campaigns,  and  share  them
22       with others.
23

OPTIONS

25       --all-translations
26              Show  all  translations  in the in-game language selection list,
27              even if they are deemed insufficiently complete.
28
29       --bunzip2 infile.bz2
30              decompresses a file which should be in bzip2 format  and  stores
31              it without the .bz2 suffix. The infile.bz2 will be removed.
32
33       --bzip2 infile
34              compresses  a  file in bzip2 format, stores it as infile.bz2 and
35              removes infile.
36
37       -c[id_campaign], --campaign[=id_campaign]
38              goes directly to the campaign with id id_campaign.  A  selection
39              menu will appear if no id was specified.
40
41       --campaign-difficulty[=difficulty]
42              The  difficulty  of  the  specified campaign (1 to max). If none
43              specified, the campaign difficulty selection widget will appear.
44
45       --campaign-scenario id_scenario
46              The id of the scenario from the specified campaign. The  default
47              is the first scenario.
48
49       --campaign-skip-story
50              Skip  [story]  screens  and  dialog through the end of the start
51              event.
52
53       --clock
54              Adds the option to show a clock for testing the drawing timer.
55
56       --config-dir name
57              Deprecated, use --userdata-dir.
58
59       --config-path
60              Deprecated, use --userdata-path.
61
62       --core id_core
63              overrides the loaded core with the one whose id is specified.
64
65       --data-dir directory
66              overrides the data directory with the one specified
67
68       --data-path
69              prints the path of the data directory and exits.
70
71       -d, --debug
72              enables additional command mode options in-game  (see  the  wiki
73              page at https://www.wesnoth.org/wiki/CommandMode for more infor‐
74              mation about command mode).
75
76       --debug-lua
77              enables some Lua debugging mechanisms
78
79       -e[file], --editor[=file]
80              start the in-game map editor directly.  If  file  is  specified,
81              equivalent to -l --load.
82
83       --fps  displays  the  number of frames per second the game is currently
84              running at, in a corner of the screen.
85
86       -f, --fullscreen
87              runs the game in full screen mode.
88
89       --gunzip infile.gz
90              decompresses a file which should be in gzip format and stores it
91              without the .gz suffix. The infile.gz will be removed.
92
93       --gzip infile
94              compresses  a  file  in  gzip format, stores it as infile.gz and
95              removes infile.
96
97       -h, --help
98              displays a summary of command line options to  standard  output,
99              and exits.
100
101       -l, --load file
102              loads  the  savegame file from the standard save game directory.
103              If the -e or --editor option is used as well, starts the  editor
104              with  the  map  from file open. If it is a directory, the editor
105              will start with a load map dialog opened there.
106
107       -L, --language lang
108              uses language lang (symbol) this session.   Example:  --language
109              ang_GB@latin
110
111       --log-level=domain1,domain2,...
112              sets  the severity level of the log domains.  all can be used to
113              match   any   log   domain.   Available   levels:   error, warn‐
114              ing, info, debug, none.   By  default  the warning level is used
115              for most domains, but deprecation defaults to none  unless  com‐
116              bined with the -d option.
117
118       --log-precise
119              shows the timestamps in the logfile with more precision.
120
121       --log-strict
122              sets  the  strict  level of the logger. Any messages sent to log
123              domains of this level or more severe will cause the unit test to
124              fail  regardless  of the victory result. Only relevant when used
125              with -u.
126
127       --logdomains[=filter]
128              lists defined log domains (only the ones  containing  filter  if
129              used) and exits
130
131       --max-fps fps
132              the  number  of  frames  per second the game can show, the value
133              should be between 1 and  1000,  the  default  is  the  monitor's
134              refresh rate.
135
136       -m, --multiplayer
137              runs  a  multiplayer game. There are additional options that can
138              be used together with --multiplayer as explained below.
139
140       --mp-test
141              load the test mp scenarios.
142
143       --new-widgets
144              there is a new WIP widget toolkit, this option enables it.  This
145              is  very  experimental,  don't  fill  bug reports since most are
146              known. Parts of the library are  deemed  stable  and  will  work
147              without this switch.
148
149       --nodelay
150              runs  the game without any delays for graphic benchmarking. This
151              is automatically enabled by --nogui.
152
153       --noaddons
154              disables loading of user addons.
155
156       --nocache
157              disables caching of game data.
158
159       --nogui
160              runs the game without the GUI.  Only  available  in  combination
161              with --multiplayer or --screenshot or --plugin.
162
163       --nomusic
164              runs the game without music.
165
166       --noreplaycheck
167              don't  try  to  validate replay of unit test. Only relevant when
168              used with -u.
169
170       --nosound
171              runs the game without sounds and music.
172
173       --password password
174              uses password when connecting to a server, ignoring other  pref‐
175              erences. Unsafe.
176
177       --plugin script
178              (experimental)  load  a  script  which defines a Wesnoth plugin.
179              Similar to --script, but Lua file should return a function which
180              will  be  run  as  a  coroutine  and  periodically woken up with
181              updates.
182
183       -p, --preprocess source-file/folder target-directory
184              preprocesses a specified file/folder. For each file(s)  a  plain
185              .cfg file and a processed .cfg file will be written in specified
186              target directory. If a folder is specified, it will  be  prepro‐
187              cessed  recursively  based  on the known preprocessor rules. The
188              common macros from the "data/core/macros" directory will be pre‐
189              processed  before  the  specified resources.  Example: -p ~/wes‐
190              noth/data/campaigns/tutorial ~/result.   For  details  regarding
191              the  preprocessor  visit: https://wiki.wesnoth.org/Preprocessor
192              Ref#Command-line_preprocessor.
193
194       --preprocess-defines=DEFINE1,DEFINE2,...
195              comma separated list of defines to be used by  the  --preprocess
196              command.  If  SKIP_CORE  is  in  the define list the "data/core"
197              directory won't be preprocessed.
198
199       --preprocess-input-macros source-file
200              used only by the --preprocess command.  Specifies  a  file  that
201              contains [preproc_define]s to be included before preprocessing.
202
203       --preprocess-output-macros[=target-file]
204              used  only  by the --preprocess command. Will output all prepro‐
205              cessed macros in the target file. If the file is  not  specified
206              the  output  will be file '_MACROS_.cfg' in the target directory
207              of preprocess's command. The output file can be passed to --pre‐
208              process-input-macros.   This  switch  should be typed before the
209              --preprocess command.
210
211       --proxy
212              enables usage of proxy for network connections.
213
214       --proxy-address address
215              specifies address of the proxy.
216
217       --proxy-port port
218              specifies port of the proxy.
219
220       --proxy-user username
221              specifies username to log in to the proxy.
222
223       --proxy-password password
224              specifies password to log in to the proxy.
225
226       -r XxY, --resolution XxY
227              sets the screen resolution. Example: -r 800x600.
228
229       --render-image image output
230              takes a valid wesnoth 'image path string' with image path  func‐
231              tions, and outputs to a .png file. Image path functions are doc‐
232              umented at https://wiki.wesnoth.org/ImagePathFunctionWML.
233
234       -R, --report
235              initializes game directories, prints build information  suitable
236              for use in bug reports, and exits.
237
238       --rng-seed number
239              seeds  the random number generator with number.  Example: --rng-
240              seed 0.
241
242       --screenshot map output
243              saves a screenshot of  map  to  output  without  initializing  a
244              screen.
245
246       --script file
247              (experimental)  file  containing  a  Lua  script  to control the
248              client.
249
250       -s[host], --server[=host]
251              connects to the specified host if any, otherwise connect to  the
252              first  server  in  preferences.  Example:  --server  server.wes‐
253              noth.org.
254
255       --showgui
256              runs the game with the GUI, overriding any implicit --nogui.
257
258       --strict-validation
259              validation errors are treated as fatal errors.
260
261       -t[scenario_id], --test[=scenario_id]
262              runs the game in a small test scenario. The scenario  should  be
263              one  defined  with  a  [test]  WML  tag. The default is test.  A
264              demonstration of the [micro_ai]  feature  can  be  started  with
265              micro_ai_test.  Implies --nogui.
266
267       --translations-over percent
268              Set the standard for deeming a translation is complete enough to
269              show in the in-game language list to percent.  Valid values  are
270              0 to 100.
271
272       -u, --unit scenario-id
273              runs  the  specified  test  scenario  as  a  unit  test. Implies
274              --nogui.
275
276       --unsafe-scripts
277              makes the package package available to lua scripts, so that they
278              can  load  arbitrary  packages.  Do  not  do this with untrusted
279              scripts! This action gives lua the same permissions as the  wes‐
280              noth executable.
281
282       --userconfig-dir name
283              sets the user configuration directory to name under $HOME or "My
284              Documents\My Games" for windows.  You can also specify an  abso‐
285              lute  path  for the configuration directory outside the $HOME or
286              "My Documents\My Games". On Windows it is also possible to spec‐
287              ify  a  directory  relative  to the process working directory by
288              using path starting with ".\" or "..\".  Under X11 this defaults
289              to  $XDG_CONFIG_HOME  or $HOME/.config/wesnoth, on other systems
290              to the userdata path.
291
292       --userconfig-path
293              prints the path of the user configuration directory and exits.
294
295       --userdata-dir name
296              sets the userdata directory to name under  $HOME  or  "My  Docu‐
297              ments\My  Games"  for windows.  You can also specify an absolute
298              path for the userdata directory outside the $HOME or  "My  Docu‐
299              ments\My  Games".  On  Windows  it is also possible to specify a
300              directory relative to the process  working  directory  by  using
301              path starting with ".\" or "..\".
302
303       --userdata-path
304              prints the path of the userdata directory and exits.
305
306       --username username
307              uses  username when connecting to a server, ignoring other pref‐
308              erences.
309
310       --validcache
311              assumes that the cache is valid. (dangerous)
312
313       -v, --version
314              shows the version number and exits.
315
316       -w, --windowed
317              runs the game in windowed mode.
318
319       --with-replay
320              replays the game loaded with the --load option.
321

Options for --multiplayer

323       The side-specific multiplayer options are marked with  number.   number
324       has  to  be replaced by a side number. It usually is 1 or 2 but depends
325       on the number of players possible in the chosen scenario.
326
327       --ai-config number:value
328              selects a configuration file to load for the AI  controller  for
329              this side.
330
331       --algorithm number:value
332              selects a non-standard algorithm to be used by the AI controller
333              for this side. The algorithm is defined by an  [ai]  tag,  which
334              can be a core one either in "data/ai/ais" or "data/ai/dev" or an
335              algorithm defined by an addon. Available values include: idle_ai
336              and experimental_ai.
337
338       --controller number:value
339              selects  the  controller  for this side. Available values: human
340              and ai.
341
342       --era value
343              use this option to play in  the  selected  era  instead  of  the
344              Default  era.  The era is chosen by an id. Eras are described in
345              the data/multiplayer/eras.cfg file.
346
347       --exit-at-end
348              exits  once  the  scenario  is  over,  without  displaying  vic‐
349              tory/defeat dialog which normally requires the user to click End
350              Scenario.  This is also used for scriptable benchmarking.
351
352       --ignore-map-settings
353              do not use map settings, use default values instead.
354
355       --label label
356              sets the label for AIs.
357
358       --multiplayer-repeat value
359              repeats a multiplayer game value times. Best to use with --nogui
360              for scriptable benchmarking.
361
362       --parm number:name:value
363              sets additional parameters for this side. This parameter depends
364              on the options  used  with  --controller  and  --algorithm.   It
365              should  only  be  useful for people designing their own AI. (not
366              yet documented completely)
367
368       --scenario value
369              selects a multiplayer scenario by id. The default scenario id is
370              multiplayer_The_Freelands.
371
372       --side number:value
373              selects  a faction of the current era for this side. The faction
374              is chosen by an id. Factions are described  in  the  data/multi‐
375              player.cfg file.
376
377       --turns value
378              sets  the number of turns for the chosen scenario. By default no
379              turn limit is set.
380

EXIT STATUS

382       Normal exit status is 0.  An exit status of 1 indicates an (SDL, video,
383       fonts,  etc)  initialization  error.  An  exit status of 2 indicates an
384       error with the command line options.
385       When running unit tests (with -u), the exit  status  is  different.  An
386       exit  status  of 0 indicates that the test passed, and 1 indicates that
387       the test failed. An exit status of 3 indicates that  the  test  passed,
388       but produced an invalid replay file. An exit status of 4 indicates that
389       the test passed, but the replay produced errors. These latter  two  are
390       only  returned  if  --noreplaycheck  is not passed. An exit status of 2
391       indicates that the test  timed  out,  when  used  with  the  deprecated
392       --timeout option.
393

AUTHOR

395       Written by David White <davidnwhite@verizon.net>.
396       Edited by Nils Kneuper <crazy-ivanovic@gmx.net>, ott <ott@gaon.net> and
397       Soliton <soliton.de@gmail.com>.
398       This  manual  page   was   originally   written   by   Cyril   Bouthors
399       <cyril@bouthors.org>.
400       Visit the official homepage: https://www.wesnoth.org/
401
403       Copyright © 2003-2018 David White <davidnwhite@verizon.net>
404       This  is Free Software; this software is licensed under the GPL version
405       2, as published by the Free Software Foundation.  There is NO warranty;
406       not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
407

SEE ALSO

409       wesnothd(6)
410
411
412
413wesnoth                              2018                           WESNOTH(6)
Impressum