* [日本語](/readme.md)
+# What is Hengband?
+
+A dungeon-crawler where you descend down a dungeon fighting hordes of monsters, getting stronger and trying to stay alive.
+
# How to install
## Windows
* 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 chosing.
+ * Unpack the archive in the directory of your choosing.
* Double click on `Hengband.exe` to start the game.
**Note:** The first time you try Windows Smartscreen may ask you if you want to run this software. To bypass it you need
```
tar -jxvf hengband-x.x.x.tar.bz2
cd hengband-x.x.x
-./configure
+./configure --disable-japanese
make install
```
**Please note:**
* Replace `x.x.x` with the downloaded version's number.
- * `--disable-japanese` option is required to build English version.
+ * `--disable-japanese` is required to build English version, remove it if you want to build Japanese version.
To run in ASCII mode:
./hengband -- -n <number of windows>
```
-To run in graphical mode:
+To run in the graphical mode:
```
./hengband -g -- -n <number of windows> # 8x8 Tiles
./hengband -g -- -a -n <number of windows> ## 16x16 tiles (tiles of this size are not provided)
```
+### Install with `setgid`
+
+Run the following:
+
+```
+./configure --disable-japanese --with-setgid=games
+make
+```
+
+Running the following as root or with the sudo command will install the game into `/usr/local`:
+
+```
+make install
+```
+
+See `./configure --help` for more information about changing the installation location and other options.
+
+### Configuring display
+
+
+The default font used in the main window is:
+
+> "-*-*-medium-r-normal--24-*-*-*-*-*-iso8859-1,-*-*-medium-r-normal--24-*-*-*-*-*-jisx0208.1983-0"
+
+The default font used in the sub windows is:
+
+> "-*-*-medium-r-normal--16-*-*-*-*-*-iso8859-1,-*-*-medium-r-normal--16-*-*-*-*-*-jisx0208.1983-0"
+
+These can be controlled by setting environment variables:
+
+ * `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
+
+You can also change other window properties:
+
+ * `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*
+
+### Other notes
+
+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
* `A` - Activate special power of an equipped item
* `E` - Eat food
* `f` - Fire a missile
- * `F` - Fuel your torch/lanter
+ * `F` - Fuel your torch/lantern
* `r` - Read a scroll
* `u` - Use a staff
* `q` - Quaff a potion
* `l/*` - Inspect tiles
* `L` - Inspect the map around you
* `M` - Show full dungeon map
- * `~` - Display verious information
+ * `~` - Display various information
* **[Other]**
* `@` - Setup macro and keymaps
* `=` - Change options
be picked up
* `#<NAME>`
* Displays the name as if it was an artifact name of the item.
- * For example: **a Broad Sword (+0,+0)** inscribed with `#Duckling` will be displayed as **a Broad Sword Duckling (+0,+0)**
+ * 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`
* `?` must be a number
* `!X`
* Prevents accidentally using the item with the specified command.
- * Tryng to use the item with specified command will ask you if you really want to do that.
+ * 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`
- * Similiar to `!X` but affects equipped items.
+ * 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#Duck` will:
+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 Duck
\ No newline at end of file
+ * Will display the item as if it was named *of Corwin*