ENHANCED_SYMBOLS

A new feature, enabled by default to maximize testing, but one which can
be disabled by commenting it out in config.h

With this, some additional information is added to the glyphmap entries
in a new optional substructure called u with these fields:
    ucolor          RGB color for use with truecolor terminals/platforms.
                    A ucolor value of zero means "not set." The actual
                    rgb value of 0 has the 0x1000000 bit set.
    u256coloridx    256 color index value for use with 256 color
                    terminals, the closest color match to ucolor.
    utf8str         Custom representation via utf-8 string (can be null).

There is a new symset included in the symbols file, called enhanced1.

Some initial code has been added to parse individual
OPTIONS=glyph:glyphid/R-G-B entries in the config file.

The glyphid can, in theory, either be an individual glyph (G_* glyphid)
for a single glyph, or it can be an existing symbol S_ value
(monster, object, or cmap symbol) to store the custom representation for
all the glyphs that match that symbol.

Examples:
   OPTIONS=glyph:G_fountain/U+03A8/0-150-255

(Your platform/terminal font needs to be able to include/display the
character, of course.)

The NetHack core code does parsing and storing the customized
entries, and adding them to the glyphmap data structure.

Any window port can utilize the additional information in the glyphinfo
that is passed to them, once code is added to do so.

Also, consolidate some symbol-related code into symbols.c, and remove it from
files.c and options.c
This commit is contained in:
nhmall
2022-05-07 10:25:13 -04:00
parent 132e1d433a
commit cb0c21e91d
50 changed files with 3072 additions and 1242 deletions

View File

@@ -36,7 +36,7 @@
.ds f0 "\*(vr
.ds f1
.\"DO NOT REMOVE NH_DATESUB .ds f2 "DATE(%B %-d, %Y)
.ds f2 "February 27, 2022
.ds f2 "May 7, 2022
.
.\" A note on some special characters:
.\" \(lq = left double quote
@@ -5519,6 +5519,41 @@ So S_rock is only used for boulders and not used at all if
overridden by the more specific S_boulder.
.pg
.hn 2
Customizing Map Glyph Representations Using Unicode
.pg
If your platform or terminal supports the display of UTF-8 character
sequences, you can customize your game display by assigning Unicode
codepoint values and \fIred-green-blue\fP colors to glyph
representations. The customizations can be specified for use with a symset that
has a UTF8 handler within the symbols file such as the enhanced1 set, or
individually within your nethack.rc file.
.pg
The format for defining a glyph representation is:
.SD n
\f(CROPTIONS=glyph:glyphid\fIU+nnnn\fP/\fIR-G-B\fP\fP
.ED
.pg
The window port that is active needs to provide support for displaying
UTF-8 character sequences and explicit red-green-blue colors in order
for the glyph representation to be visible.
For example, the following line in your configuration file will cause
the glyph representation for glyphid G_pool to use Unicode codepoint
U+224B and the color represented by R-G-B value 0-0-160
.SD n
\f(CROPTIONS=glyph:G_pool/U+224B/0-0-160\fP
.ED
The list of acceptable glyphid's can be produced by
\fBnethack \-\-dumpglyphids\fP.
Individual NetHack glyphs can be specified using the G_ prefix,
or you can use an S_ symbol for a glyphid and store the custom
representation for all NetHack glyphs that would map to that
particular symbol.
You will need to select a symset with a UTF8 handler to enable the
display of the customizations, such as the Enhanced symset.
.pg
.hn 2
Configuring NetHack for Play by the Blind
.pg
NetHack can be set up to use only standard ASCII characters for making