OSDN Git Service

[Refactor] flags# を削除
[hengbandforosx/hengbandosx.git] / readme-eng.md
index f23b549..b3d15bf 100644 (file)
-# Caution
 
-This readme is very old, so I will update it later.
+* [日本語](/readme.md)
 
-# How to install
+# What is Hengband?
 
-##  UNIX
+A dungeon-crawler where you descend down a dungeon fighting hordes of monsters, getting stronger and trying to stay alive.
 
-Download source archive and try...
+# How to install
 
-> tar -zxvf hengband-x.x.x.tar.gz
-> cd hengband-x.x.x
-> ./configure --disable-japanese
-> make install
+## Windows
 
-Substitute the version number to x.x.x.
-You need --disable-japanese option of the configure for English version.
-If you are a super user, --with-setgid=games option works.
-then try
+ * Download the latest binaries from [Releases](https://github.com/hengband/hengband/releases) - look for a `.zip` archive.
+ * Unpack the archive in the directory of your choosing.
+ * Double click on `Hengband.exe` to start the game.
 
-> ./hengband -- -n<number of windows>  ## for normal ASCII graphics
+**Note:** The first time you try Windows Smartscreen may ask you if you want to run this software. To bypass it you need
+to first click on the text link *More info* and then the button *Run anyway*
 
-  or
+### Menu bar:
 
-> ./hengband -g -- -n<# of windows>    ## for 8x8 tile graphics 
-> ./hengband -g -- -b -n<# of windows> ## for Bigtile graphics
-> ./hengband -g -- -a -n<# of windows> ## for 16x16 tile (need heng_graf.tar.gz)
+Some elements of the interface and game can be customized using the menu bar:
 
-  to play.
+ * **Sound Effects:** Options -> Sound
+ * **Music:** Options -> Music
+ * **Background image:** This will display an image in the background of the game.
+   * Options -> Background image -> None - disable the background
+   * Options -> Background image -> Custom - image selected by you (on first select will prompt you to select a file)
+   * Options -> Background image -> Change custom image - changes the selected Custom image
 
-You can change game windows' font, location, and size, by environment 
-variables.
+## UNIX
 
-Ex.
+Download the latest version of the source files from [Releases](https://github.com/hengband/hengband/releases). Then run the following commands:
 
-> setenv ANGBAND_X11_FONT '-*-*-medium-r-normal--24-*-*-*-*-*-iso8859-1'
-> hengband -- -n
+```
+tar -jxvf hengband-x.x.x.tar.bz2
+cd hengband-x.x.x
+./configure --disable-japanese
+make install
+```
 
-Then font size will be changed.
+**Please note:**
 
-You can set ANGBAND_X11_FONT_n for specific window which have window number n.
+ * Replace `x.x.x` with the downloaded version's number.
+ * `--disable-japanese` is required to build English version, remove it if you want to build Japanese version.
 
-Location of windows are ANGBAND_X11_AT_X_n, and ANGBAND_X11_AT_Y_n.
-Size of windows are ANGBAND_X11_COLS_n, and ANGBAND_X11_ROWS_n.
+To run in ASCII mode:
 
+```
+./hengband -- -n <number of windows>
+```
 
-## Windows
+To run in the graphical mode:
 
-Download the binary archive for Windows.
-Unzip it, and click hengband to play.
-
-The makefile.bcc was changed again.
-If you want to compile from the source with borland compiler (BCC),
-Comment out options for japanese; 'JP_OPT = ...' and 'ANGBAND_RC = ...' 
-in makefile.bcc, and un-comment the line 'ANGBAND_RC = ang_eng.rc'.
-
-
-# Basic for Playing
-
- We recommend that you go to the Yeek cave next to your starting position 
-in the town of Outpost.  Although the King of Yeeks at the lowest level is a 
-fierce enemy, the rest of the cave should be fairly safe.  Once you complete 
-this dungeon, you will be strong enough to leave Outpost in search of greater 
-adventures.  Carry lots of food and fuel, for the journey can be a long one.  
-Since this world is very large, it is convenient to go into global map mode by 
-pressing the '<' key, and then return to local map mode by '>' key when you are 
-at the destination.  When in the wilderness, stay in safe grids such as roads 
-or plains; seas and lava fields are best avoided for a while.
-       Many towns and dungeons await you; good ones to explore early on include 
-the orc caves and the Labyrinth.  To the northeast of the town of Morivant, 
-near the center of the map, is the dread dungeon of Angband.  It is home to the 
-Serpent of Chaos, whom you must kill in order to win the game.
-
-
-## Commands
-
- Please read on-line help (Press the ? key in the game) for full
-information of the game.  Here are only descriptions of basic commands.
-
- The following section lists most commands, and the less frequently used 
-ones may be accessed by pressing the return key, or (if using the original 
-keyset) the 'x' key, to bring up the command menu.  Almost any command may be 
-chosen from the main menu.  "(R) Rest" can be performed by pushing 'R' (in 
-uppercase).  "Look around (l/x)" can be performed by pushing 'l' in the Original 
-keyset, and by pushing 'x' in the Rogue-like keyset.
-
-* [Movement]
-
->     Original Keyset Directions
->
->              7  8  9
->              4     6
->              1  2  3
->
->     Roguelike Keyset Directions
->
->              y  k  u
->              h     l
->              b  j  n
-
-   *  5/, Stay still
-   *  <   Go up staircase or Enter global map mode in the wilderness.
-   *  \>   Go down staircase or return from global map mode in the wilderness
-   *  Shift+direction   run
-   *  Ctrl+direction   attack, open, close, or dig
-* [Tools]
-   * r  Read a scroll
-   * q  Quaff a potion 
-   * u/Z  Use a staff
-   * a/z  Aim a wand
-   * z/a  Zap a rod
-   * E  Eat some food
-   * A  Activate an equipment
-   * F  Fuel your lantern/torch
-   * f/t  Fire a missile
-* [Action]
-   * d  Drop an item
-   * g  Pick up items
-   * R  Rest for a period
-   * o  Open a door or chest
-   * s  Search for traps/doors
-   * k/Ctrl+d  Destroy an item
-* [Magic]
-   * m  Cast a spell / use mental power
-   * G  Gain new spells/prayers
-   * U/O  Use bonus power
-   * b/P  Examine spells (choose each spell to get a description)
-* [Equipment] 
-   * w  Wear/wield equipment
-   * t  Take off equipment
-   * F  Fuel your lantern/torch
-* [Info] 
-   * x  Examine items in a store
-   * C  Character description
-   * I  Examine an *identified* item
-   * i  Inventory list
-   * l/x  Look around
-   * M  Full dungeon map
-   * ~  Display various information
-*  [Other]
-   * p  Command pets
-   * =  Set options
-   * $  Reload auto-picker preference file
-   * _  Edit auto-picker preference
-   * n/[  Repeat previous command
-   * @  Interact with macros
-*  [Help]
-   * ?  View the on-line help (Press a-z to choose a section,  space key to go next page.)
+```
+./hengband -g -- -n <number of windows> # 8x8 Tiles
+./hengband -g -- -b -n <number of windows> ## double width size tiles
+./hengband -g -- -a -n <number of windows> ## 16x16 tiles (tiles of this size are not provided)
+```
 
+### Install with `setgid`
 
-## Inscriptions
-
-Below, only the new features in Hengband are explained.
+Run the following:
 
-* You can inscribe on objects with "@ma" or '@'+<any command letter>+<any tag>. Then, type these alphabet letter in 'm' command to cast from the spellbook.
-* The inscriptions "@1" or '@'+<any tag number> make the objects able to be used by pressing <tag number> key in any command.  Any alphabet key cannot be used as a tag in this form.
-* You can inscribe on *identified* items with "%" or "%all". Then, "%" or "%all" is automatically replaced by strings which describe the item's abilities. 
-** Example:  You inscribe with "%all" on a pair of gauntlets of power which provide resistance to fire. The description will look like {St;Fi} which means bonus to Strength and resistance to fire. If you inscribe it with "%", its description will look like {Fi} which means its random added ability is resistance to fire.
+```
+./configure --disable-japanese --with-setgid=games
+make
+```
 
-## Auto pickup/destroy
+Running the following as root or with the sudo command will install the game into `/usr/local`:
 
-Hengband offers two different methods of auto-pickup/destroy.
+```
+make install
+```
 
-### Powerful method
-* Hengband offers a very powerful auto-pickup/auto-destroy system which you may customize.  Press   *  '_' key to enter edit mode.  Please read the file "autopick_eng.txt" about the syntax.
+See `./configure --help` for more information about changing the installation location and other options.
 
-### Easy method
-* Since the powerful method is slightly difficult to use effectively, there is another very easy option. you can turn on 
-* the destroy_items option and/or the always_pickup option to use this method.  These options are located in (6) Easy Auto-Destroyer Options and (1) Input Options in the Set options ('=') command.
+### Configuring display
 
-## Tile graphics, Big tile, and Big screen
 
-### Tile graphics
+The default font used in the main window is:
 
-  To use graphics mode, choose it from menu for Windows and Mac, or
-  use -g option for Linux.  There are 8x8 size old tile and 16x16 size
-  Adam bolt tile, and you can change from menu for Windows and Mac, or
-  use -- -a option to use 16x16 tile for Linux.  Since source archive
-  doesn't include 16x16 size tile, you need to download the
-  heng_graf.tar.gz.
+>  "-*-*-medium-r-normal--24-*-*-*-*-*-iso8859-1,-*-*-medium-r-normal--24-*-*-*-*-*-jisx0208.1983-0"
 
-### Big tile (Double-width tile)
+The default font used in the sub windows is:
 
-  In the Big tile mode, graphic tile have double width, and become
-  square.  You can choose Bigtile from menu for Windows and Mac, or
-  use -- -b option for Linux.
+> "-*-*-medium-r-normal--16-*-*-*-*-*-iso8859-1,-*-*-medium-r-normal--16-*-*-*-*-*-jisx0208.1983-0"
 
-### Big screen
+These can be controlled by setting environment variables:
 
-  You can resize each window using mouse, which allow you to have
-  terminal windows larger than 80x24.  On linux, it's convenience to
-  use environment variables: ANGBAND_X11_COLS_0 and
-  ANGBAND_X11_ROWS_0.
+ * `ANGBAND_X11_FONT_<?>` - Sets the font for a specific window, from 0 to 7, eg `ANGBAND_X11_FONT_0`
+ * `ANGBAND_X11_FONT` - Sets the font for all the remaining windows
 
-## Play Record
+You can also change other window properties:
 
-Play record will be written to a file named 'playrec-<character's name>.txt' 
-in the same directory as your user preference file.  It is in ~/.angband/
-Hengband/ for UNIX, or hengband/lib/user/ for other OS.
-'|' command displays play record in the game.
+ * `ANGBAND_X11_AT_X_<?>` - X position of a window
+ * `ANGBAND_X11_AT_Y_<?>` - Y position of a window
+ * `ANGBAND_X11_COLS_<?>` - Width of the window in *half-characters*
+ * `ANGBAND_X11_ROWS_<?>` - Height of the window in *half-characters*
 
-## World score
+### Other notes
 
-When You die, or retire, you can register a score to the world 
-score sever through the Internet. 
-However, please do not register a score, if you have cheated 
-by modifying data or source files, or by restoring from a backed 
-up savefile.
+When using **XIM** with **XFree86 4.0** you need to set the environment variable `XMODIFIERS` to either `@im=skkinput` or `@im=kinput2`.
+
+
+# Getting started
+
+Hengband is a roguelike game that has its roots in Moria, originally released in 1988. Across hundreds of updates
+and many variants the game grew in complexity. At first playing it might seem complicated, confusing and impenetrable,
+especially with no fancy graphics, but the basics are very easy to learn.
+
+## Character creation
+
+Once you start Hengband you'll want to use File -> New in the menu and create your first character.
+For the start we recommend:
+
+ * **Sex:** any
+ * **Race:** dwarf, so that you can survive more
+ * **Class:** warrior, as it's simple to play
+ * **Personality:** ordinary, to keep things simple
+ * **Birth options:** do not modify anything, press `Escape`
+ * **Autoroller stats:** do not change anything, use arrows to select *Accept* and press `Enter`
+ * **Rolling stats:** keep hitting `r` to reroll your stats, *s* to toggle between last two rolls,
+  *Enter* once you're happy with your stats. It's a good idea to reroll a few times until you get
+  good amount of Hit points is higher than an average roll
+ * **Name:** give your character a name you'll like staring at.
+ * **Character background:** you can edit the character background or leave it as-is (it has no
+  gameplay effect). Press `Enter` when ready.
+ * **Summary:** At this point you can either hit `S` to start over, `Q` to quit or `Enter` to begin the game.
+
+## How to move and act
+
+ * Use numeric keyboard to move your character in eight directions, and press 5 to wait a turn.
+ * Walk into enemies to attack them with your melee weapon.
+ * Attacking and killing enemies will give you experience, which in turn lets you level up and get stronger.
+ * Walk up/down the stairs using `<` and `>`.
+
+## What to do first
+
+ * A good first step is to exchange Wooden Torches you start with to Brass Lanterns:
+   * Step into the General Store (step on the brown number 1, it's the entrance).
+   * Hit `s` and sell the Torches.
+   * Hit `b` to buy and chose Brass Lanterns.
+   * When asked for quantity type `1`.
+   * Hit `Enter` to quickly accept the price and buy the lantern.
+   * Hit `Escape` to leave the shop.
+   * Hit `w` to wear and select the purchased lantern.
+ * It might also be a good idea to buy one or two Flasks of Oil from the same shop. Use command `F` to fuel
+   the lantern.
+ * Next it's advised you go slightly East of the entrance to the town into Yeek Cave. Step on purple `>`
+   and press that same key on your keyboard to enter the dungeon.
+ * Explore, kill monsters, collect items, go back to town to sell those items and buy better equipment.
+   The world is yours to explore!
+
+## Good to know
+
+ * When in town you can leave it to enter the wilderness. You can also enter the overworld map by pressing `<`, though
+   keep in mind you can be ambushed and you'll use a lot of food there.
+ * If you die you die forever. Next time you'll need to either restart with the same character or a create a new one.
+   If you don't like playing that way, there are two ways to work around this:
+   * Open options `=` -> Gameplay Options then toggle *Allow use of debug/cheat options*, then go back to list of options
+     -> Cheat Options and toggle *Allow player to avoid death*
+   * Manually backup saves under `lib/save/` and restore the backups when you die.
+   * Permadeath is seen as part of the fun as it greatly raises the stakes and causes you to play differently. But it
+     can be very frustrating too, especially when you're still learning.
+
+## Controls
+
+At any point in game you can press `?` to open the help. A grouped list of actions can be displayed by pressing `Enter`.
+
+ * **[Movement]**
+   * `Numeric Keyboard` - Move around
+   * `Numeric 5` - Stay still
+   * `Shift+direction` - Run
+   * `Ctrl+direction` - Attack/Open/Close/Dig in that direction
+   * `<` - Go up stairs/Enter the overworld map
+   * `>` - Go down stairs/Leave the overworld map
+ * **[Tools]**
+   * `a` - Aim a wand
+   * `A` - Activate special power of an equipped item
+   * `E` - Eat food
+   * `f` - Fire a missile
+   * `F` - Fuel your torch/lantern
+   * `r` - Read a scroll
+   * `u` - Use a staff
+   * `q` - Quaff a potion
+   * `v` - Throw an item
+   * `z` - Zap a rod
+ * **[Actions]**
+   * `d` - Drop an item
+   * `g` - Pick up an item (You can also enable Auto Pickup in Options -> Input Options -> Pick things up by default)
+   * `l` - Destroy an item
+   * `o` - Open a door or chest
+   * `R` - Rest for a period (The default option `&` rests until you are fully rested)
+   * `s` - Search for traps/doors around you
+   * `S` - Toggle Search mode, where you act slower but keep looking on each move
+ * **[Magic]/[Abilities]**
+   * `b` - Examine spells/prayers/mental powers
+   * `G` - Gain new spells/prayers/mental powers
+   * `m` - Cast a spell/use a mental power
+   * `U` - Use a special power
+ * **[Equipment]**
+   * `t` - Take off an equipped item
+   * `w` - Wear/wield an item
+ * **[Info]**
+   * `C` - Character information
+   * `e` - Display equipped items
+   * `i` - Display inventory
+   * `I` - Displays information about an \*identified* item
+   * `l/*` - Inspect tiles
+   * `L` - Inspect the map around you
+   * `M` - Show full dungeon map
+   * `~` - Display various information
+ * **[Other]**
+   * `@` - Setup macro and keymaps
+   * `=` - Change options
+   * `$` - Reload auto-picker preferences
+   * `_` - Edit auto-picker preferences (Auto-picker only works when *Pick things up by default* is disabled)
+   * `n` - Repeat previous command
+
+## Item notation
+
+* `(XdY)`
+  * Notation used for melee weapons, indicates the base damage dice of the weapon.
+  * The total damage is X rolls of Y-sided dice. For example:
+    * `1d12` is damage range of 1-12, average 6.5 damage
+    * `2d6` is damage range of 2-12, average 7 damage
+    * `3d4` is damage range of 3-12, average 7.5 damage
+* `(+h,+d)`
+  * Usually used in melee weapons, but can sometimes appear on other equipment as well.
+  * `+h` indicates the bonus to accuracy of a melee attack.
+  * `+d` indicates the bonus to damage of a melee attack.
+  * Either parameter can be negative.
+  * Some heavy armor will omit `+d` and only display something like `(-2)` indicating a negative bonus to accuracy.
+* `[a,+b]` or `[+b]`
+  * Used on armor.
+  * `a` indicates the natural increase to AC of the piece of armor.
+  * `+b` indicates the magical bonus.
+* `(+p)` or `(+p Noun)`
+  * Indicates a modifier to item's unique effect.
+  * For example, in case of a *Ring of Damage* it indicate the bonus to damage.
+  * `Noun` is used in weapons and armors, telling what the bonus is for.
+* `(xN)`
+  * Notation used in projectile weapons.
+  * `N` is the damage multiplier for projectiles.
+
+### Example 1: Dagger (2d4) (+10,+15) [+2] (+3)
+
+ * `(2d4)` - Base damage dice
+ * `(+10,+15)` - +10 accuracy bonus, +15 damage bonus
+ * `[+2]` - Magically increases AC by +2
+ * `(+3)` - Power of the special ability of this dagger, which can be known after \*Identifying* (or researching) it.
+
+### Example 2: Elven Chainmail (-2) [14,+12] (+3 Stealth)
+
+ * `(-2)` - -2 accuracy bonus
+ * `[14,+12]` - 14 base AC bonus, +12 magical AC bonus
+ * `(+3 Stealth)` - Increases Stealth stat by 3
+
+
+# Advanced play
+
+## Macros
+
+You will often find yourself repeating the same combination of keypresses multiple times during your game, things like
+shooting at the closest target with your bow or casting a bunch of buffs on yourself at once. Macros allow you to
+do that with one keypress.
+
+* Press `@` to open *Interact with Macros* page.
+* You have two options here:
+  * **Macros** are a number of keys pressed in sequence, that will trigger some action. For example setting it to `lpo`
+    would require you to press keys `l`, `p` and `o` in quick succession to trigger the effect.
+  * **Keymaps** define a new behavior for a single keypress. It's advised to use keys which normally have no mapping (
+    the easiest way to find those is to just keep pressing keys on your keyboard and see which one shows gibberish).
+* Now to create your new macro/keymap:
+  * Press the key for either *Create a macro* or *Create a keymap*
+  * Press the key sequence/key you want to assign a new action
+  * Type the sequence of actions you want to trigger
 
-The score server is here:
-  http://hengband.sourceforge.jp/en/score.html
+## Inscriptions
 
+Items can be inscribed to add notes but also to trigger special behavior. Below is a list of special inscriptions:
+
+ * `=g`
+    * Will auto-pick these items from the floor.
+    * Most convenient on ammunition or items you throw.
+    * Takes priority over Auto-Picker - even if it'd normally destroy the object, with this inscription the item will
+      be picked up
+ * `#<NAME>`
+    * Displays the name as if it was an artifact name of the item.
+    * For example: **a Broad Sword (2d5) (+0,+0)** inscribed with `#of Yeeks` will be displayed as **a Broad Sword of Yeeks (2d5) (+0,+0)**
+ * `@X?`
+    * Allows you to use a shortcut to access the item with a given command regardless of the position of the item in your inventory.
+    * `X` is the command, eg `f`
+    * `?` is a character you'll type to access the item. Can be a number or a letter.
+    * For example: Tagging arrows with `@f1` will allow you to add a macro `f1*t` to Fire, select those arrows, target closest, fire.
+ * `@?`
+    * Similar to the above, but affects all commands.
+    * `?` must be a number
+ * `!X`
+    * Prevents accidentally using the item with the specified command.
+    * Trying to use the item with specified command will ask you if you really want to do that.
+    * If you mark it with `!*` it will work for all commands.
+ * `.`
+    * Will prevent "Do you want to teleport?" confirmation from appearing if triggered by the inscribed item.
+ * `$`
+    * Disables warnings generated by the inscribed item.
+ * `^X`
+    * Similar to `!X` but affects equipped items.
+ * `%%` or `%%all`
+    * Inscribing an item with these will replace the inscription with a list of resistances and abilities of the
+      inscribed weapon or armor.
+    * It will only display known resistances and abilities - an item has to be either \*Identified* or researched.
+    * `%%` will only display resistances and abilities which are not directly known from item's ego type.
+
+You can combine multiple inscriptions. For example `@w0@t1!k!k!d#of Corwin` will:
+
+ * Use `0` with command `w` to equip the item
+ * Use `1` with command `t` to take off the item
+ * Require two confirmations if you try to destroy it
+ * Require a confirmation if you try to drop it
+ * Will display the item as if it was named *of Corwin*