home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1994 #1 / monster.zip / monster / BBS_GAME / ZWORDZ21.ZIP / ZWORDZ.DOC < prev    next >
Text File  |  1994-01-29  |  19KB  |  441 lines
  1. ╔═════════════════════════════════════════════════════════════════════════════╗
  2. ║                                                                             ║
  3. ║                 Corporate Headquarters BBS (815) 886-3233                   ║
  4. ║                                            (815) 886-9381                   ║
  5. ║                                                                             ║
  6. ║                               Z  - W O R D Z                                ║
  7. ║                                    v2.1                                     ║
  8. ║                                                                             ║
  9. ║                              MULTI-BBS Support                              ║
  10. ║           Supporting PCBoard, Wildcat!, Gap, QBBS, RBBS, Spitfire,          ║
  11. ║                UltraBBS, Telegard, TriTel, and Remote Access                ║
  12. ║                                                                             ║
  13. ║                               Copyright 1994                                ║
  14. ║                               by Robert Neal                                ║
  15. ║                             317 Hickory Avenue                              ║
  16. ║                            Romeoville, IL  60441                            ║
  17. ║                                                                             ║
  18. ╚═════════════════════════════════════════════════════════════════════════════╝
  19.  
  20.  
  21. Z-Wordz is released as SHAREWARE. You are granted a limited license to
  22. evaluate the program. Try it out, if you continue to use it you are required
  23. to register the program.
  24.  
  25. To register the program send $14.95 along with your name and BBS phone #
  26. to: Robert Neal, 317 Hickory Avenue, Romeoville, IL 60441. See the file
  27. MAILER.TXT for additonal pricing information and special discounts
  28. available. You may also register ONLINE with Visa or MasterCard by
  29. calling the support BBS at (815) 886-3233 or (815) 886-9381. Simply type
  30. CHARGE at the main menu.
  31.  
  32. Once you register Z-Wordz, you will be given your own unique registration
  33. number that will inform Z-Wordz that the program is registered. The BBS name
  34. supplied with payment will be the name used to create your unique
  35. registration number.
  36.  
  37. THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS" WITHOUT
  38. CHARGE AND WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  39. LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  40. PARTICULAR PURPOSE.  IN NO EVENT SHALL ANYONE INVOLVED WITH THE CREATION AND
  41. PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT, SPECIAL, OR CONSEQUENTIAL
  42. DAMAGES, ARISING OUT OF ANY USE THEREOF OR BREACH OF ANY WARRANTY.
  43.  
  44.  
  45. Z-Wordz is a online game, based somewhat on the board game CrossWords.
  46. It's easy to play, making it great for all ages (my 7 year old son
  47. finds it fun to play - and it stimulates his vocabulary), but it's also
  48. challenging to keep players busy trying over and over to improve their
  49. Z-Wordz average.
  50.  
  51. Z-Wordz is a game where the player tries to complete the Z-WORDZ (you'll
  52. understand when you see the game) by completing three words all linked
  53. together forming the Z-WORDZ (believe me, you'll understand when you see
  54. the game) from a random selection of letters. In each round the player
  55. is displayed a letter, this letter may be placed in the Z-WORDZ or
  56. discarded. Players are limited to only 10 discards per round. Once the
  57. Z-WORDZ are filled, Z-Wordz checks the words created against it's own
  58. dictionary. Z-Wordz awards points for each correct word based on a set
  59. value for each letter. Invalid words are ignored. Refer to the WORDZ.HLP
  60. file for additional playing information.
  61.  
  62. As distributed, Z-Wordz has a dictionary file of over 950 three letter
  63. words. Feel free to add your own to the WORDZ.DIC file using your 
  64. favorite text editor. Don't worry about making sure the list is sorted
  65. as Z-Wordz doesn't require a sorted listing. You may make the WORDZ.DIC
  66. file almost as large as you'd like, a test file of 3200 words was used
  67. to test Z-Wordz. The routine used to validate words is so fast that even
  68. with 3200 words, Z-Wordz was able to validate all three words almost
  69. instantaneously.
  70.  
  71. Z-Wordz keeps track of dual scoreboards, one ranking each player on their
  72. overall monthly average per round and a second ranking the top 10 Z-Wordz
  73. scores for the month. Z-Wordz will automatically reset the scoreboard at
  74. the start of each month, requiring no sysop maintenance after initial
  75. set-up.
  76.  
  77.  
  78. FEATURES OF Z-Wordz:
  79.  
  80.   -  Easy to install and requires no maintenance.
  81.  
  82.   -  Ansi colors and display.
  83.  
  84.   -  Terminates cleanly through exit code even on runtime error.
  85.  
  86.   -  Automatically creates a top score listing suitable for inclusion
  87.      as a text/bulletin file for display within your BBS. Both an
  88.      ANSI and ASCII file is created.
  89.  
  90.   -  Detects loss of carrier.
  91.  
  92.   -  Operates in local mode (either direct from BBS or from command line).
  93.  
  94.   -  Sysop function keys to return to the board, chat mode, user stats,
  95.      increase/decrease time, etc.
  96.  
  97.   -  Direct support for PCBoard, WildCat!, Gap, QBBS, RBBS,
  98.      Ultra BBS, Telegard, TriTel and Remote Access.
  99.  
  100.   -  Support for baud rates up to 115,200
  101.  
  102.   -  Support for COM1-15. Optional command line for non-standard IRQ's.
  103.  
  104.   -  Supports PCBoard environment variables %PCBDRIVE% and %PCBDIR%
  105.  
  106.   -  Support Fossil Drivers. A Fossil driver is not required to use the
  107.      program.
  108.  
  109.   -  Fully Multi-Node compatible.
  110.  
  111.   -  Support for multi-port digiboards, for use with PCBoard /M.
  112.  
  113.  
  114. FIRST TIME OPERATIONS
  115.  
  116. Simply create a directory for Z-Wordz and copy all files distributed
  117. with Z-Wordz to this directory. Additional data files will automatically
  118. be created the first time Z-Wordz is run.
  119.  
  120.  
  121. CONFIGURING THE PROGRAM
  122. Using your favorite text editor, edit the file WORDZ.CFG. Below is the
  123. layout of this file:
  124.  
  125. C:\PCB\PCBOARD.SYS
  126. Corporate Headquarters
  127. Bob
  128. Neal
  129. 15
  130. 0
  131. 10
  132. NA
  133.  
  134. Line 1 = Full pathname of your door file. Formats supported by this
  135.          program are: PCBOARD.SYS, USERS.SYS, DOOR.SYS, USERINFO.DAT,
  136.                       CALLINFO.BBS, DORINFOx.DEF, SFDOORS.DAT and
  137.                       GTUSER.BBS, DOOR.SYS, and TRIBBS.SYS. When using
  138.                       USERINFO.DAT, DOOR.SYS  must be in the same
  139.                       directory as USERINFO.DAT.
  140. Line 2 = BBS name
  141. Line 3 = Sysop First Name
  142. Line 4 = Sysop Last Name
  143. Line 5 = number of rounds per day that a player may play. I suggest
  144.             a daily limit of 10 to 20, but tailor to your own needs.
  145. Line 6 = Registration number. Leave as 0 if unregistered.
  146. Line 7 = Minimum percentage of plays required for user to be listed in
  147.             the TOP 10. This percentage is based off the highest # of
  148.             plays of those who have played Z-Wordz for the month.
  149. Line 8 = You can place the name of the user who helped pay for the
  150.             registration of the door. Several sysops have specified that
  151.             users have paid the reigstration fee for Z-Wordz. You can
  152.             now place their name on this line and their name will be
  153.             proudly displayed at the end of the game so that others may
  154.             recognize their contribtion to the operation of your BBS.
  155.             Leave this blank or NA if you do not wish to use this
  156.             option.
  157.  
  158. Note: This door supports the PCBoard environment variables %PCBDRIVE%
  159. and %PCBDIR%. Non-PCBoard systems may also use these variables by
  160. including the following either in your BBS batch or AUTOEXEC.BAT file:
  161.  
  162.     SET PCBDRIVE=C:            <- Drive letter of your BBS files
  163.     SET PCBDIR=\BBS            <- Path of your BBS files
  164.  
  165. Then, in your WORDZ.CFG file, on the first line you may put:
  166.  
  167.    %PCBDRIVE%%PCBDIR%\PCBOARD.SYS, %PCBDRIVE%%PCBDIR%\DOOR.SYS, etc.
  168.  
  169. This allows you to use just one .CFG file for multi-node operation.
  170.  
  171.  
  172.  
  173. EXECUTING PROGRAM
  174.  
  175. To execute the program, enter the filename followed by the config file
  176. name (ie ZWORDZ ZWORDZ.CFG). If you are running the program from the
  177. command line, you may optionally enter ZWORDZ LOCAL. The only problem
  178. with this is the default user name sysop is used instead of the name on
  179. your board. This is good for testing the game before putting it on your
  180. system, but you should once play begins, execute the program locally
  181. from your BBS or consistantly run the game from the command line when
  182. you play.
  183.  
  184. You may also specify a non-standard IRQ. Put the IRQ number after the
  185. .CFG on the command line. For example: ZWORDZ ZWORDZ.CFG /5. This
  186. example tells the program to use IRQ 5 instead of the standard IRQ.
  187.  
  188. You may also use the procedure above and create a variable IRQ so that
  189. you can pass the IRQ setting as: ZWORDZ ZWORDZ.CFG /%IRQ%
  190.  
  191. Some users may have had conflicts when using non-standard IRQ's on
  192. Novell/Netware systems. Novell seems to use the "/" character for
  193. parameter passing. You may not optionally use the "*" character instead
  194. of the "/", for example ZWORDZ ZWORDZ.CFG *%IRQ% is valid. Both "*" and
  195. "/" will work.
  196.  
  197.  
  198. AUTOMATIC MAINTENANCE
  199.  
  200. The program will automatically during the first play of each new month
  201. reset it's user file and top score listing. The previous months
  202. scoreboard will automatically be renamed to ZWORDZ.OLD and ZWORDZG.OLD.
  203. This can then be included as a text file to display the previous months
  204. winners.
  205.  
  206. You should be aware of this so if you are starting a new game for the
  207. first time towards the end of the month, the game will automatically perform
  208. the maintenace come the first of the month.
  209.  
  210. As an option, you may pass the parameter "NEW" on the command line, for 
  211. example ZWORDZ NEW. This will reset _all_ Z-Wordz data files, including the
  212. overall high scorer information. 
  213.  
  214.  
  215.  
  216. FOSSIL DRIVER
  217.  
  218. Z-Wordz now includes support for FOSSIL drivers. This means that the
  219. program will now work with Digiboard (for Wildcat M and PCBoard/M
  220. versions) and other multi-port boards. To activate the Fossil driver
  221. support just include /FD on the command line in your door batch file.
  222.  
  223.         For example: ZWORDZ ZWORDZ.CFG /FD
  224.  
  225. If no Fossil driver is available, Z-Wordz will display a message
  226. indicating such and exit cleanly.
  227.  
  228.  
  229. This documentation will not go into the mechanics of how you set-up a door
  230. program on your BBS. It is assumed that you have a working knowledge of
  231. how to complete this task. It would be impossible for me to explain how
  232. to install a door for all BBS programs supported by Z-Wordz.
  233.  
  234.  
  235. SYSOP KEYS ACTIVE
  236.  
  237. F3    -  Toggles the printer On/Off. Value is passed to PCBoard and/or
  238.          written to DOOR.SYS and USERS.SYS
  239. F4    -  Toggles the Page Bell on/off. Value is passed to PCBoard
  240.          and/or written to DOOR.SYS and USERS.SYS
  241. F5    -  DOS Shell. Allows SysOp to exit to DOS from inside a DOOR.
  242. F7    -  Toggles the Caller Alarm On/Off. Value is passed to PCBoard
  243.          and/or written to DOOR.SYS and USERS.SYS
  244. F8    -  Returns the caller involuntarily to the BBS.
  245. F9    -  Toggles the local display On/Off. Value is passed to PCBoard
  246.          and/or written to DOOR.SYS and USERS.SYS
  247. F10   -  Activates SysOp CHAT mode within the DOOR.
  248. ESC   -  Deactivates CHAT mode.  DOOR is resumed.
  249. UP    -  Give the caller extra time while in the DOOR.  
  250. DN    -  Subtract time from the caller while in the DOOR. 
  251. HOME  -  HELP key for Status Line options.
  252. ALT-N -  SysOp next on toggle. Value passed to PCBoard. (PCBoard only)
  253. ALT-X -  PCBoard will exit after current caller logs off. Value is
  254.          passed to PCBoard. Not available on non-PCBoard systems.
  255.  
  256.  
  257.  
  258.  
  259. FILES USED AND CREATED
  260.  
  261. ZWORDZ.EXE - The program itself
  262. ZWORDZ.DOC - Documentation for the sysop to run Z-Wordz
  263. ZWORDZ.DIC - Dictionary file
  264. ZWORDZ.CFG - Configuration file
  265.  
  266.  
  267. The following files will be created by Z-Wordz
  268.  
  269. ZWORDZ.USR  - User file of current players
  270. ZWORDZ      - Top 10 scores in ascii format can be used as a bulletin
  271. ZWORDZG     - Top 10 scores in ANSI format
  272. ZWORDZ.OLD  - Previous month top 10 ascii bulletin
  273. ZWORDZG.OLD - Previous month top 10 ANSI bulletin
  274. ZWORDZ.DAT  - Contains information for scoreboard
  275. ZWORDZ.HI   - Contains overall high score information
  276. ZWORDZ.AVG  - Data file for scoreboard
  277. ZWORDZ.TOT  - Data file for scoreboard
  278.  
  279.  
  280. CONTACT ME FOR SUPPORT
  281.  
  282. If you encounter any problems you may contact me at Corporate Headquarters
  283. BBS (815) 886-3233 or (815) 886-9381.
  284.  
  285. I can also be reached via the RIME network in the SYSOP, DOORS,
  286. SHAREWARE and BBS SOFTWARE conferences as well as the COMMON conference.
  287. I can also be reached via Internet e-mail at bob.neal@corpsoft.com.
  288.  
  289. If you have any suggestions for improvements for this program, please feel
  290. free to let me know. This game has included suggestions from users of my
  291. BBS during beta testing.
  292.  
  293.  
  294.                               TROUBLESHOOTING
  295.                            =====================
  296.  
  297. If you are running this on a 486 system with co-processor and experience
  298. problems running Z-Wordz, you may need to put 'SET NO87=ON' in your
  299. AUTOEXEC.BAT file or you may place this in the ZWORDZ batch file just
  300. before the line ZWORDZ ZWORDZ.CFG, for example:
  301.  
  302.      @ECHO OFF
  303.      C:
  304.      CD \PCBURM
  305.      SET NO87=ON
  306.      PCBURM PCBURM.CFG
  307.      %PCBDRIVE%
  308.      CD %PCBDIR%
  309.      IF (%INPCB%)==(Y) EXIT
  310.      BOARD
  311.  
  312.  
  313. If you are running on a 486 system with co-processor under DesqView, you
  314. may alternately set Math Coprocessor in each window to YES.
  315.  
  316.  
  317.  
  318.  
  319. VERSION HISTORY
  320.  
  321. v2.1 - (01/29/94) / Minor upgrade
  322.         Had a sysop mention that ZWordz would never return ANSI graphics
  323.         for his users. Odd set-up, OS/2 with fossil driver. Added option
  324.         to check if ANSI, if not, ZWordz will now ask the user if they
  325.         have ANSI. This now allows those odd setups to run ZWordz.
  326.  
  327.  
  328. v2.0 - (11/24/93)
  329.         Rewrote scoring options for program. Prior version gave
  330.         multiplier credit for word placement, now multiplier is based on
  331.         number of words completed. This should make the game more
  332.         challenging as users won't be so inclined to load the word #3
  333.         with high rated points and ignore the first two words. Also
  334.         added bonus points for unused discards.
  335.  
  336.         Revised scoreboard. Previous version based inclusion of user
  337.         score based on static minimum # of plays. The minimum # of plays
  338.         is now based on a percentage of the highest # of plays of all
  339.         players. This restricts players from simply popping in and
  340.         playing a few rounds and knocking off your regulars who have
  341.         many more plays.
  342.  
  343.         Fixed quirk that allowed a player to quit in the middle of the
  344.         game. Found that some users may do this if his score is not
  345.         going to be high. Now if the player quits, he's given 0 points
  346.         and the round is included in his stats.
  347.  
  348.         Fixed problem with erratic display with multi-port boards.
  349.         Thanks to Steve and Pat of Midwest BBS for taking the time to
  350.         work through this problem with me.
  351.  
  352.         Added option to display who adopted the door. Several sysops
  353.         have indicated that users have assisted in the registration fees
  354.         for my doors. This now gives you a chance to give that user
  355.         recognition.
  356.  
  357.  
  358. v1.4 - (08/03/93)
  359.         v1.3 was a major screw-up. I picked up what I thought was the
  360.         v1.2 final release code and recompiled for v1.3. As I changed
  361.         nothing in the code (purpose of new release pertained to revised
  362.         I/O library only), I didn't do any testing before release. Bad
  363.         move, code I picked up for 1.2 was not the final code. Needless
  364.         to say, v1.3 used OLD filename conventions of Z-Wordz for the
  365.         data files.
  366.  
  367.         This release fixes the above problem and includes the new I/O
  368.         library for the fix of fossil based multi-port boards.
  369.  
  370.  
  371. v1.3 - (07/31/93)
  372.         Recompiled using new I/O routines. These new routines fix
  373.         problem with fossil based multi-port users who were experiencing
  374.         random characters at the start of the program.
  375.  
  376.         With the revised I/O routines, Z-Wordz no longer support
  377.         CHAIN.TXT BBS format. The author of the I/O routines has removed
  378.         support for this file format, sorry.
  379.  
  380.  
  381. v1.2 - (06/25/93)
  382.         Recompiled using routines which support PCBoard /M and WildCat
  383.         IM digiboard versions.
  384.  
  385.         Renamed data file names to be consistent with ZWORDZ program
  386.         name (must run ZWUPDATE.BAT after installing new version to
  387.         automatically rename the files)
  388.  
  389.         Added file ZWCONFIG.EXE, configuration file editor. Makes
  390.         creating and/or editing the configuration file easy to do,
  391.         simply fill in the blanks.
  392.  
  393.  
  394. v1.1 - (04/03/93)
  395.         First, a new name. Previously named WORD-Z, now called Z-WORDZ.
  396.         Users upgrading from v1.0 will need to rename their WORDZ.CFG
  397.         file to ZWORDZ.CFG and update their door file batch and menu
  398.         files. All data filename for Z-Wordz has been kept the same
  399.         from Word-Z.
  400.  
  401.         Revised the routine that randomly selected letters, a vowel now
  402.         has a better chance of being selected.
  403.  
  404.         Expanded and refined the dictionary file. Now over 950 words and
  405.         based on the words found in the Official Scrabble Players
  406.         Dictionary.
  407.  
  408.         Added option to require a minimum number of plays before a
  409.         players score is shown in the top 10 scoreboard. This prevents a
  410.         user from playing 1 time and getting a high score that is
  411.         impossible to be with repeated plays.
  412.  
  413.         Fixed a bug where a player was allowed to play one more time
  414.         than the sysop had configured.
  415.  
  416.         Fixed a problem with the file I/O. Did not have all file access
  417.         opened for SHARED I/O. Users with a multi-node system may find
  418.         that a user was suddenly kicked out of the game. Now fixed, all
  419.         file read/writes are done under a SHARED access.
  420.  
  421.  
  422.  
  423. v1.0 - (03/05/93)
  424.     Initial Release
  425.  
  426.  
  427. DISTRIBUTION SITES:
  428.  
  429.    As always you can find the latest version of Z-Wordz available for
  430.    downloading from Corporate Headquarters BBS.
  431.  
  432.    Calls for support for Z-Wordz should be directed only to
  433.    Corporate Headquarters BBS.
  434.  
  435.    Corporate Headquarters BBS   (815) 886-3233  (14400 v.32bis)
  436.                                       886-9381  (14400 v.32bis)
  437.  
  438. We now can accept Visa and Mastercard. Register online with your Visa or
  439. Mastercard by calling Corporate Headquarters BBS, simply type CHARGE at
  440. the main menu prompt.
  441.