Add documentation updates from Markus Maier.
authordolorous <dolorous@c06c8d41-db1a-0410-9941-cceddc491573>
Sat, 12 Jul 2008 22:11:49 +0000 (22:11 +0000)
committerdolorous <dolorous@c06c8d41-db1a-0410-9941-cceddc491573>
Sat, 12 Jul 2008 22:11:49 +0000 (22:11 +0000)
git-svn-id: https://crawl-ref.svn.sourceforge.net/svnroot/crawl-ref/trunk@6521 c06c8d41-db1a-0410-9941-cceddc491573

crawl-ref/docs/crawl_manual.txt
crawl-ref/docs/level_design.txt
crawl-ref/docs/macros_guide.txt
crawl-ref/docs/quickstart.txt
crawl-ref/source/dat/database/rand_wpn.txt
crawl-ref/source/dat/descript/ability.txt
crawl-ref/source/dat/descript/skills.txt
crawl-ref/source/util/docs/quickstart.tex

index 2367ae9..a0131ef 100644 (file)
@@ -2449,9 +2449,9 @@ level_map_title option to get rid of that.
     ?                   Level map help.
     -                   Scroll level map up
     +                   Scroll level map down
-    Direction           Move cursor.
-    Shift-Direction     Move cursor in bigger steps (check the option
-    or / Direction      level_map_cursor_step).
+    direction           Move cursor.
+    Shift-direction     Move cursor in bigger steps (check the option
+    or / direction      level_map_cursor_step).
     .                   Travel to cursor (also Enter, Del and , and ;)
                         (if the cursor is on the character, move cursor
                         to last travel destination instead).
@@ -2488,7 +2488,7 @@ It lets you have a look at items or monsters in line of sight. You may
 also examine stashed items outside current view using the option
 target_oos = true (if using this, check the option target_los_first).
     x, Esc, Space       Return to playing mode.
-    ?    ?              Special help screen.
+    ?                   Special help screen.
     * or '              Cycle objects forward.
     / or ;              Cycle objects backward.
     + or =              Cycle monsters forward.
@@ -2531,7 +2531,7 @@ work, with the exception of Space (which fires).
                         change missiles according to your launcher; i.e.
                         when wielding a bow, ( and ) will cycle through
                         all stacks of arrows in your inventory.
-    Shift-Direction     Fire straight in that direction. You can go
+    Shift-direction     Fire straight in that direction. You can go
                         back to the old targeting mode (allowing
                         straight firing by pressing just the direction
                         key) using the option target_unshifted_dirs.
@@ -2551,7 +2551,7 @@ following, if an item is already selected, the key will deselect it
     %                   Select all food.
     &                   Select all carrion.
     + or :              Select all books.
-    /    /              Select all wands.
+    /                   Select all wands.
     \ or |              Select all staves.
     !                   Select all potions.
     =                   Select all rings.
index f2d0aaa..1eb7613 100644 (file)
@@ -21,6 +21,7 @@ the dat directory. If you are interested in adding some vaults, say, start
 with the existing ones and modify them. Currently, the following .des files
 are in use:
 
+ altar.des    - minivaults containing altars
  bazaar.des   - entrances to bazaar portal vaults, and bazaars proper
  crypt.des    - Crypt:5, Tomb:1, Tomb:2, Tomb:3
  elf.des      - Elf:7
@@ -199,7 +200,7 @@ Features
  ~ - random trap suitable for the branch and depth the map is being used.
 
  A - Vestibule gateway (opened by Horn).
- B - Altar. These are assigned specific types (eg of Zin etc) in dungeon.cc,
+ B - Altar. These are assigned specific types (e.g. of Zin etc) in dungeon.cc,
      in order.
  C - Random Altar.
 
@@ -216,8 +217,8 @@ Features
 Note: Due to the level maker having seen incremental improvements over
 the years, there are some inconsistencies. For examples, dangerous
 statues (orange, silver, ice) are now genuine monsters. In particular,
-the 'H' and 'S' glyphs should be dispensed with (but many older vaults
-use them, of course) - especially as there's no glyph for ice statues.
+you might see many older vaults still using the deprecated 'H' and 'S'
+glyphs which should otherwise be dispensed with.
 
 Also, the most of the other feature glyphs can be replaced with KFEAT:
 lines. The same goes for some item glyphs ('R', 'Z') which
@@ -639,7 +640,7 @@ NSUBST:   ? = 3:w / *:l
           This is equivalent to SUBST: ? = w .:15 A for three ? and
           SUBST: ? : =+CF for all the others.
 
-          You use any number of NSUBST specifiers:
+          You can use any number of NSUBST specifiers:
 
           ? = wW / l / A / 1234
 
@@ -1115,7 +1116,7 @@ G.    Hints for level makers
   very very often, so even small chances of something stupid happening
   (like creation of a really nasty monster) will kick in often enough.
 
-* Minivaults vs random vaults.
+* Minivaults vs. random vaults.
   Minivaults are handled very differently from regular vaults and special
   levels. They're placed *after* normal map generation, whereas normal
   vaults are placed before generating the rest of the level. There's no
index 252db61..adeb5d5 100644 (file)
@@ -52,14 +52,13 @@ and keymaps, press '~' and then 's' to save macros at the tilde prompt).
 The macro.txt file
 ==================
 
-Macros and keymaps are stored in a file called macro.txt in your main
-Crawl directory or your home directory. You can change where the file
-is read from and written to by specifying an alternate directory on
-the command line with -macro <dir> or with the crawl_dir option in your
-init file (see crawl_options.txt for details). The macro.txt file is
-human readable and editable, but you might have to figure out the key
-codes for non-alphanumeric keys through in-game experimentation or
-external utilities.
+Macros and keymaps are stored in a file called macro.txt in your
+settings/ directory. You can change where the file is read from and
+written to by specifying an alternate directory with the macro_dir
+option in your init file (see options_guide.txt for details). The
+macro.txt file is human readable and editable, but you might have to
+figure out the key codes for non-alphanumeric keys through in-game
+experimentation or external utilities.
 
 Lines beginning with the '#' are comments and will be ignored. Note
 that Crawl won't necessarily preserve your comments when saving macros
@@ -118,7 +117,7 @@ set to true (it is by default; see crawl_options.txt for details).
 
 # Tab: Order allies to attack your previous or the nearest target
 M:\{9}
-A:!a.
+A:ta.
 
 
 Conjurers need a slightly different macros for casting, such as this
index b6f9ef9..3daff9f 100644 (file)
@@ -3,11 +3,13 @@
 
 So, you want to start playing Crawl straight away without bothering with the 
 manual? Read this, the guide to starting Crawl with a minimum of preparation. 
-When you get some more time, you can read crawl_manual.txt in the /docs 
-directory for more detailed information.
 
-I suggest printing it out and following its instructions while playing your 
-first few games (you can also press '?' while playing for a list of commands). 
+I suggest printing it out and following its instructions while playing your
+first few games (you can also press '?' twice while playing for a list of
+commands).
+
+When you get some more time, you can read crawl_manual.txt in the docs/
+directory for more detailed information.
 
  INTRODUCTION TO CRAWL 
 
@@ -46,7 +48,7 @@ Now you are in the game. The game screen has three parts:
 
 Try walking around, using either the numeric keypad (try numlock off and on) or 
 the Rogue (hjklyubn) keys. To move in a given direction until you reach 
-something interesting or see a hostile creature, press shift and the direction. 
+something interesting or see a hostile creature, press Shift and the direction.
 
 If you want to know what a certain character on the screen represents, you can 
 use the 'x' (examine) command to get a short description. You use the 'O', 'C' 
@@ -64,7 +66,7 @@ command, which uses the whole screen.
  ITEMS 
 
 After walking around for a while, you will no doubt come across some items 
-laying around (you may come across some monsters as well; for help in dealing 
+lying around (you may come across some monsters as well; for help in dealing
 with them skip to the Monsters section). You can pick up items with the 'g' 
 (get) or ',' commands and drop them again with 'd' (drop), and the 'i' 
 (inventory) command shows you what you're carrying. 
@@ -72,38 +74,37 @@ with them skip to the Monsters section). You can pick up items with the 'g'
 There are several different types of items: 
 
  - Weapons, represented by the ) sign. Wield them with the 'w' (wield) 
-command. Some weapons are cursed and cannot be un-wielded without the use of 
-magic.
+   command. Some weapons are cursed and cannot be un-wielded without the use of
+   magic.
 
  - Armour ([). Wear it, or take it off, with the 'W' (Wear) command. Heavier 
- armours give more protection, but may hamper your ability to fight and to 
- dodge attacks aimed at you. These can also be cursed.
+   armours give more protection, but may hamper your ability to fight and to
+   dodge attacks aimed at you. These can also be cursed.
 
  - Ammunition (which has the ( sign). Throw it with 'f' (fire). Darts are 
-meant to be thrown by hand; other missiles need an appropriate launcher to be 
-wielded (eg arrows are much more effective when shot with a bow).
+   meant to be thrown by hand; other missiles need an appropriate launcher to
+   be wielded (e.g. arrows are much more effective when shot with a bow).
 
  - Wands (/), Scrolls (?) and Potions (!) can be very valuable, but have 
-limited uses (scrolls and potions can only be used once each, wands contain 
-only a certain number of charges). Wands are 'Z'apped, scrolls are 'r'ead and 
-potions are 'q'uaffed.
- Unfortunately, you won't at first know what a wand, scroll or potion does; it 
-will only be described by its physical appearance. But once you have used, for 
-example, a potion of healing, you will in future recognise all potions of 
-healing. 
+   limited uses (scrolls and potions can only be used once each, wands contain
+   only a certain number of charges). Wands are 'Z'apped, scrolls are 'r'ead
+   and potions are 'q'uaffed. Unfortunately, you won't at first know what a
+   wand, scroll or potion does; it will only be described by its physical
+   appearance. But once you have used, for example, a potion of healing, you
+   will in future recognise all potions of healing.
 
  - Rings (=) and Amulets (") often contain powerful magic, but it can be 
-difficult to work out exactly what one does. They are put on with 'P' (put on) 
-and can be removed with the same command, or also with 'R'. They can, like 
-weapons, be cursed. 
+   difficult to work out exactly what one does. They are put on with 'P' (put
+   on) and can be removed with the same command, or also with 'R'. They can,
+   like weapons, be cursed.
 
  - Food (%) is vital to your survival. Eat it with the 'e' (eat) command when 
-hungry. Monsters' corpses, also %, can be eaten if chopped up (the 'c' ommand),
-but not all of them are healthful, and many species of player-character dislike
-eating raw flesh unless very hungry. 
+   hungry. Monsters' corpses, also %, can be eaten if chopped up (the 'c'
+   command), but not all of them are healthful, and many species of player
+   character dislike eating raw flesh unless very hungry.
 
  - Money ($) can be used to buy stuff in shops, and increases your score if 
-you escape. 
+   you escape.
 
 There are a few other types of items, but you will discover these as you play. 
 
@@ -131,7 +132,7 @@ To survive, you will need to develop a few basic tactics:
    you can run around in circles to heal while the monster chases you. 
  - Remember to use projectiles before engaging monsters in close combat.
  - Rest between encounters. The 's', '.', delete or keypad-5 commands make you 
-   rest for one turn, while pressing '5' or shift-and-keypad-5 make you rest 
+   rest for one turn, while pressing '5' or Shift-and-keypad-5 make you rest
    for a longer time (you will stop resting when fully healed). 
  - Learn when to run away from things you can't handle - this is important! 
    It is often wise to skip a dangerous level. But don't overdo this.
@@ -142,11 +143,12 @@ Before long, you'll probably end up dead.
  
 Death in Crawl is permanent; you cannot just reload a saved game and start again
 where you left off. The 'S' (save) command exists only to let you leave a game 
-part-way through and come back to it later. Quitting ('Q') lets you commit
+part-way through and come back to it later. Quitting ('Ctrl-Q') lets you commit
 suicide if you can't even be bothered to help your character escape alive. 
 
 Well, that's it for the quick-start guide. This should help you through your 
 first few games, but Crawl is extremely (some would say excessively) complex 
 and cannot be adequately described in so short a document. So when you feel 
 ready to start playing with magic, skills, and religions, browse the manual.
-Happy Crawling! 
+
+Happy Crawling!
index 48ba1cf..239ae31 100644 (file)
@@ -84,12 +84,12 @@ War
 
 Eternal War
 
-Eternal Warrior
+the Eternal Warrior
 
 # Lemuel's Suggestions
-Warrior
+the Warrior
 
-Doomed Warrior
+the Doomed Warrior
 
 # akrasiac patch
 the Pyrrhic Victory
@@ -798,7 +798,7 @@ the Spinneret
 
 Grontol
 
-With Two Names
+the Two Names
 
 # akrasiac patch
 Irrepressible Laughter
@@ -821,8 +821,6 @@ Giant
 Beetle
 
 Jelly
-
-@player_genus@
 %%%%
 monster_name
 
index b40790c..f7e8366 100644 (file)
@@ -253,7 +253,7 @@ your magical contamination and may eventually cause glowing.
 # Makhleb
 Minor Destruction
 
-Shoot a random harmful beam at the targetted monster.
+Shoot a random harmful beam at the targeted monster.
 %%%%
 Lesser Servant of Makhleb
 
@@ -262,7 +262,7 @@ skill.
 %%%%
 Major Destruction
 
-Inflict a random harmful beam or explosion on the targetted monster.
+Inflict a random harmful beam or explosion on the targeted monster.
 %%%%
 Greater Servant of Makhleb
 
index 17dac0d..a6058ca 100644 (file)
@@ -58,7 +58,7 @@ fight with all weapons of this type and make you deal more damage with
 them. It is generally recommended to concentrate your efforts on one or 
 two weapon types to become more powerful in them.
 
-Being skilled in Polearms eases training in Maces/Flails or Staves.
+Being skilled in Polearms eases training in Axes or Staves.
 %%%%
 Staves
 
index ac28e17..5b6a72e 100644 (file)
@@ -110,7 +110,7 @@ command, which uses the whole screen.
 \sex{Items} \para 
 
 After walking around for a while, you will no doubt come across some items 
-laying around (you may come across some monsters as well; for help in dealing 
+lying around (you may come across some monsters as well; for help in dealing 
 with them skip to the Monsters section). This table lists the most basic item
 types that appear and typical commands to use them:
 
@@ -118,8 +118,8 @@ types that appear and typical commands to use them:
 
 \begin{tabular}{cll}
 \sex{Symbol} & \sex{Item type (typical commands)} & \sex{Comments} \\
-\key{(}  & Weapons (\key{w}ield)                  & Move into monsters to attack them.\\
-\key{)}  & Missiles (\key{f}ire)                  & Wield a bow to fire arrows. Press \key{f?} for help.\\ 
+\key{)}  & Weapons (\key{w}ield)                  & Move into monsters to attack them.\\
+\key{(}  & Missiles (\key{f}ire)                  & Wield a bow to fire arrows. Press \key{f?} for help.\\ 
 \key{[}  & Armour (\key{W}ear and \key{T}ake off) & Can be cursed, like weapons and jewellery. \\
 \key{\%} & Food, corpses (\key{e}at and \key{c}hop up) & Dangerous chunks are coloured. \\
 \key{\$} & Gold                                   & There are shops down below. \\
@@ -129,7 +129,7 @@ types that appear and typical commands to use them:
 \key{"}  & Amulets (\key{P}ut on and \key{R}emove) & Amulets can be even subtler than rings. \\
 \key{/}  & Wands (\key{Z}ap)                      & Identify these by zapping at monsters. \\
 \key{+}  & Books (\key{r}ead, \key{M}emorise and \key{z}ap) & Press \key{z?} for information on spells.\\
-\key{$\backslash$} & Staves and rods (\key{w}ield and e\key{v}oke) \hspace{0.2em}
+\key{\char`\\} & Staves and rods (\key{w}ield and e\key{v}oke) \hspace{0.2em}
                                                   & Rods carry spells but they are very rare.
 %\key{\}} & Miscellaneous items (e\key{v}oke)      & These will turn up only later. \\
 \end{tabular}