home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / World_Of_Computer_Software-02-387-Vol-3of3.iso / e / excal371.zip / SYSOPDOC.XC2 < prev    next >
Text File  |  1993-02-26  |  15KB  |  302 lines
  1.  
  2.  
  3.     ************EXCALIBUR!  INSTALLATION AND INFORMATION******************
  4.  
  5.                   ****  LICENSING INFORMATION  ****
  6.  
  7. First, let's get the legal aspect out of the way.
  8.  
  9. Excalibur! and associated software are Copyright (c) 1991 Richard L. Chism
  10. and are protected by US and international copyright laws.
  11.  
  12. For your registration fee, you are granted the right to use Excalibur! on
  13. your BBS, and modify the files for your own use.  The right to use this
  14. software is non-transferable, and you are not permitted to distribute any of
  15. its files, whether modified or not, without the express written consent of
  16. the author of Excalibur!, Richard L. Chism (hereafter referenced as "author"),
  17. in advance, with the exception that you may distribute the demonstration ver-
  18. sion, unmodified, as it was prepared by the author.  The liability of the
  19. author is limited to a refund of the purchase price in the event the game will
  20. not operate on your BBS and you so notify the author within thirty days of
  21. receipt of the software.  The author will not be liable for damages to
  22. hardware or software related to the use of this game.
  23.  
  24. * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
  25.  
  26. Sorry to put you through that, but you know how the world is these days...
  27.  
  28. ************************  INSTALLATION INFORMATION  **********************
  29.  
  30.  
  31. **** WWIV ****
  32.  
  33. To install the game on a WWIV BBS version 4.10 or greater, edit your chains.
  34. Create a new chain as follows:
  35.  
  36. A. Description  : Excalibur!
  37. B. Filename     : EXCAL37.EXE %1
  38. C. SL           : (Whatever you want)
  39. D. AR           : (Whatever you want)
  40. E. ANSI         : Optional
  41. F. DOS Interrupt: Not Used     <== This should SAY "Not Used"
  42. G. 300 Baud     : (Whatever you want, I recommend against it.)
  43. H. Shrink       : Yes
  44.  
  45. **** BBS Systems using DORINFO1.DEF user files ****
  46.  
  47. For systems which use DORINFO1.DEF to pass user information, simply use the
  48. command    EXCAL37     The game will automatically look for a DORINFO1.DEF
  49. file in your BBS root directory.  If the DORINFO1.DEF file is in another
  50. directory, you must specify the complete path as an argument.  For example:
  51.  
  52.          EXCAL37 C:\ALTDIR\DORINFO1.DEF
  53.  
  54. For information on how the game distinguishes between the WWIV   CHAIN.TXT
  55. file format and the DORINFO1.DEF file format, see the section on Running the
  56. Game Locally Without the BBS (below).
  57.  
  58.                 ***** EASY INSTALLATION *****
  59.  
  60.         ***** FOR SYSOPS WHO HAVE BEEN RUNNING THE DEMO VERSION *****
  61.  *--------------------------------------------------------------------------*
  62.  | If you do NOT want to reset the game, copy the two files USERS.XCL and   |
  63.  | COUNTIES.XCL from your XC2 subdirectory into a safe place.  When instal- |
  64.  | lation is completed as described below, copy those two files back into   |
  65.  | the XC2 subdirectory.  These files hold all the information required to  |
  66.  | continue the game without interruption.  Failure to do this will force   |
  67.  | all players to re-enter the game as new players, and all previous wealth |
  68.  | and map information will be lost.                                        |
  69.  *--------------------------------------------------------------------------*
  70.  
  71.  
  72. The easiest way to install EXCALIBUR! is to UNZIP all the files into a
  73. single directory.  While in that directory, type INSTALL followed by the path
  74. to your BBS root directory ( e.g.   INSTALL C:\BBS ).   If you just type
  75.  
  76.     INSTALL   the batch file will inform you of the appropriate format.
  77.  
  78.  
  79.  
  80.                ***** MORE DIFFICULT INSTALLATION *****
  81.  
  82. If you do NOT want to run the installation program to install EXCALIBUR!,
  83. then follow the instructions below:
  84.  
  85. Note the section above entitled FOR SYSOPS WHO HAVE BEEN RUNNING THE DEMO
  86. VERSION, and follow the instructions given if they apply to you.
  87.  
  88. Place the file EXCAL37.EXE in your BBS subdirectory (the one that contains
  89. the executable BBS file).
  90.  
  91. Create a subdirectory of your BBS directory called XC2.  For example,
  92. if your BBS executable file is in C:\BBS, then create C:\BBS\XC2
  93.  
  94. Copy all the files with the extension  .XCL  into the newly created XC2
  95. subdirectory.
  96.  
  97.  
  98. **************** RUNNING THE GAME USING A FOSSIL DRIVER ******************
  99.  
  100.    If your BBS uses a fossil driver, there should be no special steps re-
  101. quired.  Simply run the game with your FOSSIL driver activated as usual.
  102. Excalibur! will detect the presence of the FOSSIL and handle all I/O
  103. using DOS Interrupt 14H.  The FOSSIL will intercept these DOS 14H interrupts
  104. and handle them in its own way, using its own interrupt scheme.
  105.    If you wish, you can disable your fossil driver.  Excalibur! will read
  106. all necessary information from DORINFO1.DEF and your communications port
  107. registers, and handle the I/O directly.
  108.  
  109.  
  110. ********** RUNNING THE GAME USING A NON-STANDARD PORT INTERRUPT **********
  111.  
  112. ***WARNING***
  113.    IGNORE THIS SECTION UNLESS YOU KNOW YOUR WAY AROUND INTERRUPTS
  114.    VERY WELL!  OTHERWISE, UNNECESSARY PROFANITY MAY RESULT.
  115.  
  116. Excalibur! version 3.7 and greater can use command-line parameters to modify
  117. the interrupt id for ports 1 thru 4.  Format of the command line parameters is
  118.  
  119.    EXCAL37 [userdata] [/portnum] [/baseaddress] [/intmask] [/intvector]
  120.  
  121. The parameters in square brackets [ ] are optional.  The brackets do not
  122. appear in the actual command line.  Order is important.  The slash, where
  123. indicated, is required.  If a slash is followed by a zero and a space, the
  124. default value for that parameter is used.  If one of the slash parameters
  125. is used, all the slash parameters to the left of it must also be specified
  126. in the proper order.  The parameters must be separated by one or more spaces.
  127.  
  128. *  EXCAL37 causes the file EXCAL37.EXE to execute, and is required.
  129.  
  130. *  [userdata] is the name of the file which passes the user and comm info to
  131.    the game.  If present, Excalibur! will read that data for information.
  132.    Otherwise it will look for the file DORINFO1.DEF for the information.  If
  133.    the userdata file ends in the extension .TXT, Excalibur! will expect the
  134.    data to be in the WWIV CHAIN.TXT format.  Otherwise it will expect the
  135.    data to be in the DORINFO1.DEF format.
  136.    Ex:  EXCAL37 udata.txt  to look for WWIV-style info in file udata.txt
  137.    Ex:  EXCAL37            to look for DORINFO1.DEF
  138.    Ex:  EXCAL37 mydata.inf to look for dorinfo1-style info in file mydata.inf
  139.  
  140. *  [/portnum] is the comm port number, and must agree with the comm port
  141.    identified in your userdata file.  If the portnumber is not 3 or 4, the
  142.    remaining data in the command line will be ignored.
  143.  
  144. *  [/baseaddress] is the address of the port.  For example, the default base
  145.    hexadecimal address for comm port 3 is 03E8, and for comm port 4 is 02E8.
  146.    The baseaddress must be expressed in hexadecimal as opposed to decimal.
  147.  
  148. *  [/intmask] is the IRQ mask.  This is related to the Interrupt request
  149.    (IRQ) number, but in a somewhat strange way.  Whichever bit is set (based
  150.    on Intel's bit numbering scheme) determines the IRQ number.  For example,
  151.         Bit ->       7654 3210     Hex intmask value  IRQ#
  152.                      0000 0100         04              2
  153.                      0000 1000         08              3
  154.                      0001 0000         10              4
  155.                      0010 0000         20              5
  156.    More simply put, if you know the IRQ#, raise 2 to that power and the
  157.    result will be the value of intmask.  Intmask must be a hexadecimal value,
  158.    not decimal.
  159.  
  160. *  [/intvector] The interrupt vector number (not the address) to which the
  161.    port is attached.  This is determined by the interrupt number (determined
  162.    by [/intmask] above).
  163.                   IRQ #         intvector
  164.                    0                8
  165.                    1                9
  166.                    2                A
  167.                    3                B
  168.                    4                C
  169.                    5                D         and so on.
  170.    intvector is a hexadecimal number (as opposed to decimal).
  171.  
  172. Examples:
  173.  
  174.    EXCAL37 data.txt /3 /3E8 /8 /B      This example runs Excalibur!, tells
  175.       it to look for data in the file data.txt (the .txt indicates that it
  176.       will be in WWIV CHAIN.TXT format), to use COM3, base address 3E8 hex,
  177.       interrupt mask 8 hex (meaning IRQ3), and interrupt vector B hex.
  178.  
  179.    EXCAL37 /4 /2E8                     This example runs Excalibur!, takes
  180.       the default data file name (DORINFO1.DEF), verifies COM4, and specifies
  181.       that the address is 2E8 hex.  The last parameters accept the default,
  182.       since they are not listed.
  183.  
  184.    EXCAL37 uinfo.dat /3 /0 /4 /a       This example runs Excalibur!, tells it
  185.       to look for data in uinfo.dat (DORINFO1.DEF format, since the extension
  186.       is not .TXT), verifies COM3, tells it (by the /0) to take the default
  187.       base address, specifies interrupt mask 4 (hence IRQ2), and specifies
  188.       interrupt vector A hex ('A' or 'a' are equivalent).
  189.  
  190.  
  191. ************** RUNNING THE GAME LOCALLY WITHOUT THE BBS ********************
  192.  
  193. The game will run as a stand-alone if you type in  EXCAL37 XXXXXXXX.TXT for a
  194. WWIV formatted user file (XXXXXXXX can be any eight characters -- the .TXT
  195. extension tells EXCALIBUR! that the file is in CHAIN.TXT format).  For a
  196. user file in DORINFO1.DEF format, type EXCAL37 XXXXXXXX.YYY where XXXXXXXX
  197. is the name of the user file and YYY is any extension other than TXT.  In
  198. either case, the referenced chain file must exist on the same directory as
  199. the EXCAL37.EXE file unless the entire path is specified along with the name
  200. of the user file.  Make certain the user file specifies a local logon so that
  201. the system doesn't try to send characters out through the comm port.  A local
  202. logon is specified by setting the comm port to 0 in the user file.
  203.  
  204.  
  205. ****  INTRODUCTORY MESSAGE CREATION  ****
  206.  
  207. If you would like a brief message to your players to be typed out as they log
  208. on to the game, place the text in a file called    XC2NOTE.XCL   in the XC2
  209. subdirectory with the other *.XCL files.
  210.  
  211. ****  USING THE MAPMAKER.EXE FILE TO GENERATE A CUSTOMIZED MAP  ****
  212.              (Registered copies only)
  213. The files  MAPMAKER.EXE  and all the  ????NAME.XCM  files may be placed in
  214. any directory as long as they are all in the same one.  ***NOTE*** If you
  215. had a version of Excalibur! earlier than 3.3, the MAPMAKER.EXE program
  216. will need to be replaced by the new version.  Running MAPMAKER.EXE will allow
  217. you to make a personalized version of the map of the kingdom of Excalibur!
  218. Just change to the directory it is in, type     MAPMAKER    and follow the
  219. directions that are given during the execution of the program.  A file will
  220. be created called COUNTIES.XCL.  A file by this name is included with the
  221. game, but it is highly recommended that you make your own personal map so
  222. that the game will be more interesting to those who are playing it on more
  223. than one BBS.  It only takes few minutes.  Look it over thoroughly before
  224. you save it, then copy the file COUNTIES.XCL into your XC2 subdirectory.
  225. Then run XCEDITOR and select RESET THE GAME from the menu.  This will
  226. properly initialize everything for a new setup.
  227.  
  228.  
  229. ****  THE XCEDITOR.EXE FILE FOR EDITING YOUR GAME FILES  ****
  230.               (Registered copies only)
  231. To edit your game data files, go to your BBS directory, type  XCEDITOR  and
  232. the rest should be obvious.
  233.  
  234.  
  235. ****  TOP TEN LISTING  ****
  236. If you want to print out the top ten players in Excalibur! on your BBS,
  237. use the file XC2STATS.ANS in your BBS directory for a color listing, or use
  238. XC2STATS.TXT for a non-ANSI listing.  These files will be created and updated
  239. as the game is played.
  240.  
  241.  
  242. ****  FILE HOUSEKEEPING  ****
  243.  
  244. The following files are associated with the game.  B = Binary, A = ASCII
  245.  
  246. EXCAL37.EXE     B     The executable file.
  247. XCEDITOR.EXE    B     The game data file editor.  (registered only)
  248. MAPMAKER.EXE    B     The file which creates a custom map (registered only)
  249. SWMPNAME.XCM    A     Names for the swamps, for use with MAPMAKER.EXE
  250. MNTNNAME.XCM    A     Names for the mountains, for use with MAPMAKER.EXE
  251. FRSTNAME.XCM    A     Names for the forests, for use with MAPMAKER.EXE
  252. PLAINAME.XCM    A     Names for the plains, for use with MAPMAKER.EXE
  253. DSRTNAME.XCM    A     Names for the deserts, for use with MAPMAKER.EXE
  254. CITYNAME.XCM    A     Names for the cities, for use with MAPMAKER.EXE
  255. QUESTHLP.XCL    A     Instructions available while you are questing.
  256. INSTRUCT.XCL    A     Instructions available from within Camelot.
  257. USERS.XCL       B     The players and their associated maps and data.
  258. COUNTIES.XCL    B     The map and information about the various fiefs.
  259. XC2NOTE.XCL     A     OPTIONAL.  If present, is displayed at start of game.
  260. JOUSTERS.XCL    A     The opponents you face when you go jousting.
  261. INTRO.XCL       A     The introductory screen.
  262. MAINMENU.XCL    A     The menu available in Camelot (for non-expert mode).
  263. QUESTION.XCL    B     Questions the Warlock will ask if you want an amulet.
  264. JOUST.XCL       A     The results of the jousting matches, selected at random.
  265. TEXTMSG.XCL     A     Various messages which will be printed in the game.
  266. TEXTMSG1.XCL    A     More messages used throughout the game.
  267. WIDEMENU.XCL    A     The Camelot menu for 80 character screens.
  268. MONARCHS.XCL    B     Auto created.  Listing of the kings and dates of reign.
  269. ORDERING.XCL    A     How to order Excalibur! (PLEASE leave this for my sake!)
  270. MESSAGES.XCL    B     Auto created.  Messages between players, announcements.
  271. PENALTYS.XCL    B     Auto created.  Record of penalties exacted by the king.
  272. THUGS.XCL       B     Auto created.  Record of highwaymen and cutpurses hired.
  273. XC2STATS.ANS    A     Auto created.  Color listing of the top ten players.
  274. XC2STATS.TXT    A     Auto created.  Ascii listing of the top ten players.
  275. SYSOPINF.TXT    A     Additional sysop information about data file structures
  276.  
  277. You may also see some other temporary files in your XC2 subdirectory which
  278. will have the prefix OLD or NEW or the extension BAK.  These are remnants of
  279. file cleanup operations and are not required for the game.  They will be
  280. rewritten or written over as required.  Best bet is to just ignore them,
  281. except for the following:
  282.  
  283. USERS.BAK       B      The previous record of the USERS.XCL file.
  284. COUNTIES.BAK    B      The previous record of the COUNTIES.XCL file.
  285.  
  286. You may need to rename these to their current counterparts in case of a
  287. disaster.
  288.  
  289.  
  290.      If you have any problems, give me a call.
  291.                HAPPY QUESTING!
  292.  
  293.      Richard L (Rick) Chism              The Party Line BBS
  294.      or Jami Chism                        Mountaintop, PA
  295.      California Wino                      (717) 868-5435
  296.      Voice (717) 868-8017             3/12/24/96 HST/v.32/v.42
  297.      CIS - 76337,1236                   SYSOP@XCL on MajorNet
  298.      Registrations are accepted online or voice using your Mastercard
  299.      or Visa.  See ORDERING.FRM for more info.
  300.  
  301. February 23, 1993
  302.