home *** CD-ROM | disk | FTP | other *** search
/ Black Box 4 / BlackBox.cdr / w3_games / mjshel40.arj / MJSHEL40.DOC < prev    next >
Text File  |  1991-09-01  |  11KB  |  229 lines
  1.                          Mah Jongg Tile Set Manager
  2.                             MJSHEL40 Version 4.0
  3.  
  4. Mah Jongg Tile Set Manager, Version 4.0 (MJSHEL40.EXE), is a Windows
  5. program from JSSJ Software that manages your Mah Jongg Tile Set
  6. Library.  Version 4.0 provides the identical functions provided by the
  7. DOS version 3.0, except it is a true Windows application.  MJSHEL40.EXE
  8. works with Nels Anderson's MAHJONGG.EXE Version 3.3 or higher which
  9. provides the ability to design custom tile sets.
  10.  
  11. Version 4.0 supports the following features:
  12.  
  13.      1)   manages up to 500 tile sets.
  14.  
  15.      2)   supports the permanent setup for the various Mah Jongg
  16.           parameters that you usually include in your command line when
  17.           MAHJONGG.EXE is run.  The parameters supported are:
  18.  
  19.                 -n    Bypass the Title Page
  20.                 -m    Use a MOUSE
  21.                 -tn   Play a timed game
  22.                 -cn   Set Background color
  23.                 -dn   Set MOUSE Cursor color
  24.                 -y    Y/N prompt after selecting tiles
  25.  
  26.      3)   permits file compression of the .TIL tile sets.  At
  27.           approximately 1 megabytes of storage space per 30 tile sets,
  28.           this can represent a significant savings in hard disk space
  29.           required to store tile sets.  Using Phil Katz's PKWARE
  30.           (PKZIP/PKUNZIP), MJSHEL40 can optionally store your tile sets
  31.           in a .ZIP file.  Although this slightly increases the time to
  32.           start both MJSHEL40 and MAHJONGG, it reduces the disk storage
  33.           requirements by about *85%*, a tradeoff that is well worth
  34.           the extra time. NOTE: Registered users only!
  35.  
  36. INSTALLING MJSHEL40.EXE
  37.  
  38. Installation is simple, just copy MJSHEL40.EXE, MJSHEL40.DAT,
  39. MJSHEL40.HLP and MJSHEL40.BAT into the directory that contains
  40. MAHJONGG.EXE and your tile sets (.TIL files).  Finally, make sure that
  41. PKZIP.EXE and PKUNZIP.EXE are in the same directory or in your PATH
  42. command.
  43.  
  44. Consult your Windows documentation for instruction for adding MJSHEL40
  45. to an appropriate group in the PROGRAM MANAGER.
  46.  
  47. Mah Jongg Tile Set Manager 4.0 is a Visual Basic program and requires
  48. that VBRUN100.DLL (271,264 dated 05-10-91) be present in your PATH
  49. command. This file should be available from the same source (BBS,
  50. Shareware Software Distributor or JSSJ Software) that you obtained
  51. MJSHEL40 from.
  52.  
  53. NOTE: The size and date of VBRUN100.DLL may change over time, and
  54. MicroSoft should maintain compatibility with this version.  However, be
  55. aware that there were beta test versions available dated prior to 05-
  56. 10-91 which are NOT COMPATIBLE and MJSHEL40 will fail. STARTING MJSHEL40
  57.  
  58. To start the program, double click the MJSHEL40 icon from the PROGRAM
  59. MANAGER.  Because MAHJONGG.EXE and PKZIP/PKUNZIP are DOS programs,
  60. MJSHEL40 will, when directed, start one of these programs through a
  61. series of routines specified in the MJSHEL40.BAT file.  MJSHEL40 make
  62. every effort to detect problems that may occur while these DOS programs
  63. are executing, but because of the Windows/DOS tenuous relationship, it
  64. may not always be possible to trap and handle these errors in MJSHEL40. 
  65. If, for example, PKUNZIP encounters insufficient memory or disk space
  66. it may fail without alerting MJSHEL40.  This is not fatal, and usually
  67. results in MAHJONGG being started with the default tile set.
  68.  
  69. Until you register your copy of MJSHEL40, the program will display a
  70. shareware message requesting that you send a contribution of $15 to
  71. JSSJ Software to officially register the program.  A Radio Button
  72. [Register] to enter the Registration number is included on the
  73. Shareware window along with a [Continue] Button.  This window will not
  74. display after the program has been properly registered.
  75.  
  76. After clicking on the [Continue] Button (or after several seconds),
  77. MJSHEL40 will create a directory of your tile sets from either the .TIL
  78. files in the current directory or from the MAH_TILE.ZIP file if you
  79. have selected the compression option.  NOTE: The Tile Set Directory is
  80. created using the DOS DIR command if you do not select the compression
  81. feature.  If you use DOS 5, have modified you DIR command or use
  82. another non-MS-DOS, MJSHEL40 may not find your .TIL files.  The problem
  83. in DOS 5 occurs when you use DOSKEY to add the /w command to all DIR
  84. commands.  This can be fixed by removing any DOSKEY macros related to
  85. the DIR command.
  86.  
  87. The MJSHEL40 window is divided into four areas 1) the Menu Area, 2) the
  88. Tile Set Listing, 3) the Status Area and 4) the Control Button Area.
  89.  
  90. The Menu Area provides two options, File and Help.  The File area
  91. provides the Exit from MJSHEL40.  NOTE: Because MJSHEL40 creates other
  92. DOS tasks, there is no CONTROL BUTTON in the upper left corner of the
  93. window.  This was necessary to prevent unwanted tasks from occurring in
  94. Windows.  The Help menu includes the MJSHEL40 help screen and the
  95. customary About window.
  96.  
  97. The Tile Set Listing Area displays up to 50 tile sets on the screen for
  98. selection for play.  If you have more than 50, MJSHEL40 can page
  99. through up to 450 additional Tile Sets (500 total).
  100.  
  101. The Status Area includes a status line indicating the current settings
  102. for the six MAHJONGG parameters controlled by MJSHEL40, as well as the
  103. current compression option.  This area also includes the current page
  104. number indicator for the Tile Set Listing Area, the total number of
  105. pages and the total number of Tile Sets available.
  106.  
  107. The Control Button area contains five Radio Buttons for controlling
  108. MJSHEL40.  These buttons include:
  109.  
  110.      1)   Change Setup
  111.      2)   ZIP/UNZIP Tiles
  112.      3)   Previous Page
  113.      4)   Next Page
  114.      5)   Play Mah Jongg RADIO BUTTONS
  115.  
  116. ╒══════════════╗
  117. │ Change Setup ║
  118. ╘══════════════╝
  119.  
  120. MJSHEL40 is distributed with a predefined file called MJSHEL40.DAT. 
  121. This file contains information necessary to run MAHJONGG.EXE, and is
  122. used until you select the Change Setup Option (by pressing the 'S' key
  123. or pointing to the Setup box on the COMMAND LINE and pressing any mouse
  124. button).
  125.  
  126. The setup routine will prompt you for the information it needs to run
  127. MAHJONGG, as well as the use of the compression option.  You should
  128. refer to your MAHJONGG documentation for the meaning of each parameter
  129. if you do not understand the prompt.  Answers are entered by selecting
  130. appropriate Radio Buttons, selecting items from an option list or
  131. entering data in a text box.  Upon completion of the questions, you
  132. will be returned to MJSHEL40's main window and your new options will be
  133. displayed in the Status Area.
  134.  
  135. ╒═════════════╗     ╒═════════════╗
  136. │ UnZip Tiles ║     │  Zip Tiles  ║
  137. ╘═════════════╝     ╘═════════════╝
  138.  
  139. The second Radio Button will indicate your ability to Zip or Unzip your
  140. tile sets depending on the currently selected compression option.  If
  141. you have your tile sets compressed, the button will allow you to UnZip
  142. your tile sets, and conversely if your tile sets are not compressed,
  143. the Radio Button will read Zip Tiles.  Availoable to registered users
  144. only!
  145.  
  146. NOTE:  Be aware that because of the tenuous relationship between
  147. Windows/DOS, DOS errors may occur that are not detected by MJSHEL40. 
  148. Most of these errors, if encountered at all, are harmless.  An
  149. exception occurs while compressing and uncompressing tile sets.  If
  150. PKZIP/PKUNZIP fail during these operations, your tile sets may be lost. 
  151. The most frequent cause of this problem is insufficient hard disk
  152. space.  Therefore we recommend that you make a backup of your .TIL
  153. files before compressing them with MJSHEL40, and that you make a backup
  154. of MAH_TILE.ZIP prior to unzipping them with MJSHEL40.
  155.  
  156. Having issued that warning, let me assure you that these are rare
  157. occurrences and should in no way deter you from taking advantage of
  158. this most important feature of MJSHEL40.
  159.  
  160. ╒═════════════╗     ╒═════════════╗
  161. │Previous Page║     │  Next Page  ║
  162. ╘═════════════╝     ╘═════════════╝
  163.  
  164. If you have more than one page (50) tile sets, these Radio Buttons will
  165. page through the additional tile sets.  [Previous Page] pages toward
  166. the TOP of the list, and [Next Page] pages toward the END of the list. 
  167. MJSHEL40 displays these commands in Black if they are active or Gray if
  168. they are inactive.  For example, if you are on page 1 of 5, [PgUp] will
  169. be inactive and [PgDn] will be active.  These commands can also be
  170. selected through the keyboard by using the [PgUp] and [PgDn] keys or
  171. the "Hot Key" indicated by the underlined letter on the Radio Button
  172. caption. COMMANDS (Continued)
  173.  
  174. ╒══════════════╗
  175. │Play Mah Jongg║
  176. ╘══════════════╝
  177.  
  178. This Radio Button has two functions.  1) Its caption will change to
  179. indicate the currently selected tile set.  2) Pointing to this button
  180. and clicking when there is a tile set displayed will start MAHJONGG. 
  181. Tile sets are selected by pointing to the desired tile set and clicking
  182. once.  Note that with each click, the caption on this Radio Button
  183. changes to reflect the name of the tile set.  As with other Windows
  184. applications, double clicking on a tile set will also start MAHJONGG.
  185.  
  186. OTHER INFORMATION
  187.  
  188. The program reads all files in the current directory with an extension
  189. of '.TIL'.  It then creates a temporary file called TILES.TMP and
  190. extracts the names of the Tile Sets from the file name.  The temporary
  191. file is deleted immediately.  If you use the ZIP option, the .TMP file
  192. is created from the .TIL files in the .ZIP file.
  193.  
  194. Note that MJSHEL40.EXE, MJSHEL40.DAT, MJSHEL40.BAT, ?.TIL (or
  195. MAH_TILE.ZIP) and MAHJONGG.EXE must be in the same directory, and that
  196. directory must be the current directory.  In addition to use the ZIP
  197. option, PKZIP.EXE and PKUNZIP.EXE must be in the same directory or in a
  198. directory in you PATH command.
  199.  
  200. SHAREWARE
  201.  
  202. The Mah Jongg Tile Set Manager Version 4.0 (MJSHEL40.EXE) program is
  203. distributed as Shareware, with payment of the registration fee based on
  204. the honor system. If the program is useful and you continue to use the
  205. program after an initial trial, you are requested to send $15 to:
  206.  
  207.                      Steve Shattuck
  208.                      5289 N. Lake Drive
  209.                      Whitefish Bay, WI 53217
  210.  
  211. Please make your check payable to J. Stephen Shattuck, Jr.
  212.  
  213. Upgrades for previously registered users of MAHSHELL are available for
  214. $10.  Please specify disk size (5¼" or 3½") when ordering an upgrade. 
  215. A site license for 10 or more copies at a single location is available
  216. for $80.
  217.  
  218. It is also expected that you will separately register Nels Anderson's
  219. MAHJONGG.EXE program.  In any case, please register Nels' program even
  220. if you don't register mine.  My program has NO VALUE without his, and I
  221. would certainly be upset to find that someone had registered MJSHEL40
  222. and not registered MAHJONGG!
  223.  
  224. Feel free to comment on the Mah Jongg Tile Set Manager and make
  225. suggestion for it's improvements.  I would also be interested in your
  226. favorite Tile Sets.  I can be reached at the address above or on Exec-
  227. PC in Milwaukee, WI (414) 789-4210, the best and largest BBS in the
  228. World!
  229.