1WESNOTH(6) Battle for Wesnoth WESNOTH(6)
2
6 wesnoth - Battle for Wesnoth, a turn-based fantasy strategy game
7
9 wesnoth [OPTIONS] [PATH_TO_DATA]
10
12 Battle for Wesnoth is a turn-based fantasy strategy game.
13 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
25 --all-translations
26 Show all translations in the in-game language selection list,
27 even if they are deemed insufficiently complete.
28 --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 --bzip2 infile
34 compresses a file in bzip2 format, stores it as infile.bz2 and
35 removes infile.
36 -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 --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 --campaign-scenario id_scenario
46 The id of the scenario from the specified campaign. The default
47 is the first scenario.
48 --campaign-skip-story
50 Skip [story] screens and dialog through the end of the start
51 event.
52 --clock
54 Adds the option to show a clock for testing the drawing timer.
55 --config-dir name
57 Deprecated, use --userdata-dir.
58 --config-path
60 Deprecated, use --userdata-path.
61 --core id_core
63 overrides the loaded core with the one whose id is specified.
64 --data-dir directory
66 overrides the data directory with the one specified
67 --data-path
69 prints the path of the data directory and exits.
70 -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 --debug-lua
77 enables some Lua debugging mechanisms
78 -D,--diff left-file right-file
80 diffs the two WML files; does not preprocess them first (to do
81 that, run them through -p first). Outputs the diff as DiffWML on
82 standard output or to the file indicated by --output.
83 -e[file], --editor[=file]
85 start the in-game map editor directly. If file is specified,
86 equivalent to -l --load.
87 --fps displays the number of frames per second the game is currently
89 running at, in a corner of the screen.
90 -f, --fullscreen
92 runs the game in full screen mode.
93 --gunzip infile.gz
95 decompresses a file which should be in gzip format and stores it
96 without the .gz suffix. The infile.gz will be removed.
97 --gzip infile
99 compresses a file in gzip format, stores it as infile.gz and
100 removes infile.
101 -h, --help
103 displays a summary of command line options to standard output,
104 and exits.
105 -l, --load file
107 loads the savegame file from the standard save game directory.
108 If the -e or --editor option is used as well, starts the editor
109 with the map from file open. If it is a directory, the editor
110 will start with a load map dialog opened there.
111 -L, --language lang
113 uses language lang (symbol) this session. Example: --language
114 ang_GB@latin
115 --log-level=domain1,domain2,...
117 sets the severity level of the log domains. all can be used to
118 match any log domain. Available levels: error, warn‐
119 ing, info, debug, none. By default the warning level is used
120 for most domains, but deprecation defaults to none unless com‐
121 bined with the -d option.
122 --log-precise
124 shows the timestamps in the logfile with more precision.
125 --log-strict
127 sets the strict level of the logger. Any messages sent to log
128 domains of this level or more severe will cause the unit test to
129 fail regardless of the victory result. Only relevant when used
130 with -u.
131 --logdomains[=filter]
133 lists defined log domains (only the ones containing filter if
134 used) and exits
135 --max-fps fps
137 the number of frames per second the game can show, the value
138 should be between 1 and 1000, the default is the monitor's
139 refresh rate.
140 -m, --multiplayer
142 runs a multiplayer game. There are additional options that can
143 be used together with --multiplayer as explained below.
144 --mp-test
146 load the test mp scenarios.
147 --new-widgets
149 there is a new WIP widget toolkit, this option enables it. This
150 is very experimental, don't fill bug reports since most are
151 known. Parts of the library are deemed stable and will work
152 without this switch.
153 --nodelay
155 runs the game without any delays for graphic benchmarking. This
156 is automatically enabled by --nogui.
157 --noaddons
159 disables loading of user addons.
160 --nocache
162 disables caching of game data.
163 --nogui
165 runs the game without the GUI. Only available in combination
166 with --multiplayer or --screenshot or --plugin.
167 --nomusic
169 runs the game without music.
170 --noreplaycheck
172 don't try to validate replay of unit test. Only relevant when
173 used with -u.
174 --nosound
176 runs the game without sounds and music.
177 --output file
179 output to the specified file. Applicable to diffing operations.
180 --password password
182 uses password when connecting to a server, ignoring other pref‐
183 erences. Unsafe.
184 --plugin script
186 (experimental) load a script which defines a Wesnoth plugin.
187 Similar to --script, but Lua file should return a function which
188 will be run as a coroutine and periodically woken up with
189 updates.
190 -P,--patch base-file patch-file
192 applies a DiffWML patch to a WML file; does not preprocess
193 either of the files. Outputs the patched WML to standard output
194 or to the file indicated by --output.
195 -p, --preprocess source-file/folder target-directory
197 preprocesses a specified file/folder. For each file(s) a plain
198 .cfg file and a processed .cfg file will be written in specified
199 target directory. If a folder is specified, it will be prepro‐
200 cessed recursively based on the known preprocessor rules. The
201 common macros from the "data/core/macros" directory will be pre‐
202 processed before the specified resources. Example: -p ~/wes‐
203 noth/data/campaigns/tutorial ~/result. For details regarding
204 the preprocessor visit: https://wiki.wesnoth.org/Preprocessor‐
205 Ref#Command-line_preprocessor.
206 --preprocess-defines=DEFINE1,DEFINE2,...
208 comma separated list of defines to be used by the --preprocess
209 command. If SKIP_CORE is in the define list the "data/core"
210 directory won't be preprocessed.
211 --preprocess-input-macros source-file
213 used only by the --preprocess command. Specifies a file that
214 contains [preproc_define]s to be included before preprocessing.
215 --preprocess-output-macros[=target-file]
217 used only by the --preprocess command. Will output all prepro‐
218 cessed macros in the target file. If the file is not specified
219 the output will be file '_MACROS_.cfg' in the target directory
220 of preprocess's command. The output file can be passed to --pre‐
221 process-input-macros. This switch should be typed before the
222 --preprocess command.
223 --proxy
225 enables usage of proxy for network connections.
226 --proxy-address address
228 specifies address of the proxy.
229 --proxy-port port
231 specifies port of the proxy.
232 --proxy-user username
234 specifies username to log in to the proxy.
235 --proxy-password password
237 specifies password to log in to the proxy.
238 -r XxY, --resolution XxY
240 sets the screen resolution. Example: -r 800x600.
241 --render-image image output
243 takes a valid wesnoth 'image path string' with image path func‐
244 tions, and outputs to a .png file. Image path functions are doc‐
245 umented at https://wiki.wesnoth.org/ImagePathFunctionWML.
246 -R, --report
248 initializes game directories, prints build information suitable
249 for use in bug reports, and exits.
250 --rng-seed number
252 seeds the random number generator with number. Example: --rng-
253 seed 0.
254 --screenshot map output
256 saves a screenshot of map to output without initializing a
257 screen.
258 --script file
260 (experimental) file containing a Lua script to control the
261 client.
262 -s[host], --server[=host]
264 connects to the specified host if any, otherwise connect to the
265 first server in preferences. Example: --server server.wes‐
266 noth.org.
267 --showgui
269 runs the game with the GUI, overriding any implicit --nogui.
270 --strict-validation
272 validation errors are treated as fatal errors.
273 -t[scenario_id], --test[=scenario_id]
275 runs the game in a small test scenario. The scenario should be
276 one defined with a [test] WML tag. The default is test. A
277 demonstration of the [micro_ai] feature can be started with
278 micro_ai_test. Implies --nogui.
279 --translations-over percent
281 Set the standard for deeming a translation is complete enough to
282 show in the in-game language list to percent. Valid values are
283 0 to 100.
284 -u, --unit scenario-id
286 runs the specified test scenario as a unit test. Implies
287 --nogui.
288 --unsafe-scripts
290 makes the package package available to lua scripts, so that they
291 can load arbitrary packages. Do not do this with untrusted
292 scripts! This action gives lua the same permissions as the wes‐
293 noth executable.
294 -S,--use-schema path
296 sets the WML schema for use with -V,--validate.
297 --userconfig-dir name
299 sets the user configuration directory to name under $HOME or "My
300 Documents\My Games" for windows. You can also specify an abso‐
301 lute path for the configuration directory outside the $HOME or
302 "My Documents\My Games". On Windows it is also possible to spec‐
303 ify a directory relative to the process working directory by
304 using path starting with ".\" or "..\". Under X11 this defaults
305 to $XDG_CONFIG_HOME or $HOME/.config/wesnoth, on other systems
306 to the userdata path.
307 --userconfig-path
309 prints the path of the user configuration directory and exits.
310 --userdata-dir name
312 sets the userdata directory to name under $HOME or "My Docu‐
313 ments\My Games" for windows. You can also specify an absolute
314 path for the userdata directory outside the $HOME or "My Docu‐
315 ments\My Games". On Windows it is also possible to specify a
316 directory relative to the process working directory by using
317 path starting with ".\" or "..\".
318 --userdata-path
320 prints the path of the userdata directory and exits.
321 --username username
323 uses username when connecting to a server, ignoring other pref‐
324 erences.
325 --validate path
327 validates a file against the WML schema.
328 --validate-addon addon_id
330 validates the WML of the given addon as you play.
331 --validate-core
333 validates the core WML as you play.
334 --validate-schema path
336 validates a file as a WML schema.
337 --validcache
339 assumes that the cache is valid. (dangerous)
340 -v, --version
342 shows the version number and exits.
343 -w, --windowed
345 runs the game in windowed mode.
346 --with-replay
348 replays the game loaded with the --load option.
349
351 The side-specific multiplayer options are marked with number. number
352 has to be replaced by a side number. It usually is 1 or 2 but depends
353 on the number of players possible in the chosen scenario.
354 --ai-config number:value
356 selects a configuration file to load for the AI controller for
357 this side.
358 --algorithm number:value
360 selects a non-standard algorithm to be used by the AI controller
361 for this side. The algorithm is defined by an [ai] tag, which
362 can be a core one either in "data/ai/ais" or "data/ai/dev" or an
363 algorithm defined by an addon. Available values include: idle_ai
364 and experimental_ai.
365 --controller number:value
367 selects the controller for this side. Available values: human,
368 ai and null.
369 --era value
371 use this option to play in the selected era instead of the
372 Default era. The era is chosen by an id. Eras are described in
373 the data/multiplayer/eras.cfg file.
374 --exit-at-end
376 exits once the scenario is over, without displaying vic‐
377 tory/defeat dialog which normally requires the user to click End
378 Scenario. This is also used for scriptable benchmarking.
379 --ignore-map-settings
381 do not use map settings, use default values instead.
382 --label label
384 sets the label for AIs.
385 --multiplayer-repeat value
387 repeats a multiplayer game value times. Best to use with --nogui
388 for scriptable benchmarking.
389 --parm number:name:value
391 sets additional parameters for this side. This parameter depends
392 on the options used with --controller and --algorithm. It
393 should only be useful for people designing their own AI. (not
394 yet documented completely)
395 --scenario value
397 selects a multiplayer scenario by id. The default scenario id is
398 multiplayer_The_Freelands.
399 --side number:value
401 selects a faction of the current era for this side. The faction
402 is chosen by an id. Factions are described in the data/multi‐
403 player.cfg file.
404 --turns value
406 sets the number of turns for the chosen scenario. By default no
407 turn limit is set.
408
410 Normal exit status is 0. An exit status of 1 indicates an (SDL, video,
411 fonts, etc) initialization error. An exit status of 2 indicates an
412 error with the command line options.
413 When running unit tests (with -u), the exit status is different. An
414 exit status of 0 indicates that the test passed, and 1 indicates that
415 the test failed. An exit status of 3 indicates that the test passed,
416 but produced an invalid replay file. An exit status of 4 indicates that
417 the test passed, but the replay produced errors. These latter two are
418 only returned if --noreplaycheck is not passed.
419
421 Written by David White <davidnwhite@verizon.net>.
422 Edited by Nils Kneuper <crazy-ivanovic@gmx.net>, ott <ott@gaon.net> and
423 Soliton <soliton.de@gmail.com>.
424 This manual page was originally written by Cyril Bouthors
425 <cyril@bouthors.org>.
426 Visit the official homepage: https://www.wesnoth.org/
427
429 Copyright © 2003-2018 David White <davidnwhite@verizon.net>
430 This is Free Software; this software is licensed under the GPL version
431 2, as published by the Free Software Foundation. There is NO warranty;
432 not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
433
435 wesnothd(6)
436wesnoth 2018 WESNOTH(6)