nethack-gwaa-kiwi/nethack
1
0
Fork 0
Code Pull Requests Activity

Guidebook updates

Browse Source
This commit is contained in:
Michael Meyer
2022-10-27 10:40:54 -04:00
committed by nhmall
parent b70a3d198e
commit 19a02b7e18
2 changed files with 42 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/Guidebook.mn
+10 -6
View File
@@ -1812,7 +1812,7 @@ On other systems, if typing \(lqAlt\(rq plus another key transmits a
two character sequence consisting of an \fBEscape\fP two character sequence consisting of an \fBEscape\fP
followed by the other key, you may set the followed by the other key, you may set the
.op altmeta .op altmeta
option to have NetHack combine them into meta+key. option to have NetHack combine them into meta+<key>.
(This combining action only takes place when NetHack is expecting a (This combining action only takes place when NetHack is expecting a
command to execute, not when accepting input to name something or to command to execute, not when accepting input to name something or to
make a wish.) make a wish.)
@@ -1821,7 +1821,7 @@ Unlike control characters, where \(hax and \(haX denote the same thing,
meta characters are case-sensitive: M-x and M-X represent different things. meta characters are case-sensitive: M-x and M-X represent different things.
Some commands which can be run via a meta character require that the Some commands which can be run via a meta character require that the
letter be capitalized because the lower-case equivalent is used for letter be capitalized because the lower-case equivalent is used for
another command, so the three key combination meta+shift+letter is needed. another command, so the three key combination meta+Shift+<letter> is needed.
.BR 1 .BR 1
. .
.lp M-? .lp M-?
@@ -2003,18 +2003,21 @@ Other traps can send you to different locations.
Teleporters send you elsewhere on the same dungeon level. Teleporters send you elsewhere on the same dungeon level.
Level teleporters send you to a random dungeon level, the destination Level teleporters send you to a random dungeon level, the destination
chosen from a few levels lower all the way to the top. chosen from a few levels lower all the way to the top.
These traps choose a new destination each time they're activated.
Trap doors and holes also send you to another level, but one which is Trap doors and holes also send you to another level, but one which is
always below the current level. always below the current level.
Usually that will be the next level down but it can be farther. Usually that will be the next level down but it can be farther.
All of these traps choose a new destination each time they're activated. Unlike (level) teleporters, the destination level of a particular trap door
Magic portals also send you to a different level but behave differently. or hole is persistent, so falling into one will bring you to the same level
each time\(emthough not necessarily the same spot on the level.
Magic portals behave similarly, but with some additional variation.
Some portals are two-way and their remote destination is always the same: Some portals are two-way and their remote destination is always the same:
another portal which can take you back. another portal which can take you back.
Others are one-way and send you to a specific destination level but not Others are one-way and send you to a specific destination level but not
necessarily to a specific location there. necessarily to a specific location there.
.pg .pg
There is a special multi-level branch of the dungeon with pre-mapped levels There is a special multi-level branch of the dungeon with pre-mapped levels
based on the classic computer game \(lqSokoban.\(rq based on the classic computer game \(lq\fISokoban\fP.\(rq
In that game, you operate as a warehouse worker who pushes crates around In that game, you operate as a warehouse worker who pushes crates around
obstacles to position them at designated locations. obstacles to position them at designated locations.
In NetHack, the goal is to push boulders into pits or holes until those In NetHack, the goal is to push boulders into pits or holes until those
@@ -5613,7 +5616,8 @@ display of the customizations, such as the Enhanced symset.
Configuring NetHack for Play by the Blind Configuring NetHack for Play by the Blind
.pg .pg
NetHack can be set up to use only standard ASCII characters for making NetHack can be set up to use only standard ASCII characters for making
maps of the dungeons. This makes the MS-DOS versions of NetHack completely maps of the dungeons. This makes even the MS-DOS versions of NetHack
(which use special line-drawing characters by default) completely
accessible to the blind who use speech and/or Braille access technologies. accessible to the blind who use speech and/or Braille access technologies.
Players will require a good working knowledge of their screen-reader's Players will require a good working knowledge of their screen-reader's
review features, and will have to know how to navigate horizontally and review features, and will have to know how to navigate horizontally and
doc/Guidebook.tex
+32 -28
View File
@@ -1953,17 +1953,18 @@ the `Alt' key can be used in this fashion.
On other systems, if typing `Alt' plus another key transmits a On other systems, if typing `Alt' plus another key transmits a
two character sequence consisting of an {\tt Escape} two character sequence consisting of an {\tt Escape}
followed by the other key, you may set the {\it altmeta\/} followed by the other key, you may set the {\it altmeta\/}
option to have {\it NetHack\/} combine them into meta\+key. option to have {\it NetHack\/} combine them into {\tt meta+<key>}.
(This combining action only takes place when NetHack is expecting a (This combining action only takes place when NetHack is expecting a
command to execute, not when accepting input to name something or to command to execute, not when accepting input to name something or to
make a wish.) make a wish.)
%.pg %.pg
Unlike control characters, where \^x and \^X denote the same thing, Unlike control characters, where {\tt \^{}x} and {\tt \^{}X} denote the same
meta characters are case-sensitive: M-x and M-X represent different things. thing, meta characters are case-sensitive: {\tt M-x} and {\tt M-X}
Some commands which can be run via a meta character require that the represent different things. Some commands which can be run via a meta
letter be capitalized because the lower-case equivalent is used for character require that the letter be capitalized because the lower-case
another command, so the three key combination meta+shift+letter is needed. equivalent is used for another command, so the three key combination
{\tt meta+Shift+letter} is needed.
%.BR 1 %.BR 1
\blist{} \blist{}
@@ -2171,9 +2172,9 @@ A trap usually won't appear on your map until you trigger it by moving
onto it, you see someone else trigger it, or you discover it with onto it, you see someone else trigger it, or you discover it with
the `{\tt s}' (search) command (multiple attempts are often needed; the `{\tt s}' (search) command (multiple attempts are often needed;
if your luck is poor, many attempts might be needed). if your luck is poor, many attempts might be needed).
{\it Wands of secret door detection\/} and {\it spell of detect unseen\/} {\it Wands of secret door detection\/} and the spell of {\it detect unseen}
also reveal traps within a modest radius but only if the trap is also also reveal traps within a modest radius but only if the trap is also within
within line-of-sight (whether you can see at the time or not). line-of-sight (whether you can see at the time or not).
There is also other magic which can reveal traps. There is also other magic which can reveal traps.
%.pg %.pg
@@ -2193,11 +2194,14 @@ Other traps can send you to different locations.
Teleporters send you elsewhere on the same dungeon level. Teleporters send you elsewhere on the same dungeon level.
Level teleporters send you to a random dungeon level, the destination Level teleporters send you to a random dungeon level, the destination
chosen from a few levels lower all the way to the top. chosen from a few levels lower all the way to the top.
These traps choose a new destination each time they're activated.
Trap doors and holes also send you to another level, but one which is Trap doors and holes also send you to another level, but one which is
always below the current level. always below the current level.
Usually that will be the next level down but it can be farther. Usually that will be the next level down but it can be farther.
All of these traps choose a new destination each time they're activated. Unlike (level) teleporters, the destination level of a particular trap door
Magic portals also send you to a different level but behave differently. or hole is persistent, so falling into one will bring you to the same level
each time---though not necessarily the same spot on the level.
Magic portals behave similarly, but with some additional variation.
Some portals are two-way and their remote destination is always the same: Some portals are two-way and their remote destination is always the same:
another portal which can take you back. another portal which can take you back.
Others are one-way and send you to a specific destination level but not Others are one-way and send you to a specific destination level but not
@@ -2205,7 +2209,7 @@ necessarily to a specific location there.
%.pg %.pg
There is a special multi-level branch of the dungeon with pre-mapped levels There is a special multi-level branch of the dungeon with pre-mapped levels
based on the classic computer game ``{\tt Sokoban}.'' based on the classic computer game ``{\it Sokoban}.''
In that game, you operate as a warehouse worker who pushes crates around In that game, you operate as a warehouse worker who pushes crates around
obstacles to position them at designated locations. obstacles to position them at designated locations.
In NetHack, the goal is to push boulders into pits or holes until those In NetHack, the goal is to push boulders into pits or holes until those
@@ -2412,7 +2416,7 @@ spot or a tame one's spot.
%.\" getting away from "Movement feedback" here; oh well... %.\" getting away from "Movement feedback" here; oh well...
%.pg %.pg
The {\tt nopickup} command prefix (default `{\tt m}' is The {\tt nopickup} command prefix (default `{\tt m}') is
also the move-without-attacking prefix and can be used to try to step also the move-without-attacking prefix and can be used to try to step
onto a visible monster's spot without the move being considered an attack onto a visible monster's spot without the move being considered an attack
(see the {\it Fighting\/} subsection of {\it Monsters\/} below). (see the {\it Fighting\/} subsection of {\it Monsters\/} below).
@@ -3049,8 +3053,8 @@ A mail daemon may run up and deliver mail to you as a %
To use this feature on versions where {\it NetHack\/} To use this feature on versions where {\it NetHack\/}
mail delivery is triggered by electronic mail appearing in your system mailbox, mail delivery is triggered by electronic mail appearing in your system mailbox,
you must let {\it NetHack\/} know where to look for new mail by setting the you must let {\it NetHack\/} know where to look for new mail by setting the
``MAIL'' environment variable to the file name of your mailbox. {\tt MAIL} environment variable to the file name of your mailbox.
You may also want to set the ``MAILREADER'' environment variable to the You may also want to set the {\tt MAILREADER} environment variable to the
file name of your favorite reader, so {\it NetHack\/} can shell to it when you file name of your favorite reader, so {\it NetHack\/} can shell to it when you
read the scroll. read the scroll.
On versions of {\it NetHack\/} where mail is randomly On versions of {\it NetHack\/} where mail is randomly
@@ -3538,7 +3542,7 @@ in which you might accomplish them.
\blist{\leftmargin \achwidth \topsep 1mm \itemsep 0mm} \blist{\leftmargin \achwidth \topsep 1mm \itemsep 0mm}
%.PL Shop %.PL Shop
\item[{\tt <Rank>}] \item[{\tt <Rank>}]
Attained rank title <Rank>. Attained rank title {\it Rank}.
\item[{\tt Shop}] \item[{\tt Shop}]
Entered a shop. Entered a shop.
\item[{\tt Temple}] \item[{\tt Temple}]
@@ -3599,7 +3603,7 @@ Achievements are recorded and subsequently reported in the order in which
they happen during your current game rather than the order listed here. they happen during your current game rather than the order listed here.
%.pg %.pg
There are nine {\it <Rank>\/} titles for each role, bestowed at experience There are nine {\it Rank} titles for each role, bestowed at experience
levels 1, 3, 6, 10, 14, 18, 22, 26, and 30. levels 1, 3, 6, 10, 14, 18, 22, 26, and 30.
The one for experience level 1 is not recorded as an achievement. The one for experience level 1 is not recorded as an achievement.
Losing enough levels to revert to lower rank(s) does not discard the Losing enough levels to revert to lower rank(s) does not discard the
@@ -3631,7 +3635,7 @@ the Castle level's drawbridge or can be given to you via prayer boon.
%.pg %.pg
{\it Blind\/} and {\it Nudist\/} are also conducts, and they can only be {\it Blind\/} and {\it Nudist\/} are also conducts, and they can only be
enabled by setting the correspondingly named option in NETHACKOPTIONS enabled by setting the correspondingly named option in {\tt NETHACKOPTIONS}
or run-time configuration file prior to game start. or run-time configuration file prior to game start.
In the case of {\it Blind\/}, the option also enforces the conduct. In the case of {\it Blind\/}, the option also enforces the conduct.
They aren't really significant accomplishments unless/until you make They aren't really significant accomplishments unless/until you make
@@ -3652,7 +3656,7 @@ behaves.
Options may be set in a number of ways. Within the game, the `{\tt O}' Options may be set in a number of ways. Within the game, the `{\tt O}'
command allows you to view all options and change most of them. command allows you to view all options and change most of them.
You can also set options automatically by placing them in a configuration You can also set options automatically by placing them in a configuration
file, or in the ``NETHACKOPTIONS'' environment variable. file, or in the ``{\tt NETHACKOPTIONS}'' environment variable.
Some versions of {\it NetHack\/} also have front-end programs that allow Some versions of {\it NetHack\/} also have front-end programs that allow
you to set options before starting the game or a global configuration you to set options before starting the game or a global configuration
for system administrators. for system administrators.
@@ -3899,7 +3903,7 @@ Here is an example of configuration file contents:
%.BR 2 %.BR 2
%.hn 2 %.hn 2
\subsection*{Using the NETHACKOPTIONS environment variable} \subsection*{Using the {\tt NETHACKOPTIONS} environment variable}
%.pg %.pg
The NETHACKOPTIONS variable is a comma-separated list of initial The NETHACKOPTIONS variable is a comma-separated list of initial
@@ -6185,8 +6189,8 @@ display of the customizations, such as the Enhanced symset.
%.pg %.pg
{\it NetHack\/} can be set up to use only standard ASCII characters for making {\it NetHack\/} can be set up to use only standard ASCII characters for making
maps of the dungeons. This makes the MS-DOS versions of {\it NetHack\/} maps of the dungeons. This makes even the MS-DOS versions of {\it NetHack}
completely (which use special line-drawing characters by default) completely
accessible to the blind who use speech and/or Braille access technologies. accessible to the blind who use speech and/or Braille access technologies.
Players will require a good working knowledge of their screen-reader's Players will require a good working knowledge of their screen-reader's
review features, and will have to know how to navigate horizontally and review features, and will have to know how to navigate horizontally and
@@ -6201,16 +6205,16 @@ gives you the row and column of your review cursor and the PC cursor.
These co-ordinates are often useful in giving players a better sense of the These co-ordinates are often useful in giving players a better sense of the
overall location of items on the screen. overall location of items on the screen.
%.pg %.pg
{\it NetHack\/} can also be compiled with support for sending the game messages {\it NetHack\/} can also be compiled with support for sending the game
to an external program, such as a text-to-speech synthesizer. If the messages to an external program, such as a text-to-speech synthesizer. If
``{\tt \#version}'' extended command shows ``external program as a the ``{\tt \#version}'' extended command shows ``external program as a
message handler'', your {\it NetHack\/} message handler'', your {\it NetHack\/}
has been compiled with the capability. When compiling {\it NetHack\/} has been compiled with the capability. When compiling {\it NetHack\/}
from source from source
on Linux and other POSIX systems, define {\it MSGHANDLER\/} to enable it. on Linux and other POSIX systems, define {\tt MSGHANDLER\/} to enable it.
To use To use
the capability, set the environment variable {\it NETHACK\_MSGHANDLER\/} to an the capability, set the environment variable {\tt NETHACK\_MSGHANDLER\/} to
executable, which will be executed with the game message as the program's an executable, which will be executed with the game message as the program's
only parameter. only parameter.
%.pg %.pg