home *** CD-ROM | disk | FTP | other *** search
/ Shareware 1 2 the Maxx / sw_1.zip / sw_1 / GAMES / MJSHEL30.ZIP / MAHSHELL.DOC next >
Text File  |  1992-04-25  |  19KB  |  382 lines
  1.                          Mah Jongg Tile Set Manager
  2.                                 Version 3.0
  3.  
  4. Mah Jongg Tile Set Manager, Version 3.0 (MAHSHELL.EXE), is a program from
  5. JSSJ Software that manages your Mah Jongg Tile Set Library.  MAHSHELL.EXE
  6. works with Nels Anderson's MAHJONGG.EXE Version 3.3, which provides the
  7. ability to design custom tile sets.  In addition, MAHSHELL lets you
  8. establish a setup command for the various Mah Jongg parameters that you
  9. usually include in your command line when MAHJONGG.EXE is run.  The
  10. parameters supported are:
  11.  
  12.            -n    Bypass the Title Page
  13.            -m    Use a MOUSE
  14.            -tn   Play a timed game
  15.            -cn   Set Background color
  16.            -dn   Set MOUSE Cursor color
  17.            -y    Y/N prompt after selecting tiles
  18.  
  19. MAHSHELL.EXE currently supports EGA and VGA systems only.  Because I do not
  20. have access to any computers with Hercules, EGA Monochrome or Laptop
  21. displays, I have not implemented the -h, -l or -li options.  If someone is
  22. willing to test such versions, I would be happy to add the code.   
  23.  
  24. The program can also utilize a Microsoft-compatible Mouse if available.  The
  25. program will recognize the presence of the mouse driver.  MAHSHELL
  26. recognizes the press of any mouse button to select Tile Sets or commands.
  27.  
  28.  
  29. Version 3.0 adds two significant features:
  30.  
  31.      1)    Previous versions of MAHSHELL supported up to 50 tile sets.  Many
  32.            of the people registering the program recently have indicated that
  33.            this was becoming a real limitation.  One person reported over 80
  34.            tile sets in his collection.  Thus, this version supports 500 tile
  35.            sets.  
  36.  
  37.      2)    At approximately 1 megabytes of storage space per 30 tile sets, I
  38.            also decided to add compressed file support to 3.0.  Using Phil
  39.            Katz's PKWARE (PKZIP/PKUNZIP), MAHSHELL can optionally store your
  40.            tile sets in a .ZIP file.  Although this slightly increases the
  41.            time to start both MAHSHELL and MAHJONGG, it reduces the disk
  42.            storage requirements by about *85%*, a tradeoff that is well worth
  43.            the extra time.
  44.  
  45.  
  46. INSTALLING MAHSHELL.EXE
  47.  
  48. Installation is simple, just copy MAHSHELL.EXE into the directory that
  49. contains MAHJONGG.EXE and your tile sets (.TIL files).  If you used a
  50. previous version of MAHSHELL, BE SURE TO DELETE THE OLD MAHSHELL.DAT file,
  51. as the new format is not compatible with older versions.  Finally, make sure
  52. that PKZIP.EXE and PKUNZIP.EXE are in the same directory or in your PATH
  53. command.STARTING MAHSHELL
  54.  
  55. To start the program enter MAHSHELL at the MS-DOS prompt while in the
  56. directory where MAHSHELL.EXE, MAHJONGG.EXE and your .TIL files are stored
  57. (i.e. C:\GAMES>).  MAHSHELL can display up to 50 tile sets on the screen for
  58. selection for play.  If you have more than 50, MAHSHELL can page through up
  59. to 450 additional Tile Sets (500 total).  Unless this is your first time
  60. running MAHSHELL, the Tile Menu screen will appear as follows:
  61.  
  62.               ╔════════════════════════════════════════════════╗
  63.               ║        MAH JONGG TILE SET MANAGER (3.0)        ║
  64.               ║    Use Keyboard or MOUSE to select Tile Set    ║
  65.               ╚════════════════════════════════════════════════╝
  66.  
  67.   1 = ART        11 = KIDS
  68.   2 = ASCII      12 = LASVEGAS
  69.   3 = ASTRO      13 = LOGO
  70.   4 = BASEBALL   14 = MAHJONGG
  71.   5 = CABLETV    15 = MUSIC
  72.   6 = CARDS      16 = NUMBER
  73.   7 = COMPUTER   17 = PATS
  74.   8 = DOODLE     18 = REICH
  75.   9 = FLAGS      19 = TRUCK
  76.  10 = HARDWARE   20 = USAFANDY
  77.  
  78. ╔═════════════╤════════════╤════════════╤════════════╤════════════╤═══════════╗
  79. ║ Tile No. __ │    Setup   │    PgUp    │    PgDn    │ Update Zip │    Exit   ║
  80. ╚═════════════╧════════════╧════════════╧════════════╧════════════╧═══════════╝
  81.  
  82. Current parameters are:
  83.   Title=No  Mouse=Yes  Timed=No  BG Color= 1  Cursor= 14  Prompt=Yes  ZIP=ON
  84.  
  85.  
  86.  
  87. The title box will indicate if MAHSHELL found your mouse driver or not by
  88. the prompt on the second line.  If MOUSE.SYS or MOUSE.COM is active, the
  89. text cursor (█) will also appear in the center of the screen.  Each tile set
  90. is assigned a number and displayed 50 per screen.  To select a tile set
  91. simply move the mouse cursor to the desired tile set and press any button on
  92. the mouse.  Alternatively, enter the number on the keyboard and press
  93. [ENTER].
  94.  
  95. The COMMAND LINE displays the command selections available in MAHSHELL.  
  96.  
  97. The parameter area displays the current settings for running Mah Jongg.  
  98.  
  99. Finally, in the lower lefthand corner is the page indicator.  If more than
  100. 50 tiles sets exist, this will indicate both the current page and the total
  101. number of pages.COMMANDS
  102.  
  103.  
  104. ╒═════════════╕
  105. │    SETUP    │
  106. ╘═════════════╛
  107.  
  108. Upon initial use, MAHSHELL will prompt for the setup options you wish to
  109. make standard.  These are saved in a file called MAHSHELL.DAT, and are used
  110. until you select the Setup Option (by pressing the 'S' key or pointing to
  111. the Setup box on the COMMAND LINE and pressing any mouse button).  Thus, you
  112. will only see this screen once unless you change your standard setup or
  113. delete the MAHSHELL.DAT file.
  114.  
  115. The setup routine will prompt you for the information it needs to run
  116. MAHJONGG, as well as the use of the compression option.  You should refer to
  117. your MAHJONGG documentation for the meaning of each parameter if you do not
  118. understand the prompt.  The first prompt that will appear is:
  119.  
  120.       ╔════════════════════════════════════════════════════════════════╗
  121.       ║               SETUP MAH JONGG TILE SET MANAGER                 ║
  122.       ╠════════════════════════════════════════════════════════════════╣
  123.       ║  Do you wish to bypass the title page (Y or N)?                ║
  124.       ╚════════════════════════════════════════════════════════════════╝
  125.  
  126. Answer 'Y' or 'N', followed by the [ENTER] key.  MAHSHELL accepts UPPER or
  127. lower case responses.
  128.  
  129. The next prompt is:
  130.  
  131.       ╔════════════════════════════════════════════════════════════════╗
  132.       ║               SETUP MAH JONGG TILE SET MANAGER                 ║
  133.       ╠════════════════════════════════════════════════════════════════╣
  134.       ║  Will you be using a MOUSE (Y or N)?                           ║
  135.       ╚════════════════════════════════════════════════════════════════╝
  136.  
  137. Answer 'Y' or 'N', followed by the [ENTER] key.  It appears that MAHJONGG
  138. ignores this parameter and uses the mouse if the driver is present. 
  139. However, be sure to answer 'Y' if you plan to use the mouse, otherwise,
  140. MAHSHELL will NOT prompt you for a Mouse Cursor Color.
  141.  
  142. The next prompt is:
  143.  
  144.       ╔════════════════════════════════════════════════════════════════╗
  145.       ║               SETUP MAH JONGG TILE SET MANAGER                 ║
  146.       ╠════════════════════════════════════════════════════════════════╣
  147.       ║  Will you be playing a timed game (Y or N)?                    ║
  148.       ╚════════════════════════════════════════════════════════════════╝
  149.  
  150. Answer 'Y' or 'N', followed by the [ENTER] key.  If you answer 'Y', the
  151. following prompt will appear:
  152.  
  153.       ╔════════════════════════════════════════════════════════════════╗
  154.       ║                SETUP MAH JONGG TILE SET MANAGER                ║
  155.       ╠════════════════════════════════════════════════════════════════╣
  156.       ║  How long do you want the timed games?                         ║
  157.       ╚════════════════════════════════════════════════════════════════╝
  158.  
  159. Enter the length of time (in minutes) for the game.
  160.  
  161. The next prompt is:
  162.  
  163.       ╔════════════════════════════════════════════════════════════════╗
  164.       ║               SETUP MAH JONGG TILE SET MANAGER                 ║
  165.       ╠════════════════════════════════════════════════════════════════╣
  166.       ║  Do you wish to have a (Y/N) prompt after selecting tiles?     ║
  167.       ╚════════════════════════════════════════════════════════════════╝
  168.  
  169. Answer 'Y' or 'N', followed by the [ENTER] key.
  170.  
  171. The next prompt is:
  172.  
  173.       ╔════════════════════════════════════════════════════════════════╗
  174.       ║               SETUP MAH JONGG TILE SET MANAGER                 ║
  175.       ╠════════════════════════════════════════════════════════════════╣
  176.       ║  Do you wish to change the background color (Y or N)?          ║
  177.       ╚════════════════════════════════════════════════════════════════╝
  178.  
  179. Answer 'Y' or 'N', followed by the [ENTER] key.
  180.  
  181. If you responded 'Y' to the prompt, you will be asked to select a color:
  182.  
  183.       ╔════════════════════════════════════════════════════════════════╗
  184.       ║               SETUP MAH JONGG TILE SET MANAGER                 ║
  185.       ╠════════════════════════════════════════════════════════════════╣
  186.       ║  Enter background color number from below (1-15)?              ║
  187.       ╚════════════════════════════════════════════════════════════════╝
  188.  
  189. As indicated, MAHSHELL displays the 15 available colors at the bottom of the
  190. screen.  Enter a number from 1 to 15 and press [ENTER].
  191.  
  192. If you indicated that you would be using the mouse in MAHJONGG, the
  193. following prompt will appear next:
  194.  
  195.       ╔════════════════════════════════════════════════════════════════╗
  196.       ║               SETUP MAH JONGG TILE SET MANAGER                 ║
  197.       ╠════════════════════════════════════════════════════════════════╣
  198.       ║  Do you wish to change the MOUSE cursor color (Y or N)?        ║
  199.       ╚════════════════════════════════════════════════════════════════╝
  200.  
  201. Answer 'Y' or 'N', followed by the [ENTER] key.
  202.  
  203. If you responded 'Y' to the prompt, you will be asked to select a color:
  204.  
  205.      ╔════════════════════════════════════════════════════════════════╗
  206.      ║               SETUP MAH JONGG TILE SET MANAGER                 ║
  207.      ╠════════════════════════════════════════════════════════════════╣
  208.      ║  Enter MOUSE cursor color number from below (1-15)?            ║
  209.      ╚════════════════════════════════════════════════════════════════╝
  210.  
  211. As in the case of the background color prompt, MAHSHELL displays the 15
  212. available colors at the bottom of the screen.  Enter a number from 1 to 15
  213. and press [ENTER].
  214.  
  215. Next you will be prompted for the compression options.  There are several
  216. considerations concerning the use of this option.  First, PKZIP.EXE and
  217. PKUNZIP.EXE MUST be in the current directory or in a directory in your PATH
  218. command.  Second, there must be enough available disk space on the current
  219. drive for PKZIP to make the Zip file.  Although this is generally NOT a
  220. problem, always have a backup of your tile sets in case of an unforeseen
  221. problem.  
  222.  
  223. NOTE: I do not want to discourage you from using this feature, as it really
  224. saves a lot of disk space if you have a large number of tile sets.  However,
  225. PLEASE keep a current backup of your tile sets.
  226.  
  227.  
  228. The next prompts will vary depending on whether the compression option is ON
  229. or OFF (the default is OFF).  If the option is OFF, the following prompts
  230. and screens appear:
  231.  
  232.      ╔════════════════════════════════════════════════════════════════╗
  233.      ║               SETUP MAH JONGG TILE SET MANAGER                 ║
  234.      ╠════════════════════════════════════════════════════════════════╣
  235.      ║  Do you wish to compress (ZIP) your tile sets (Y or N)?        ║
  236.      ╚════════════════════════════════════════════════════════════════╝
  237.  
  238. Answer 'Y' or 'N', followed by the [ENTER] key.
  239.  
  240. If you answer 'N', the MAHSHELL Tile Menu will appear.  If you answer 'Y",
  241. the following warning will appear:
  242.  
  243.         ╔════════════════════════════════════════════════════════════╗
  244.         ║          *** WARNING *** WARNING *** WARNING ***           ║
  245.         ╠════════════════════════════════════════════════════════════╣
  246.         ║                                                            ║
  247.         ║        This routine will compress all of your .TIL files   ║
  248.         ║   in the current directory into a file named MAH_TILE.ZIP, ║
  249.         ║   and then delete them.  Since there are error conditions  ║
  250.         ║   which may occur during the running of PKZIP.EXE that     ║
  251.         ║   are beyond the control of MAHSHELL.EXE, we recommend     ║
  252.         ║   that you make a backup of your .TIL files prior to       ║
  253.         ║   running this procedure.                                  ║
  254.         ║                                                            ║
  255.         ║   Do you wish to continue (Y or N)?                        ║
  256.         ║                                                            ║
  257.         ╚════════════════════════════════════════════════════════════╝
  258.  
  259. Answer 'Y' or 'N', followed by the [ENTER] key.  If you answer 'N', MAHSHELL
  260. will proceed to the Tile Menu.  If you enter 'Y', MAHSHELL will invoke
  261. PKZIP, compress your .TIL files, AND THEN DELETE YOUR TILE SETS.  As
  262. explained in the warning and on the previous page, DO NOT COMPRESS YOUR TILE
  263. SETS WITHOUT A CURRENT BACKUP!  The program will now display the Tile Menu.
  264.  
  265. If the Zip option was ON when SETUP was selected, the following prompt will
  266. appear:
  267.  
  268.       ╔════════════════════════════════════════════════════════════════╗
  269.       ║               SETUP MAH JONGG TILE SET MANAGER                 ║
  270.       ╠════════════════════════════════════════════════════════════════╣
  271.       ║  Do you wish to keep your compressed tile sets (Y or N)?       ║
  272.       ╚════════════════════════════════════════════════════════════════╝
  273.  
  274. Answer 'Y' or 'N', followed by the [ENTER] key.  If you respond 'Y" then
  275. MAHSHELL will proceed to the Tile Menu.  If you answer 'N', the following
  276. warning will appear:
  277.  
  278.         ╔════════════════════════════════════════════════════════════╗
  279.         ║          *** WARNING *** WARNING *** WARNING ***           ║
  280.         ╠════════════════════════════════════════════════════════════╣
  281.         ║                                                            ║
  282.         ║        This routine will decompress your MAH_TILE.ZIP      ║
  283.         ║   file and place your tile sets (.TIL files) in the        ║
  284.         ║   current directory.  MAH_TILE.ZIP will then be DELETED.   ║
  285.         ║   Since there are error conditions which may occur during  ║
  286.         ║   the running of PKUNZIP.EXE that are beyond the control   ║
  287.         ║   of MAHSHELL.EXE, we recommend that you make a backup     ║
  288.         ║   of your .TIL files prior to running this procedure.      ║
  289.         ║                                                            ║
  290.         ║   Do you wish to continue (Y or N)?                        ║
  291.         ║                                                            ║
  292.         ╚════════════════════════════════════════════════════════════╝
  293.  
  294. Answer 'Y' or 'N', followed by the [ENTER] key.  If you enter 'N' then
  295. MAHSHELL will proceed to the Tile Menu, leaving your .ZIP file intact.  If
  296. you enter 'Y" then MAHSHELL will invoke PKUNZIP, decompress your .TIL files
  297. and DELETE the .ZIP file.  After PKUNZIP has finished, MAHSHELL will display
  298. the Tile Menu.
  299.  
  300.  
  301. ╒════════════╤════════════╕
  302. │    PgUp    │    PgDn    │
  303. ╘════════════╧════════════╛
  304.  
  305. If you have more than one page (50) tile sets, the [PgUp]/[PgDn] commands
  306. will page through the additional tile sets.  [PgUp] pages toward the TOP of
  307. the list, and [PgDn] pages toward the END of the list.  MAHSHELL displays
  308. these commands in Bright White if they are active or Gray if they are
  309. inactive.  For example, if you are on page 1 of 5, [PgUp] will be inactive
  310. and [PgDn] will be active.
  311.  
  312.  
  313. ╒════════════╕
  314. │ Update Zip │
  315. ╘════════════╛
  316.  
  317.  
  318. When you receive new tile sets, you may add them to the ZIP file using the
  319. Update ZIP command.  Place the new .TIL files in the directory with MAHJONGG
  320. and MAHSHELL and select this command by pressing the 'U' key or move the
  321. mouse cursor to the Update ZIP command and pressing any key on the mouse. 
  322. MAHSHELL will add the .TIL files to the .ZIP file.  Again, keep a current
  323. backup of your tile sets.  
  324.  
  325. ╒════════════╗
  326. │    Exit    ║
  327. ╘════════════╝
  328.  
  329. The exit command will terminate MAHSHELL.  Select the command by pressing
  330. the 'E' key or move the mouse cursor to the EXIT command and pressing any
  331. key on the mouse.
  332.  
  333.  
  334. OTHER INFORMATION
  335.  
  336. The program will also interface with one of our other products, the VGA Fun
  337. Pak.  Select the insert option in the Game Menu Program, and enter
  338. 'MAHSHELL' at the program name prompt.  At the Program description prompt,
  339. enter something like 'Nels Anderson's Mah Jongg'.  Enter 'EXE' at the
  340. program type prompt.  When you select that option, the Game Menu program
  341. will call MAHSHELL.EXE, and you can select the Tile Set you wish to play
  342. with.  Upon exiting MAHJONGG.EXE, you will be returned to the MAHSHELL
  343. program to play another game or exit.
  344.  
  345. The program reads all files in the current directory with an extension of
  346. '.TIL'.  It then creates a temporary file called TILES.TMP and extracts the
  347. names of the Tile Sets from the file name.  The temporary file is deleted
  348. immediately.  If you use the ZIP option, the .TMP file is created from the
  349. .TIL files in the .ZIP file.
  350.  
  351. Note that MAHSHELL.EXE, MAHSHELL.DAT, ?.TIL and MAHJONGG.EXE must be in the
  352. same directory, and that directory must be the current directory.  In
  353. addition to use the ZIP option, PKZIP.EXE and PKUNZIP.EXE must be in the
  354. same directory or in a directory in you PATH command.
  355.  
  356.  
  357. SHAREWARE
  358.  
  359. The Mah Jongg Tile Set Manager (MAHSHELL.EXE) program is distributed as
  360. Shareware, with payment of the registration fee based on the honor system.
  361. If the program is useful and you continue to use the program after an
  362. initial trial, you are requested to send $12 to:
  363.  
  364.                     Steve Shattuck
  365.                     4768 W. Deer Run Drive, Suite 206
  366.                     Milwaukee, WI 53223
  367.                     (414) 365-9553 (Voice or FAX)
  368.  
  369. Upgrades for previously registered users of MAHSHELL are available for $5 on
  370. 5¼" disk or $6 for 3½" disk.  A site license for 10 or more copies at a
  371. single location is available for $50.
  372.  
  373. It is also expected that you will separately register Nels Anderson's
  374. MAHJONGG.EXE program.  In any case, please register Nels' program even if
  375. you don't register mine.  I would certainly be upset to find that someone
  376. had registered MAHSHELL and not registered MAHJONGG!
  377.  
  378. Feel free to comment on the Mah Jongg Tile Set Manager and make suggestion
  379. for it's improvements.  I would also be interested in your favorite Tile
  380. Sets.  I can be reached on Exec-PC in Milwaukee, WI (414) 789-4210, the best
  381. BBS in the World!
  382.