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 --strict-lua
80 disallow deprecated Lua API calls
81 -D,--diff left-file right-file
83 diffs the two WML files; does not preprocess them first (to do
84 that, run them through -p first). Outputs the diff as DiffWML on
85 standard output or to the file indicated by --output.
86 -e[file], --editor[=file]
88 start the in-game map editor directly. If file is specified,
89 equivalent to -l --load.
90 --fps displays the number of frames per second the game is currently
92 running at in a corner of the screen as well as writes these
93 values to a file in the userdata directory.
94 -f, --fullscreen
96 runs the game in full screen mode.
97 --gunzip infile.gz
99 decompresses a file which should be in gzip format and stores it
100 without the .gz suffix. The infile.gz will be removed.
101 --gzip infile
103 compresses a file in gzip format, stores it as infile.gz and re‐
104 moves infile.
105 -h, --help
107 displays a summary of command line options to standard output,
108 and exits.
109 -l, --load file
111 loads the savegame file from the standard save game directory.
112 If the -e or --editor option is used as well, starts the editor
113 with the map from file open. If it is a directory, the editor
114 will start with a load map dialog opened there.
115 -L, --language lang
117 uses language lang (symbol) this session. Example: --language
118 ang_GB@latin
119 --log-level=domain1,domain2,...
121 sets the severity level of the log domains. all can be used to
122 match any log domain. Available levels: error, warn‐
123 ing, info, debug, none. By default the warning level is used
124 for most domains, but deprecation defaults to none unless com‐
125 bined with the -d option.
126 --log-precise
128 shows the timestamps in log output with more precision.
129 --log-strict
131 sets the strict level of the logger. Any messages sent to log
132 domains of this level or more severe will cause the unit test to
133 fail regardless of the victory result. Only relevant when used
134 with -u.
135 --logdomains[=filter]
137 lists defined log domains (only the ones containing filter if
138 used) and exits
139 --log-to-file
141 redirects logged output to a file. Log files are created in the
142 logs directory under the userdata folder.
143 --max-fps fps
145 the number of frames per second the game can show, the value
146 should be between 1 and 1000, the default is the monitor's re‐
147 fresh rate.
148 -m, --multiplayer
150 runs a multiplayer game. There are additional options that can
151 be used together with --multiplayer as explained below.
152 --mp-test
154 load the test mp scenarios.
155 --new-widgets
157 there is a new WIP widget toolkit, this option enables it. This
158 is very experimental, don't fill bug reports since most are
159 known. Parts of the library are deemed stable and will work
160 without this switch.
161 --nodelay
163 runs the game without any delays for graphic benchmarking. This
164 is automatically enabled by --nogui.
165 --noaddons
167 disables loading of user addons.
168 --nocache
170 disables caching of game data.
171 --nogui
173 runs the game without the GUI. Only available in combination
174 with --multiplayer or --screenshot or --plugin.
175 --nobanner
177 suppress the startup banner.
178 --nomusic
180 runs the game without music.
181 --noreplaycheck
183 don't try to validate replay of unit test. Only relevant when
184 used with -u.
185 --nosound
187 runs the game without sounds and music.
188 --output file
190 output to the specified file. Applicable to diffing operations.
191 --password password
193 uses password when connecting to a server, ignoring other pref‐
194 erences. Unsafe.
195 --plugin script
197 (experimental) load a script which defines a Wesnoth plugin.
198 Similar to --script, but Lua file should return a function which
199 will be run as a coroutine and periodically woken up with up‐
200 dates.
201 -P,--patch base-file patch-file
203 applies a DiffWML patch to a WML file; does not preprocess ei‐
204 ther of the files. Outputs the patched WML to standard output
205 or to the file indicated by --output.
206 -p, --preprocess source-file/folder target-directory
208 preprocesses a specified file/folder. For each file(s) a plain
209 .cfg file and a processed .cfg file will be written in specified
210 target directory. If a folder is specified, it will be prepro‐
211 cessed recursively based on the known preprocessor rules. The
212 common macros from the "data/core/macros" directory will be pre‐
213 processed before the specified resources. Example: -p ~/wes‐
214 noth/data/campaigns/tutorial ~/result. For details regarding
215 the preprocessor visit: https://wiki.wesnoth.org/Preprocessor‐
216 Ref#Command-line_preprocessor.
217 --preprocess-defines=DEFINE1,DEFINE2,...
219 comma separated list of defines to be used by the --preprocess
220 command. If SKIP_CORE is in the define list the "data/core" di‐
221 rectory won't be preprocessed.
222 --preprocess-input-macros source-file
224 used only by the --preprocess command. Specifies a file that
225 contains [preproc_define]s to be included before preprocessing.
226 --preprocess-output-macros[=target-file]
228 used only by the --preprocess command. Will output all prepro‐
229 cessed macros in the target file. If the file is not specified
230 the output will be file '_MACROS_.cfg' in the target directory
231 of preprocess's command. The output file can be passed to --pre‐
232 process-input-macros. This switch should be typed before the
233 --preprocess command.
234 -r XxY, --resolution XxY
236 sets the screen resolution. Example: -r 800x600.
237 --render-image image output
239 takes a valid wesnoth 'image path string' with image path func‐
240 tions, and outputs to a .png file. Image path functions are doc‐
241 umented at https://wiki.wesnoth.org/ImagePathFunctionWML.
242 -R, --report
244 initializes game directories, prints build information suitable
245 for use in bug reports, and exits.
246 --rng-seed number
248 seeds the random number generator with number. Example: --rng-
249 seed 0.
250 --screenshot map output
252 saves a screenshot of map to output without initializing a
253 screen.
254 --script file
256 (experimental) file containing a Lua script to control the
257 client.
258 -s[host], --server[=host]
260 connects to the specified host if any, otherwise connect to the
261 first server in preferences. Example: --server server.wes‐
262 noth.org.
263 --showgui
265 runs the game with the GUI, overriding any implicit --nogui.
266 --strict-validation
268 validation errors are treated as fatal errors.
269 -t[scenario_id], --test[=scenario_id]
271 runs the game in a small test scenario. The scenario should be
272 one defined with a [test] WML tag. The default is test. A
273 demonstration of the [micro_ai] feature can be started with mi‐
274 cro_ai_test. Implies --nogui.
275 --translations-over percent
277 Set the standard for deeming a translation is complete enough to
278 show in the in-game language list to percent. Valid values are
279 0 to 100.
280 -u, --unit scenario-id
282 runs the specified test scenario as a unit test. Implies
283 --nogui.
284 --unsafe-scripts
286 makes the package package available to lua scripts, so that they
287 can load arbitrary packages. Do not do this with untrusted
288 scripts! This action gives lua the same permissions as the wes‐
289 noth executable.
290 -S,--use-schema path
292 sets the WML schema for use with -V,--validate.
293 --userconfig-dir name
295 sets the user configuration directory to name under $HOME or "My
296 Documents\My Games" for windows. You can also specify an abso‐
297 lute path for the configuration directory outside the $HOME or
298 "My Documents\My Games". On Windows it is also possible to spec‐
299 ify a directory relative to the process working directory by us‐
300 ing path starting with ".\" or "..\". Under X11 this defaults
301 to $XDG_CONFIG_HOME or $HOME/.config/wesnoth, on other systems
302 to the userdata path.
303 --userconfig-path
305 prints the path of the user configuration directory and exits.
306 --userdata-dir name
308 sets the userdata directory to name under $HOME or "My Docu‐
309 ments\My Games" for windows. You can also specify an absolute
310 path for the userdata directory outside the $HOME or "My Docu‐
311 ments\My Games". On Windows it is also possible to specify a di‐
312 rectory relative to the process working directory by using path
313 starting with ".\" or "..\".
314 --userdata-path
316 prints the path of the userdata directory and exits.
317 --username username
319 uses username when connecting to a server, ignoring other pref‐
320 erences.
321 --validate path
323 validates a file against the WML schema.
324 --validate-addon addon_id
326 validates the WML of the given addon as you play.
327 --validate-core
329 validates the core WML as you play.
330 --validate-schema path
332 validates a file as a WML schema.
333 --validcache
335 assumes that the cache is valid. (dangerous)
336 -v, --version
338 shows the version number and exits.
339 --simple-version
341 shows the version number and nothing else, then exits.
342 -w, --windowed
344 runs the game in windowed mode.
345 --with-replay
347 replays the game loaded with the --load option.
348
350 The side-specific multiplayer options are marked with number. number
351 has to be replaced by a side number. It usually is 1 or 2 but depends
352 on the number of players possible in the chosen scenario.
353 --ai-config number:value
355 selects a configuration file to load for the AI controller for
356 this side.
357 --algorithm number:value
359 selects a non-standard algorithm to be used by the AI controller
360 for this side. The algorithm is defined by an [ai] tag, which
361 can be a core one either in "data/ai/ais" or "data/ai/dev" or an
362 algorithm defined by an addon. Available values include: idle_ai
363 and experimental_ai.
364 --controller number:value
366 selects the controller for this side. Available values: human,
367 ai and null.
368 --era value
370 use this option to play in the selected era instead of the De‐
371 fault era. The era is chosen by an id. Eras are described in the
372 data/multiplayer/eras.cfg file.
373 --exit-at-end
375 exits once the scenario is over, without displaying victory/de‐
376 feat dialog which normally requires the user to click End Sce‐
377 nario. This is also used for scriptable benchmarking.
378 --ignore-map-settings
380 do not use map settings, use default values instead.
381 --label label
383 sets the label for AIs.
384 --multiplayer-repeat value
386 repeats a multiplayer game value times. Best to use with --nogui
387 for scriptable benchmarking.
388 --parm number:name:value
390 sets additional parameters for this side. This parameter depends
391 on the options used with --controller and --algorithm. It
392 should only be useful for people designing their own AI. (not
393 yet documented completely)
394 --scenario value
396 selects a multiplayer scenario by id. The default scenario id is
397 multiplayer_The_Freelands.
398 --side number:value
400 selects a faction of the current era for this side. The faction
401 is chosen by an id. Factions are described in the data/multi‐
402 player.cfg file.
403 --turns value
405 sets the number of turns for the chosen scenario. By default no
406 turn limit is set.
407
409 Normal exit status is 0. An exit status of 1 indicates an (SDL, video,
410 fonts, etc) initialization error. An exit status of 2 indicates an er‐
411 ror with the command line options.
412 When running unit tests (with -u), the exit status is different. An
413 exit status of 0 indicates that the test passed, and 1 indicates that
414 the test failed. An exit status of 3 indicates that the test passed,
415 but produced an invalid replay file. An exit status of 4 indicates that
416 the test passed, but the replay produced errors. These latter two are
417 only returned if --noreplaycheck is not passed.
418
420 Written by David White <davidnwhite@verizon.net>.
421 Edited by Nils Kneuper <crazy-ivanovic@gmx.net>, ott <ott@gaon.net> and
422 Soliton <soliton.de@gmail.com>.
423 This manual page was originally written by Cyril Bouthors
424 <cyril@bouthors.org>.
425 Visit the official homepage: https://www.wesnoth.org/
426
428 Copyright © 2003-2022 David White <davidnwhite@verizon.net>
429 This is Free Software; this software is licensed under the GPL version
430 2, as published by the Free Software Foundation. There is NO warranty;
431 not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
432
434 wesnothd(6)
435wesnoth 2022 WESNOTH(6)