diff options
author | Matthew Cline <zelgadis@sourceforge.net> | 2009-10-23 22:28:14 -0700 |
---|---|---|
committer | Matthew Cline <zelgadis@sourceforge.net> | 2009-10-23 22:28:14 -0700 |
commit | 9c08ad575dfa4fbfcbdff5280a582a7846094f60 (patch) | |
tree | 576b45acc07815c4413b8f4c920db7ce47ee5df6 /crawl-ref/docs | |
parent | 068459aa20c4a7c7abb759ca42a1caabf3e58750 (diff) | |
download | crawl-ref-9c08ad575dfa4fbfcbdff5280a582a7846094f60.tar.gz crawl-ref-9c08ad575dfa4fbfcbdff5280a582a7846094f60.zip |
Specify arbitrary options on the command line
This introduces two new command line options, -extra-opt-first and
-extra-opt-last, which make crawl think that the specified options were
(respectively) at the start and end of the options file. For example:
crawl -extra-opt-last wiz_mode=yes
The two options can be used multiple times to specify multiple options.
Diffstat (limited to 'crawl-ref/docs')
-rw-r--r-- | crawl-ref/docs/options_guide.txt | 53 |
1 files changed, 46 insertions, 7 deletions
diff --git a/crawl-ref/docs/options_guide.txt b/crawl-ref/docs/options_guide.txt index 65ea8d1def..d992fd7b27 100644 --- a/crawl-ref/docs/options_guide.txt +++ b/crawl-ref/docs/options_guide.txt @@ -10,8 +10,9 @@ The contents of this text are: 0- Generalities. 0-a Standard and additional option files. -0-b Options and how to set them. -0-c Aliases and variables. +0-b Options on the command line +0-c Options and how to set them. +0-d Aliases and variables. 1- Starting Screen. name, remember_name, use_old_selection_order, weapon, book, wand, chaos_knight, death_knight, priest, @@ -125,7 +126,7 @@ The contents of this text are: 7- Inline Lua. 7-a Executing lua. 7-b Conditional options. -7-c Including external files. +7-c Conditional option caveats. ------------------------------------------------------------------------ @@ -162,7 +163,21 @@ additional option files coming with this release; these allow to set many options to old defaults, i.e. those of Crawl 0.3.4 and before. See the header of the default init.txt for more details. -0-b Options and how to set them. +0-b Options on the command line +----------------------------------- + +A quick way to make small changes to the options, without having to +switch to a different option file, is to use the command line options +-extra-opt-first or -extra-opt-last, which make it as if the given +option was (repsecitvely) at the top or bottom of the option file. For +example, + + -extra-opt-last wiz_mode=yes + +will cause any new game to start in wizard mode. -extra-opt-first and +-extra-opt-last can be used multiple times on the same command line. + +0-c Options and how to set them. ------------------------------------ There are three broad types of Crawl options: true/false values @@ -208,7 +223,7 @@ are as follows: and, for Tiles, tile_tag_pref = tutorial -0-c Aliases and variables. +0-d Aliases and variables. ------------------------------ For long option names, you can define option aliases by doing: @@ -2125,7 +2140,7 @@ function ch_autopickup(it) [ ... body omitted ... ] end You can use Lua to selectively include parts of your init.txt (based on character type, for instance) using the same syntax. -Examples: +Example: : if you.race() == "Mummy" then autopickup = $?+"/ @@ -2133,6 +2148,27 @@ autopickup = $?+"/ autopickup = $?+"/!% : end +Options can be rerefenced by lua via "options.option_name". For +example: + +:if string.find(options.autopickup, "!") then +# Do something here if potions are included in autopickup +:end + +"options.option_name" can even be used for options that crawl itself +doesn't recognize. This can be combined with setting options on the +command line (see section 0-b) to use the command line to control +conditionalization of options in the options files. For example, on the +command line you could set the option "foobar" with "-extra-opt-first +foobar=true", and then do: + +:if options.foobar then +# Do things here +:end + +7-c Conditional option caveats. +----------------------------------- + Note that none of the options listed under "Starting Screen" (section 1) can be set conditionally. This is because the options files are actually read in twice: once before character creation with Lua turned @@ -2141,4 +2177,7 @@ you attempt to set a starting-screen option conditionally then the value furthest down in the options file will be used regardless of what conditions you set. -The above caveat applies to the "wiz_mode" option as well. +The above caveat applies to the "wiz_mode" option as well. Instead of +conditionalized wiz_mode, you can add to the command line +"-extra-opt-last wiz_mode=yes" to make any new game start in wizard +mode. |