home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / World_Of_Computer_Software-02-387-Vol-3of3.iso / n / nh311os2.zip / README.OS2 < prev    next >
Text File  |  1993-03-15  |  10KB  |  221 lines
  1.                Installing NetHack 3.1.1 Binary for the OS/2
  2.                ============================================
  3.                       (last revision:  Mar 15, 1993)
  4.  
  5.  
  6. 0. What is NetHack
  7. ------------------
  8.  
  9. NetHack is a dungeons and dragons type of computer game, where the incentive
  10. is to retrieve the mythical artifact, The Amulet of Yendor, from the depths
  11. of the dungeon.  On the way the player will encounter and sometimes fight
  12. numerous inhabitants of the dungeon, stumble into traps, collect (sometimes
  13. magical) items to help his / her journey etc.  A map of the current dungeon
  14. level is displayed on the screen together with various statistics about the
  15. player's chosen role character.  For a more complete overview of NetHack see
  16. the game guidebook included in this package.
  17.  
  18.  
  19. 1. Unpacking the archive
  20. ------------------------
  21.  
  22. The NetHack binary and the auxiliary files required to run the game are
  23. contained in this archive, NH311OS2.EXE.  The original format of this archive
  24. is a family mode self-extracting archive created by PKZIP version 1.02, but
  25. it is possible that some other archive format (ZIP, ZOO, ARJ, LZH, ...) was
  26. used depending on where you got this file.  Some archive sites may prefer
  27. other more compact packaging formats.  The following unpacking instructions
  28. assume the original format.  Of course, if you have already unpacked the
  29. thing and are reading this file from the archive itself, they needn't concern
  30. you :-)
  31.  
  32. The size of NH311OS2.EXE is 806587 bytes, which means that it does not fit on
  33. one 720 KB floppy disk.  It is assumed (hoped) that no such OS/2 system
  34. exists that would have a low density floppy drive as its only transferrable
  35. mass medium.  If problems arise with this, however, DOS and OS/2 BACKUP /
  36. RESTORE commands can be used to split the file on two low density floppies
  37. while transferring it across systems.
  38.  
  39. To unpack the archive, create the directory where you want the game to be
  40. installed and go to that directory.  Then type, e.g., "a:\nh311os2", if
  41. installing from a floppy disk in drive `a'.  If you feel suspicious about
  42. running self-extracting archives (especially in DOS), you can also unzip the
  43. archive manually by typing "pkunzip a:\nh311os2.exe".
  44.  
  45. The following files will be created in the game directory:
  46.  
  47.     file:           size:   synopsis:
  48.  
  49.     NETHACK.EXE    1096927  NetHack executable
  50.     NETHACK.CMD        115  command file for starting NetHack under PM/WPS
  51.     NETHACK.ICO        888  NetHack icon for PM/WPS
  52.     DUNGEON           1646  dungeon file
  53.     *.LEV           varies  special level files (88 files)
  54.     CMDHELP           4874  help file
  55.     HELP              8656      - " -
  56.     HH                4635      - " -
  57.     OPTHELP           6714      - " -
  58.     WIZHELP            323      - " -
  59.     HISTORY           5056  NetHack history file
  60.     LICENSE           5071  NetHack license
  61.     QUEST.DAT        78841  data file
  62.     ORACLES           6074      - " -
  63.     DATA             26925      - " -
  64.     RUMORS           41496      - " -
  65.     OPTIONS            674      - " -
  66.     NETHACK.CNF       4678  game configuration file
  67.     TERMCAP           5555  terminal configuration file
  68.     GUIDEBOO.TXT     73715  NetHack guidebook in ASCII format
  69.     GUIDEBOO.TEX     62226      - " -         in LaTeX format
  70.     RECOVER.EXE      10399  crash recovery utility
  71.     RECOVER.MAN       4575  documentation for the above in ASCII format
  72.     README.OS2       10130  this file
  73.  
  74. The entire distribution includes 111 files and requires approximately 1.8 MB
  75. of free disk space.
  76.  
  77. Since NH311OS2.EXE is a family mode program, the installation procedure can
  78. be carried out either in DOS or OS/2.  However, the binary itself will run
  79. only in OS/2.
  80.  
  81.  
  82. 2. Playing the game
  83. -------------------
  84.  
  85. The following startup options are available for NetHack in OS/2:
  86.  
  87.     -d dir              switch to directory "dir" before starting the game
  88.     -n                  don't display NEWS file if one exists
  89.     -[ABCEHKPRSTVW]     set the player role according to the letter
  90.     -u name             set the player name to "name"
  91.     -X                  start the game in non-scoring explore mode
  92.     -D                  start the game in debug (wizard) mode (player name
  93.                         "wizard" must be supplied earlier on the command line
  94.                         or otherwise normal explore mode is started)
  95.     -r                  don't use RAM disk
  96.     -ibm                use IBM character graphics
  97.     -s                  print out the list of your scores (must be the first
  98.                         option specified)
  99.     -?                  print out help about startup options
  100.  
  101. When the game is played for the first time, one additional file, RECORD, is
  102. created for the game's scoring records.  If an old record file already
  103. exists, it will be used instead.
  104.  
  105. Old saved games (*.SAV) or bones files (BONES*.*) from previous versions of
  106. NetHack should be deleted, since they will not work with the newest version.
  107.  
  108. If an environment variable "TERM" is set, NetHack will search the TERMCAP
  109. file for a matching entry of appropriate ANSI terminal control sequences.
  110. Otherwise, preset defaults are used.  Note that ANSI must be set ON in the
  111. OS/2 session where NetHack is run.
  112.  
  113. You will have to edit NETHACK.CNF file to make it reflect your directory
  114. setup as well as your personal preferences regarding game options.  See
  115. the guidebook for more details.
  116.  
  117. If you'll be running NetHack from a different subdirectory, you may want to
  118. do "set HACKDIR=c:\games\nh31" (or whatever directory you want to use).  Add
  119. it to your config.sys, if you'll be playing often.  Alternatively you can set
  120. it in NETHACK.CNF.
  121.  
  122. You can also create a special NetHack entry in your Presentation Manager /
  123. Workplace Shell desktop.  This will use the included NetHack icon.  The
  124. following is a sample program description for OS/2 1.3 desktop, but it's
  125. very similar in OS/2 2.0:
  126.  
  127.     Program title:          NetHack 3.1
  128.     Path and file name:     c:\games\nh31\nethack.cmd
  129.     Parameters:
  130.     Working directory:      c:\games\nh31
  131.     Program type:           OS/2 Full screen
  132.  
  133. Naturally you must fill in your own game directory and parameters if you want
  134. to set any.  The program type can be either OS/2 Full screen or OS/2
  135. Windowed.  Note that you should set the executable path to use the command
  136. file NETHACK.CMD.  This file generates an extra pause after the program exit,
  137. because otherwise you wouldn't get to see the high score list upon quitting
  138. due to PM/WPS automatically closing the program window.  When starting
  139. NetHack normally from OS/2 command prompt, the command processor starts
  140. NETHACK.EXE instead, so no extra pause is generated.
  141.  
  142. If file named NEWS exists in the game directory, it will be printed on screen
  143. upon startup.  This allows the game administrator to distribute game specific
  144. news and announcements to other players.  Although OS/2 is basically a single
  145. user system, this feature is supported in this binary.
  146.  
  147. Wizard mode password is "wizard" and the command sequence to enter it is thus
  148. "nethack -uwizard -D".  Note that wizard mode is really intended for
  149. debugging only, and using it gets boring fast.  Standard explore mode should
  150. be quite sufficient for all game practicing.
  151.  
  152. In case of game crashes due to segmentation faults or otherwise, the bundled
  153. game recovery utility RECOVER.EXE is available.  See RECOVER.MAN for details.
  154.  
  155.  
  156. 3. Information about this binary
  157. --------------------------------
  158.  
  159. For the technically oriented, some information about the binary:  This
  160. executable is a 16 bit OS/2 text mode window-compatible application, and it
  161. was created using Microsoft C 6.0A under IBM OS/2 1.3 Extended Edition.  It
  162. has also been tested under IBM OS/2 1.1 EE and OS/2 2.0 using FAT file
  163. system, but not under any other version.  However, it should run properly in
  164. all existing versions of OS/2 with either FAT or HPFS file system.  The
  165. reason why this executable format was chosen was to maximize portability
  166. across platforms.  Besides, NetHack is one of those programs that don't enjoy
  167. any real performance boost when compiled into a true 32 bit application in
  168. OS/2 2.0.
  169.  
  170. The following flags were used in the compile:
  171.  
  172.     /AL /O /Gs /G2 /Gt10 /Zp1 /FPi
  173.  
  174. and in the linking:
  175.  
  176.     /stack:8192 /seg:1024
  177.  
  178. Refer to MSC documentation for explanations.  8087 emulation libraries were
  179. used (LLIBCEP.LIB), so the game will run with or without a 80x87 math
  180. coprocessor.  As mentioned above, the game is also window-compatible, which
  181. means that it will run in a text window under Presentation Manager /
  182. Workplace Shell.
  183.  
  184. The following game features were compiled in:
  185.  
  186.     POLYSELF, SOUNDS, SINKS, WALLIFIED_MAZE, REINCARNATION, KOPS, ARMY,
  187.     SEDUCE, WALKIES, TOURIST, TUTTI_FRUTTI, MUSE, MULDGN, ELBERETH,
  188.     EXPLORE_MODE, REDO, COM_COMPL, CLIPPING, EXP_ON_BOTL, SCORE_ON_BOTL,
  189.     WIZARD
  190.  
  191. i.e., everything.  The following system features were defined:
  192.  
  193.     NEWS, INSURANCE, VISION_TABLES, MFLOPPY, RANDOM, SHELL, TERMLIB,
  194.     ANSI_DEFAULT, TEXTCOLOR
  195.  
  196. To find out exactly what these all mean, you'll have to consult the NetHack
  197. source code.  Suffice it to say, they provide for the maximum functionality
  198. in most cases.
  199.  
  200.  
  201. 4. Additional information
  202. -------------------------
  203.  
  204. The full source code for NetHack 3.1.1 can be obtained via anonymous ftp from
  205. ftp.uu.net, gnu.ai.mit.edu, linc.cis.upenn.edu, and from several other
  206. archive sites.
  207.  
  208. NetHack 3.1.1 is free but copyrighted - see LICENSE file for details on what
  209. you may and may not do with this program.
  210.  
  211. Queries concerning this packaging in particular should be addressed to:
  212.  
  213.     thakulin@hila.hut.fi                (Timo Hakulinen)
  214.  
  215. and the game in general to:
  216.  
  217.     nethack-bugs@linc.cis.upenn.edu     (NetHack development team)
  218.  
  219. Last but nor least:  When transferring NH311OS2.EXE either via ftp, kermit or
  220. whatever file transfer utility, remember to use BINARY mode.
  221.