home *** CD-ROM | disk | FTP | other *** search
/ Amiga Elysian Archive / AmigaElysianArchive.iso / comm / knot100.lha / Knot.doc < prev    next >
Text File  |  1992-09-07  |  9KB  |  151 lines
  1.                                   Knot v1.00
  2.                                   ----------
  3.                A freely distributable Postcard-Ware online game.
  4.          Originally written in Turbo C++ for MS-DOS by Jeff Knechtel.
  5.           Enhanced and re-written with SAS/C as a door for FalconCBCS
  6.                  on the Amiga by Chris Rea and Jeff Knechtel.
  7.  
  8.                     (C)1992 by Chris Rea and Jeff Knechtel
  9.  
  10.        User Documentation (within Knot) by Jeff Knechtel and Chris Rea.
  11.              Sysop Documentation (what you now read) by Chris Rea.
  12.  
  13.  
  14.                                   Description
  15. -------------------------------------------------------------------------------
  16.      Knot  is  the  most amazing online game in existence in this universe.  It
  17. exists  for  FalconCBCS,  but possibly other BBS programs.  If your BBS program
  18. has  the  ability  to  launch programs simulating a RAW window then most likely
  19. Knot  will  work  with your BBS program.  We do not, however, guarantee that it
  20. WILL  work  with  anything BUT Falcon.  (In fact, we do not guarantee ANYTHING.
  21. How's that for free software?)
  22.  
  23.  
  24.                                  Requirements
  25. -------------------------------------------------------------------------------
  26.      You require an Amiga computer with a reasonable version of Kickstart.  The
  27. only  Amiga  specific  functions  we  used while porting Knot to the Amiga were
  28. Open(),  Close(),  Read(),  Write(), and Delay(); the rest were standard ANSI C
  29. functions.   Knot will definitely work on an Amiga equipped with Release 2, and
  30. most  probably  work on an Amiga equipped with Release 1.2 or 1.3.  (I have not
  31. tested  it  on  such  lowly  machines.) To my knowledge, Knot does not have any
  32. drastic  memory requirements.  The executable is 44 some odd kilobytes, and the
  33. datafile  is 10 kilobytes.  While running, Knot consumes 78 some odd kilobytes.
  34. This  is reasonable considering it is the most amazing online game in existence
  35. in this universe.  (Ok, so maybe I'm a little biased.)
  36.  
  37.      A  modem and BBS program would be nice, but aren't particularly necessary.
  38. If  you wanted to, you could run Knot from a Shell, provided that it would be a
  39. RAW window and not a CON window.  You'd also need a font or window size so that
  40. 80x24  characters  would  be visible.  This font would also have to support the
  41. IBM  8-bit  extended character set.  (Most likely one of the fonts you use with
  42. your  terminal program has these.) You would also have to run it on an 8-colour
  43. screen with the right colour scheme.  But, like I said, this IS an online game.
  44. Best be running it with a BBS program.  (Falcon is nice for this.)
  45.  
  46.  
  47.                                  Setting It Up
  48. -------------------------------------------------------------------------------
  49.      I  will only document here how to set up Knot to work with FalconCBCS.  If
  50. you  have  a  BBS program other than Falcon then it will be up to you to figure
  51. out  how  to  get Knot to work.  (You probably will.  As I've said, Knot is the
  52. most  amazing  online  game  in  existence  in this universe.  But I'm a little
  53. biased.)
  54.  
  55.      First,  you  must have a directory where you keep your doors or executable
  56. files.   Personally,  I like to use BBS:BIN for this.  You must have the volume
  57. name  DOORS:   assigned  to  this  path.   (Sorry  to  those  of  you  who hate
  58. assignments.   I  would have used the Release 2 DOS function to get the program
  59. directory  to  avoid  Yet Another Assignment, but this would have rendered Knot
  60. completely useless to lower life forms.  Lower life forms deserve to experience
  61. the most amazing online game in existence in this universe, don't they?)
  62.  
  63.      As  I  was  saying--You  need  DOORS:   assigned somewhere.  At the DOORS:
  64. level,  then,  you  need  to create a directory called "Knot".  Usually it is a
  65. good idea to put the Knot executable itself in here, though it is not required.
  66. (Why  you  would  put  it  anywhere  else,  I  do  not  know.)  This  directory
  67. ("DOORS:Knot/")  is  where  Knot  will  be looking for it's only two datafiles,
  68. which  are  the  Universe  file  ("KnotUniverse.dat")  and the High Scores file
  69. ("KnotScores.dat").  The Universe file MUST be found in order for Knot to work,
  70. however  the  high scores file does not.  Knot will create a high score file if
  71. one does knot exist.
  72.  
  73.      You  must  also  create  a command from within your Menus.BBS file so that
  74. lusers  on your system can have a way to access the most amazing online game in
  75. existence in this universe.  The following is what I use:
  76.  
  77.      MENU Doors
  78.           NORMAL   K RAW C        "DOORS:Knot/Knot «LASTNAME»"
  79.           NORMAL   M GOTO         Main
  80.  
  81.      MENU Main
  82.           NORMAL   D GOTO         Doors
  83.  
  84.      Note  that  I  am  using  the last name only in my configuration.  We have
  85. found  that it looks best that way.  (Knot doesn't try to be serious, friendly,
  86. or  formal.)  You  can  pass  anything you want, provided it does not exceed 20
  87. characters.   (Actually, you CAN exceed 20 characters but Knot will rudely chop
  88. it off at 20 characters.) If you do not pass anything, Knot will default to the
  89. luser name "Gwar".
  90.  
  91.      Note  that  Knot  works  exclusively  with  8-colour ANSI and an 8-bit IBM
  92. extended  character set, regardless of whether the luser has ANSI colour or IBM
  93. characters  switched  off  in  Falcon's  Change  Menu.   If you think this is a
  94. problem,  your best bet would be to write a script informing the user that Knot
  95. uses  ANSI colour and an IBM character set if he does not have them toggled on.
  96. (Just  so  he  doesn't  wonder  why everything on the screen doesn't look quite
  97. right  if his terminal isn't capable of ANSI colours and an IBM character set.)
  98. You  can  kindly inform them that in order to play the most amazing online game
  99. in  existence in this universe that they will have to use a terminal supporting
  100. the aforementioned capabilities.
  101.  
  102.      The  instructions on playing the game can be displayed from Knot's initial
  103. Options menu.  Hopefully they will not inform you as much as you are expecting.
  104. Hopefully  you  will discover what 'it' is all about when you actually play the
  105. game.
  106.  
  107.  
  108.                                 How To Reach Us
  109. -------------------------------------------------------------------------------
  110.      If  ever  you  need/want  to  reach  us,  both myself (Chris Rea) and Jeff
  111. Knechtel  can be contacted through The IntuitionBase, my BBS, at (416)569-1482.
  112. It is located in the western suburbs of Toronto (in a not-so-little city called
  113. Mississauga,  to  be  more particular.) (BTW, why DO Torontonians call the city
  114. itself "Metro"?  Where I'm from (Montreal) the Metro is a fantastic underground
  115. method  of  transportation.  For some reason they call it a "Subway" here.  And
  116. for  another reason it's not so fantastic.  And for yet another reason it's not
  117. completely underground.)
  118.  
  119.      You  can  also  reach  me (Chris Rea) both through FIDONET and Usenet.  My
  120. FIDONET  address  is  "Chris Rea @ 1:167/104".  That is the address of a Falcon
  121. system run by Robert Williamson in Montreal.  I still call once in a while, and
  122. Robert  has  fairly  stable feeds, so that is a reliable method.  Thanks to Rob
  123. for  that.   My  Usenet  address  is "cwrea@eastern.UUCP".  Eastern is a public
  124. access Usenet site in Toronto that I have recently joined.  Thanks to the sysop
  125. there for that.
  126.  
  127.      Lastly, we'd LOVE to get a postcard from you.  If you are a Sysop and have
  128. installed Knot on your BBS, PLEASE send us a postcard!  We just want to see who
  129. from where uses it.  Here's the address you can send your postcard to:
  130.  
  131.      Chris Rea
  132.      3058 Council Ring Road
  133.      Mississauga, Ontario
  134.      L5L 1N8
  135.  
  136.      Special  thanks to the folks at Commodore (and before) for creating such a
  137. wonderful piece of hardware, the Amiga.  Special thanks to SAS (and before) for
  138. creating a fantastic C compiler, SAS/C, which I can use to program my wonderful
  139. piece  of hardware.  Special thanks to the guys from Midnight Oil and Hunters &
  140. Collectors,  whose  recordings  provide  me  with  hours and hours of fantastic
  141. musical  entertainment  while  I  program  with  my  aforementioned fantastic C
  142. compiler on my aforementioned wonderful piece of hardware, the Amiga.
  143.  
  144.      That's  everything!   Hope  you  enjoy  the  most  amazing  online game in
  145. existence in this universe.  (But I AM a little biased.)
  146.  
  147.                                                             Chris Rea
  148.                                                             07-Sep-92
  149.  
  150. -------------------------------------------------------------------------------
  151.