]> granicus.if.org Git - nethack/commitdiff
Guidebook update
authorPatR <rankin@nethack.org>
Fri, 14 Feb 2020 23:28:28 +0000 (15:28 -0800)
committerPatR <rankin@nethack.org>
Fri, 14 Feb 2020 23:28:28 +0000 (15:28 -0800)
This adds a new figure that shows the 3-line status.  Also expands
a couple of status items.

In the commands section, redo the hjkl direction diagram to make
"Figure 2" (now Figure 3) line up with the rest of the table.  Lot's
of trial and error involved, and the plain text version didn't come
out as expected (but still looks better than before).

Modify suit of armor table to wrap an additional line and make the
table narrower.  Having the pair of columns closer together is a bit
easier on eyes when tracking from the suit names to the AC number.

Todo:  redo the recently revised Achievements table again.  Current
formatting isn't spanning page boundaries, resulting in a big chunk
of blank space preceding it so that it will start on the next page.
(Only noticeable at the moment with the Postscript output; plain
text had enough room on its current page to not need to force next.)

Guidebook.tex is lagging again.

doc/Guidebook.mn

index 38f6ba8fb00cd5276195117e6f96024cc85114ec..3188ba3f0aa2476298918faa8c92f5a9602c6cd1 100644 (file)
@@ -1,4 +1,4 @@
-.\" $NHDT-Branch: NetHack-3.7 $:$NHDT-Revision: 1.365 $ $NHDT-Date: 1581536599 2020/02/12 19:43:19 $
+.\" $NHDT-Branch: NetHack-3.7 $:$NHDT-Revision: 1.368 $ $NHDT-Date: 1581722897 2020/02/14 23:28:17 $
 .\"
 .\" This is an excerpt from the 'roff' man page from the 'groff' package.
 .\" Guidebook.mn currently does *not* fully adhere to these guidelines.
@@ -240,6 +240,17 @@ replaces the \(lqYou see ...\(rq descriptions of text adventure games.
 Figure 1 is a sample of what a NetHack screen might look like.
 The way the screen looks for you depends on your platform.
 .
+.\" (Either generated by hand or else the composite of two different
+.\" situations.  Originally the character had only reached a second room
+.\" (unchanged here) by turn 257 (now changed to 752) and was already
+.\" Weak from hunger (now changed to just Hungry) and also lacked any of
+\." Tourist's starting gold.  Confusion is added to include a condition.)
+.\"
+.\" Width is constrained by the margins of plain text output (Guidebook.txt).
+.\" Text output shows an extra space in front of the right hand boundary box
+.\" which isn't present in this data nor in the Postscript output.  It also
+.\" overwrites the label on the bottom boundary box line so that ends ups as
+.\" ------Figure-N------.  Odd but acceptable.
 .BR 2
 .ft CR \" set font to constant-width Roman
 .TS S
@@ -256,25 +267,48 @@ The bat bites!
 
 
 
-Player the Rambler    St:12 Dx:7 Co:18 In:11 Wi:9 Ch:15 Neutral
-Dlvl:1 $:0 HP:9(12) Pw:3(3) AC:10 Exp:1/19 T:257 Weak
+Player the Rambler   St:12 Dx:7 Co:18 In:11 Wi:9 Ch:15 Neutral
+Dlvl:1 $:993 HP:9(12) Pw:3(3) AC:10 Exp:1/19 T:752 Hungry Conf
 .TE
 .ft \" revert to previous font
 .ce 1
 Figure 1
 .
+.\" Figure 2 uses trailing spaces to force the same width as Figure 1.
+.BR 1
+.ft CR
+.TS S
+center box tab(~);
+L.
+Player the Rambler   St:12 Dx:7 Co:18 In:11 Wi:9 Ch:15        \"
+Neutral $:993 HP:9(12) Pw:3(3) AC:10 Exp:1/19 Hungry          \"
+Dlvl:1 T:752                                  Conf            \"
+.TE
+.ft
+.ce 1
+Figure 2
+.
 .hn 2
 The status lines (bottom)
 .pg
-The bottom two lines of the screen contain several cryptic pieces of
-information describing your current status.  If either status line
-becomes longer than the width of the screen, you might not see all of
-it.  Here are explanations of what the various status items mean
-(though your configuration may not have all the status items listed
-below):
-.lp "Rank  "
-Your character's name and professional ranking (based on the
-experience level, see below).
+The bottom two (or three) lines of the screen contain several cryptic
+pieces of information describing your current status.
+Figure 1 shows the traditional two-line status area below the map.
+Figure 2 shows just the status area, when the
+.op statuslines:3
+option has been set (not all interfaces support this option).
+If any status line becomes wider than the screen, you might not see all
+of it due to truncation.
+When the numbers grow bigger and multiple \fIconditions\fP are present,
+the two-line format will run out of room on the second line, but
+.op statuslines:2
+is the default because a basic 24-line terminal isn't tall enough for
+the third line.
+.pg
+Here are explanations of what the various status items mean:
+.lp "Title   "
+Your character's name and professional ranking (based on role and
+\fIexperience level\fP, see below).
 .lp Strength
 A measure of your character's strength; one of your six basic
 attributes.  A human character's attributes can range from 3 to 18 inclusive;
@@ -295,7 +329,7 @@ can carry.  With sufficiently high strength, the contribution to
 carrying capacity from your constitution no longer matters.
 .lp Intelligence
 Intelligence affects your ability to cast spells and read spellbooks.
-.lp Wisdom
+.lp "Wisdom  "
 Wisdom comes from your practical experience (especially when dealing with
 magic).  It affects your magical energy.
 .lp Charisma
@@ -313,7 +347,7 @@ How deep you are in the dungeon.  You start at level one and the number
 increases as you go deeper into the dungeon.  Some levels are special,
 and are identified by a name and not a number.  The Amulet of Yendor is
 reputed to be somewhere beneath the twentieth level.
-.lp "Gold  "
+.lp "Gold    "
 The number of gold pieces you are openly carrying.  Gold which you have
 concealed in containers is not counted.
 .lp "Hit Points"
@@ -322,21 +356,31 @@ damage you can take before you die.  The more you get hit in a fight,
 the lower they get.  You can regain hit points by resting, or by using
 certain magical items or spells.  The number in parentheses is the maximum
 number your hit points can reach.
-.lp Power
+.lp "Power   "
 Spell points.  This tells you how much mystic energy (\fImana\fP)
 you have available for spell casting.  Again, resting will regenerate the
 amount available.
 .lp "Armor Class"
 A measure of how effectively your armor stops blows from unfriendly
-creatures.  The lower this number is, the more effective the armor; it
+creatures.
+The lower this number is, the more effective the armor; it
 is quite possible to have negative armor class.
+See the \fIArmor\fP subsection of \fIObjects\fP for more information.
 .lp Experience
-Your current experience level and experience points.  As you
-adventure, you gain experience points.  At certain experience point
-totals, you gain an experience level.  The more experienced you are,
-the better you fight and withstand magical attacks.  Many dungeons
-show only your experience level here.
-.lp "Time  "
+Your current experience level.
+If the
+.op showexp
+option is set, it will be followed by a slash and experience points.
+As you adventure, you gain experience points.
+At certain experience point totals, you gain an experience level.
+The more experienced you are, the better you fight and withstand magical
+attacks.
+(By the time your level reaches double digits, the usefulness of showing
+the points with it has dropped significantly.
+You can use the \(oq\f(CRO\fP\(cq command to turn
+.op showexp
+off to avoid using up the limited status line space.)
+.lp "Time    "
 The number of turns elapsed so far, displayed if you have the
 .op time
 option set.
@@ -553,30 +597,35 @@ Go up to the previous level (if you are on a staircase or ladder).
 .lp >
 Go down to the next level (if you are on a staircase or ladder).
 .lp [yuhjklbn]
-Go one step in the direction indicated (see Figure 2).  If you sense
-or remember
-a monster there, you will fight the monster instead.  Only these
-one-step movement commands cause you to fight monsters; the others
-(below) are \(lqsafe.\(rq
-.sd
+Go one step in the direction indicated (see Figure 3).
+If you sense or remember a monster there, you will fight the monster
+instead.
+Only these one-step movement commands cause you to fight monsters; the
+others (below) are \(lqsafe.\(rq
+.SD n
 .\" note: the two number pad layouts are separated by a tab on each line;
+.\"       [that's out of date; it's now tab,backslash,space,tab]
 .\"       converting those tabs to spaces will screw up the formatting;
 .\"       the '(if ... set)' line starts with <backslash><space><tab>
 .\"       and is intended to line up with the right hand layout rather
-.\"       than be centered.
+.\"       than be centered.  Second column forces the label to be evenly
+.\"       spaced between first and third; Phantom fourth column forces
+.\"       the whole to shift left since fully centered doesn't look good.
+.\"       "Figure 3 " includes a trailing space to shift left a little.
+.ft CR
 .TS S
 center;
-c c.
-y  k  u        7  8  9
-\e | / \e | /
-h- . -l        4- . -6
-/ | \e / | \e
-b  j  n        1  2  3
-\      (if \fBnumber_pad\fP is set)
+ce c ce ce.
+y  k  u        \       7  8  9\        \"
+\\ | / \       \\ | /\         \"
+h\- . \-l      \       4\- . \-6\      \"
+/ | \\ \       / | \\\         \"
+b  j  n        \       1  2  3\        \"
+\fR\   \       (if \fBnumber_pad\fP is set)\   \fP\"
+\fR\   Figure 3\       \       \fP\"
 .TE
-.ed
-.ce 1
-Figure 2
+.ft
+.ED
 .
 .lp [YUHJKLBN]
 Go in that direction until you hit a wall or run into something.
@@ -2310,11 +2359,12 @@ NetHack.
 Here is a list of the armor class values provided by suits of armor:
 .
 .\" Replace the old one suit per line table with a more condensed one.
-.\" AC4 has been split into two lines to accomodate plain text output
-.\" (Guidebook.txt).  It has a tab at the end of the first line (actually,
-.\" that has become a tab followed by an empty comment to avoid being
-.\" invisible) to explicitly force an empty second column and it has a pair
-.\" of non-breakable spaces at start of second line for some indentation.
+.\" AC4 and AC7 have been split into two lines to accomodate plain text
+.\" output (Guidebook.txt).  AC4 needs it to reduce overall width; after
+.\" that, AC7 became the longest and the table looks better by shortening
+.\" it to get the second column (number) closer to the text on most lines.
+.\" Both AC4 and AC7 have trailing tab plus empty comment on their first
+.\" line and leading non-breakable spaces to indent their second line.
 .TS S
 center;
 a n.
@@ -2324,7 +2374,8 @@ Bronze plate mail, Splint mail,   \"
 \~\~Banded mail, Dwarvish mithril-coat 4
 Chain mail, Elven mithril-coat 5
 Scale mail, Orcish chain mail  6
-Ring mail, Studded leather armor, Dragon scales        7
+Ring mail, Studded leather armor,      \"
+\~\~Dragon scales      7
 Leather armor, Orcish ring mail        8
 Leather jacket 9
 none   10
@@ -2333,9 +2384,11 @@ none     10
 You can also wear other pieces of armor (cloak over suit, shirt under
 suit, helmet, gloves, boots, shield) to lower your armor class even
 further.
-You can wear at most one item of each category (one suit of armor, one
-cloak, one helmet, one shield, and so on) at a time.
-Most of these provide a one or two point improvement to AC but can be
+.\"--too obvious to mention unless we include polymorph into ettin or maralith
+.\" You can wear at most one item of each category (one suit of armor, one
+.\" cloak, one helmet, one shield, and so on) at a time.
+Most of these provide a one or two point improvement to AC (making the
+overall value smaller and eventually negative) but can also be
 enchanted.
 Shirts are an exception; they don't provide any protection unless enchanted.
 Some cloaks also don't improve AC when unenchanted but all cloaks offer