home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / BBS / TPORT10A.ZIP / TIMEPORT.DOC < prev    next >
Text File  |  1995-06-24  |  13KB  |  212 lines
  1.                         --=---=----=-----=----=---=-- 
  2.                          Time Port Version 1.0a Beta
  3.                         --=---=----=-----=----=---=-- 
  4.                            Written by: Mike Snyder
  5.                         (C) 1995 Hunter Computer Inc.
  6.                         --=---=----=-----=----=---=-- 
  7.                                 DOCUMENTATION
  8.                         --=---=----=-----=----=---=-- 
  9.  
  10. Note: This is the FIRST version ever of Time Port.  There are lots of
  11.   options I plan to add right away.  You might let your users know this,
  12.   too.  Also, this is a beta version and may be full of bugs and errors.
  13.   Expect new, improved versions to be released very soon. :)
  14.  
  15. To get the latest version of Time Port, call Orion's Realm BBS: 405-924-7939.
  16. You'll also find the latest version of our first hit Door game, Lunatix.
  17.  
  18. Note: The FILE_ID.DIZ for Time Port contains ANSI codes for color.  If your
  19.   BBS file area will not handle the ANSI in the listing, you can use the
  20.   DESC.SDI file which is a plain text "description" file.
  21.  
  22. Time Port is ShareWare After a 30-day trial period you should register it for
  23. $15, which will allow your players to advance past level 5 and win the game.
  24. User REGISTER.TXT when registering Time Port.
  25.  
  26.     Time Port is a door game, designed soley for the purpose of online play,
  27. usually for a BBS.  Setting it up RIGHT is important.  You may be able to
  28. get it to run by setting it up wrong, but it may cause you problems,
  29. especially on Multi-Node play.  Here is the way Time Port needs to be
  30. set up, and hopefully I can explain this right.
  31.  
  32.     First of all, make a directory in which to put all the files from the
  33. Time Port archive (.ZIP, usually, but may be another archive) file.  If you
  34. want to varify that your archive is complete, check the LISTING.DAT text
  35. file.  It will explain which files should be in the archive, plus a listing
  36. of some that INSTALL creates and which should NOT be in the archive.  If
  37. your archive of Time Lord contains extra or not all the files listed in the
  38. LISTING.DAT file, please contact Hunter Computer immediately with information
  39. about where you found the corrupted archive.
  40.  
  41.     Once all the Time Port files are in a directory of their own, you are
  42. ready to begin installation.  Change the current directory to the Time Port
  43. Directory and type INSTALL.
  44.  
  45.     Starting with B, (you won't have Reg codes, option A, to start with)
  46. select the menu options to Create LinkTo.BBS, Create TimePort.CFG, Create
  47. .DAT and .TXT files, and Reset Player files.  Pay close attention to the
  48. prompts when creating TimePort.CFG and LinkTo.BBS.  These files are VERY
  49. important to Time Port and if you mess up on even 1 line, Time Port might
  50. not run correctly, or at all, generating a "Fatal Error" when you try to
  51. run TIMEPORT.EXE from your BBS.
  52.  
  53.     When creating LinkTo.BBS, you will be setting up a common bond between
  54. Time Port and your BBS drop file/modem setup.  You will be asked several
  55. questions you will need to know the answers to.  First of all, what drop
  56. file will you be using?  Time Port currently supports CALLINFO.BBS,
  57. DORINFO1.DEF, CHAIN.TXT, and DOOR.SYS.  After selecting one of these, you
  58. will be required to supply a path to the drop file.  This is very important:
  59. If you are on a single-node BBS, you will not have to worry about copying
  60. the drop file that your BBS makes, because there should be no chance of it
  61. getting overwritten by another user.
  62.  
  63.     However, if you have multiple nodes, you will ultimately have to either
  64. A) Create multiple Linkto.BBS's, or B) Edit the first one to change the
  65. path of each drop file.  For Multi-Node play you MUST have a separate
  66. directory for the configuration files for each node.  This means you'll have
  67. directories such as C:\BBS\TIMEPORT\NODE1\, C:\BBS\TIMEPORT\NODE2\, and so on
  68. for however many nodes you have.  These directory names and placement are
  69. your own choice.  However, you will also have the MASTER Time Port directory
  70. which might be C:\BBS\TIMEPORT\.  This is the directory where all your main
  71. files will be, and on a single-node BBS, this can also be the node directory.
  72. I can't emphasize enough the importance, though of separate NODE directories
  73. if your BBS has more than 1 node.  These directories may all reside on a
  74. main server, or on separate machines, it doesn't matter.
  75.  
  76.     For Multi-Node, if all your modem setups are the same, you can simply
  77. copy the LinkTo.BBS file into each node directory.  If one node has a
  78. slightly different setup, though, you'll have to make a LinkTo.BBS for that
  79. node.  You may need to do this for a node that has a modem on a different
  80. IRQ than the standard, or something.
  81.  
  82.     Also, for Multi-Node, remember that the drop files (be it Door.Sys or
  83. one of the others) MUST be preserved throughout the game.  This means you'll
  84. need to be sure that the batch file that calls Time Port will COPY the drop
  85. file for that node into, for instance, the C:\BBS\TIMEPORT\NODE1 directory,
  86. where it will stay.  This means the LinkTo.BBS for that node must also
  87. point to that directory to find the Drop File.  Unlike the TimePort.CFG
  88. which will be discussed later, you CAN directly EDIT the Linkto.BBS and
  89. alter the first line (the path to the drop file) and save it into each
  90. node.  I hope you've got all that because it's VERY important for multi-node
  91. play to work correctly.
  92.  
  93.     The TimePort.CFG is also important, as it gives default game setup
  94. information.  Most of this, such as the Player Fights allowed per day, the
  95. "Hour" turns per day, and so on, should be the same for every node because
  96. you'll want every node to have the same setup.  What may or may not be the
  97. same, however, is the path to the MASTER Time Port directory.  I Know I've
  98. been using the word "Important" frequently through this .DOC, but this is.
  99. Hopefully you have your system configured so that every node sees the
  100. server (or the main node) as the same drive letter.  In this manner, every
  101. node, whether they reside on the same machine or some other machine, will
  102. "think" that the MASTER Time Port directory is the same.  For our own LAN,
  103. 8 computers (including the BBS) have a Z: drive, which is actually the C:
  104. drive of the BBS.  (We use Novell Personal Netware).  We have even mapped
  105. a Z: drive on the BBS itself which is its own C: drive.  If your setup
  106. allows you to do this, by all means do it.  It will make things MUCH easier
  107. because all reference, from every computer, to the Z: drive is the BBS's
  108. hard drive.
  109.  
  110.     If your setup is similar, and the Path information is identical for
  111. each node, you can then copy the TimePort.CFG into each of the node
  112. directories (a step not needed if you just have 1 node).  However, If
  113. your drive specifications are not the same, you can still customize a
  114. TimePort.CFG for each node and put it into the Node directory where it
  115. belongs.
  116.  
  117.     After running these options through the INSTALL program, and creating
  118. your node directories (for more than one node, remember), you should have
  119. A) the MASTER Time Port directory with a LinkTo.BBS and TimePort.CFG file
  120. for a single-node BBS, or B) the MASTER Time Port directory plus another
  121. directory for each NODE which contains 2 files each: TimePort.CFG and the
  122. LinkTo.BBS.
  123.  
  124.     You are now ready to set up your BBS to run Time Port.  For reference,
  125. I have included a sample .BAT batch file, called MULTI.BAT for a multi-node
  126. BBS setup.  You MUST edit this or create your own, as it's doubtful it will
  127. work for your setup as it is.  In can be used for any setup clues you might
  128. need, though. :)
  129.  
  130.     Basically, here is what your .BAT file must do:  It must change into
  131. the Time Port Node directory for the node from which it was called.  (The
  132. MULTI.BAT file will demonstrate the use of a command-line perameter passed
  133. from your BBS, such as MULTI.BAT 1 for the 1st node, MULTI.BAT 26 for the
  134. 26th node, or whatever, although you may have a different .BAT for each
  135. node if that is easier for you).  For a single-node BBS, the MASTER Time Port
  136. directory can, and probably should be your Time Port node directory also.
  137.  
  138.     Also, a copy of the drop file must also take place.  It should be
  139. copied from wherever the BBS puts it, into the Node directory (or perhaps
  140. MASTER directory if you just have one node).  Then you should call Time Port
  141. (TIMEPORT.EXE) in its directory.  For a quick view of this, here are two
  142. samples for doing this
  143.  
  144.      Example #1                             Example #2
  145.   ----------------------------------     ----------------------------------   
  146.      C:                                     G:
  147.      CD C:\NODE1\TIMEPORT                   CD G:\BBS\TIMEPORT\NODE1
  148.      COPY F:\BBS\CALLINFO.BBS C:            COPY G:\BBS\NODE1\CALLINFO.BBS G:
  149.      F:\BBS\TIMEPORT\TIMEPORT.EXE           G:\BBS\TIMEPORT\TIMEPORT.EXE
  150.  
  151.     In Example #1, the drive is set to C: which is that node's drive.  The
  152. directory is then changed into the TimePort node directory for that node.
  153. Then the BBS drop file is copied from wherever it is for that node (in
  154. that example, on F: drive in the BBS directory) and into the current
  155. directory, which is the node for Time Port.  Then TIMEPORT.EXE is called
  156. at its MASTER directory in drive F:.  In this example, the entry in
  157. LinkTo.BBS concerning the path to the drop file would have been
  158. C:\NODE1\TIMEPORT\ and the path to the master Time Port directory would
  159. have been F:\BBS\TIMEPORT\.
  160.  
  161.     In Example 2, the drive is set to G: which is that node's drive.  This
  162. might be something like you'd find if several simple nodes used one
  163. dedicated server.  Then, the directory is changed to the Time Port
  164. node directory, G:\BBS\NODE1.  Then the Drop file is copied from where
  165. the BBS makes it (this example, G:\BBS\NODE1) into the current directory,
  166. which is the node directory.  Then Time Port is called in the MASTER
  167. Directory, which would be G:\BBS\TIMEPORT\.  Take note, you can put the
  168. drop file anywhere you want, or not even copy it at all, just as long as
  169. your entry in LinkTo.BBS tells where it's going to be.  Just remember that
  170. for a Multi-Node BBS you want this file somewhere to be preserved for the
  171. time the player remains in the game. :)
  172.  
  173.     Notice that in these examples, the directory is changed to the node
  174. directory, not the MASTER directory (unless you just have 1 node).  This
  175. is the directory where it should STAY until TIMEPORT.EXE is finished
  176. running.  The node directory (unless you just have 1 node) will only contain
  177. LinkTo.BBS and TimePort.CFG, initially.  You only call TIMEPORT.EXE by
  178. giving the path to it, so the directory will remain in the current node
  179. directory.  When Time Port starts, it will open the LinkTo.BBS and
  180. TimePort.CFG, which it expects to find in the current directory.  Using
  181. the information you put in those files (with the INSTALL program) it will
  182. stay in the node directory where those 2 data files are.  It has the path
  183. to the MASTER directory from the info in these files.
  184.  
  185.     And that's it.  The last step is to set an option in your BBS to
  186. actually spawn the drop file and run the .BAT file for Time Port.  Most all
  187. of you will already have done this, so this step should be easy for all. :)
  188.     
  189.     Okay, why, why, why did I make the setup require a directory for each
  190. node (with the exception of single-node setups)?  I could have created a
  191. node-listing file that contains the info for each, and have you call
  192. Time Port with the node number such as TIMEPORT.EXE /N1 or something.  But
  193. I didn't, and here's why:  There are temporary files that Time Port makes,
  194. and the easiest way to do this is to just open a file in the current
  195. directory.  So, with each node sitting in its own node directory, there is
  196. no problem with these files overwriting each other, and there is no need
  197. to keep track of what directory is which, and which node is this and blah
  198. blah blah.  Each node has its own config and temp files, and these point to
  199. the main copy of Time Port.  That's why.  Just felt the need to explain. :)
  200.  
  201.     I can be reached by Internet E-mail at snyder@hunter.com.  Hunter
  202. Computer Inc. is open from 9:30 to 5:30 weekdays, Central Time, and our
  203. phone number is 405-920-0136.  Our Fax is 405-920-0526.  Our BBS is
  204. Orion's Realm, 405-924-7939.  It's worth calling our board just to pick up
  205. the latest version of Time Port, Lunatix, IGM's for either, or whatever
  206. else we have to offer. :)
  207.  
  208.     Also, don't forget that your players are limited to level 5, no name
  209. changes, no bank interest, and no option to win, unless you register for
  210. a mere $15.  Just print the REGISTER.TXT file and get it to us somehow,
  211. along with your payment. (Note, Credit Card registrations are $16).
  212.