OSDN Git Service

fix sokoban defs
[nethackexpress/trunk.git] / sys / mac / MacHelp
1             Macintosh-specific help file for NetHack 3.4
2
3 The following are options, features, or concerns specific to the
4 MacOS Classic port of NetHack.  Bug reports, suggestions, comments,
5 and so on, should be addressed to:
6
7     To: nethack-bugs@nethack.org
8     Subject: Mac NetHack 3.4
9
10 or you can use our on-line bug reporting form at
11
12     http://www.nethack.org
13
14 Please include your machine-type, system software version and other
15 relevant information (i.e. system extensions, monitor, accelerators
16 and so on).
17
18
19 === Configuration of a playground
20     NetHack is packaged in a Dungeon Folder which includes:
21         NetHack - the application file itself.
22         NetHack Defaults - text file for default option settings.
23         License - licensing terms for nethack.
24         Guidebook - description of the game in long format.
25         Recover - the application to restore save files from crashed games.
26     Previous versions had a large number of data files in the Dungeon
27     Folder.  These are now packaged as resources inside the application
28     file and will no longer appear in the Dungeon Folder.
29
30     During play another file type appears:
31         Player level files (labelled "iName.n", i is a constant number,
32             Name is the player name and n is the dungeon level).
33
34     Two other types of files will appear in the Dungeon Folder
35     as a result of playing NetHack:
36         Bones files (of previously deceased players).
37         Saved games (labelled "save/iName", i is a number, same as above,
38             and Name is the player name).
39
40     The following files or file types may be thrown away:
41         logfile - if it becomes too large.  A new one will be generated.
42         Player level files _not_ belonging to a game in progress.
43             Alternatively, these files may be processed by Recover,
44             which may be able to restore a save file from the level files.
45         Old bones files and saved games.
46
47
48 === Resuming a saved game
49     Double-click (or open) the desired saved game file or open NetHack
50     and answer the "Who are you?" dialog with the player name of
51     the saved game in the Dungeon Folder.
52
53
54 === Windows
55     The Dungeon Map and Message windows are the essential windows used
56     during window-mode play.  During tty-mode play there is only one
57     window which displays the map, messages, lists and other info.
58     For window-mode play, lists (e.g. the list of objects that may
59     be wielded) and special info windows appear as needed.  Windows
60     may be closed in the normal ways (i.e. clicking their close box,
61     choosing 'Close' from the File menu or typing the command
62     equivalent for 'Close', cmd-W) and the list windows may also be
63     dismissed by hitting the space bar (or Return or Enter Keys).
64     Hitting the ESCape key will dismiss special windows without
65     scrolling to the end.
66
67     The command "Reposition" on the File menu may be used to restore the
68     the startup sizes and locations of the various windows.  The
69     window positions are saved in a file labelled "NetHack Windows"
70     in the appropriate preferences folder.
71
72
73 === Default options
74     The following options are specific to the Macintosh port:
75     background:  - black or white
76     MACgraphics  - use enhanced dungeon map symbols [TRUE]
77     page_wait    - display  --MORE--  after messages [TRUE]
78
79     Default options may be set by editing the NetHack Defaults text
80     file (using SimpleText or your favorite editor).  The following
81     notation is used:
82
83         OPTIONS=name:Arnold,time,!tombstone
84
85     It should also be mentioned here that there are two graphic
86     interface modes available: 'mac' and 'tty'.  Choosing between
87     these interfaces is accomplished by the option:
88     window:mac - the default multi-window Macintosh(tm) interface.
89     window:tty - traditional Unix(tm)-style TTY window interface.
90
91     See option help (?f or ?g) for more details.
92
93
94 === Movement by mouse
95     The shape (direction) of the cursor over the Dungeon Map window,
96     typically, indicates the direction that you desire to move in when
97     the mouse is clicked.  Modifier keys affect mouse-movement in the
98     same way that they affect keyboard movement.  Clicking on yourself
99     means rest one turn and Shift-clicking on yourself means "open door"
100     in the subsequently indicated direction.
101
102
103 === Sounds
104     Real sounds (resources) have been added for various instruments.
105     The option "silent" [FALSE] controls whether or not a sound will
106     be heard when an instrument is applied.
107
108
109 === Explore and Debug Modes
110     As of version 3.1.2, you can enter Explore (aka Discover) mode or
111     Debug (aka Wizard) mode by choosing the appropriate entries on the
112     'Mode' popup-menu section of the "Who are you?" startup dialog.
113     This same dialog allows you to specify your role, race, gender,
114     alignment, and name, of course.
115
116     Starting in Explore mode is essentially the same as playing in
117     Regular mode except that if you are killed then you are given an
118     opportunity to override your death.  Because of this advantage,
119     your Explore mode scores are not entered on the scoreboard record.
120     You also get a wand of wishing in your starting inventory and can
121     see your intrinsic abilities using the command ctl-X (also available
122     on the 'Explore' submenu on the File menu).
123
124     Starting in Debug mode is only intended for developers and others
125     interested in characterizing bugs.  Using this mode for other
126     purposes will have confusing results and eliminate your enjoyment
127     of the game!
128
129
130 === Menus
131     As of version 3.1.2, the menus have been reworked to provide access
132     to all the NetHack commands and a special 'Kbd' menu was added to
133     facilitate play using only the mouse.  In some cases, a command may
134     appear on more than one menu.  In general, the commands have been
135     grouped to appear on an appropriate menu:
136     File  - commands related to windows, start mode and play control.
137     Help  - info commands generally not related to a specific game (i.e.
138             (key descriptions, version info, internal option editor).
139     Info  - commands that are generally game-specific (i.e. inventory
140             related, describe features seen on the map or name things).
141     Equip - commands related to things you might wield or wear.
142     Act   - commands for actions that you might do alone (i.e. wait,
143             jump) or do with another dungeon denizen (i.e. pay, chat).
144     Magic - commands for things that you might do with items (drop,
145             eat, read) or spell-related.
146     Bits  - commands for things you might do to dungeon pieces (i.e.
147             open door, loot chest, engrave on the floor, climb stairs).
148
149     The key related to a command generally appears to the left of the
150     menu entry for that command (i.e. w for wield and W for wear). A
151     leftmost # denotes an extended command (without a related key) and
152     a left cloverleaf or command symbol denotes a command that requires
153     either a control or command key modifier (i.e. holding down the
154     control or command key while hitting the related key).
155
156
157 ===
158 The members of the Macintosh NetHack port team hope you enjoy this game.