home *** CD-ROM | disk | FTP | other *** search
/ PC Online 1997 January / PCO0197.ISO / filesbbs / dos / olgactl.arj / OLGA.DOC < prev    next >
Encoding:
Text File  |  1995-12-11  |  12.3 KB  |  373 lines
  1. OLGA.DOC Version 1.4
  2.  
  3. INTRODUCTION
  4. ============
  5.  
  6. What is OLGA ?
  7.  
  8. OLGA - Off-Line Game Applications allow you to play interactive games by
  9. passing the move details through your existing QWK mail system.  The pieces,
  10. or board details are automatically set up ready for you to make your move and
  11. put the reply in your .REP upload directory.  These messages will contain all
  12. the data required to redraw, say a chess board, with all the right pieces
  13.  
  14. OLGA will work alongside your OLR, sharing the same upload and download
  15. directories.
  16.  
  17. The basic functions of the OLGA Control Centre :
  18.         * read in your e-mail
  19.                 - select only OLGA game moves for the Current Player
  20.         * present the incoming game details to the user for selection
  21.         * set up OLGA Control / game interface file
  22.         * execute the selected OLGA Compatible game
  23.         * read OLGA Control / game interface file (written to by the
  24.           game)
  25.         * write back game reply to e-mail system (.REP)
  26.         * configuration
  27.         * miscellaneous utilities related to OLGA
  28.  
  29. The basic functions of an OLGA Compatible game
  30.         * read in OLGA Control / game interface file generated by
  31.           the Control Centre
  32.         * reinstate the game board
  33.         * accept a reply (move)
  34.         * write to OLGA Control / game interface file
  35.  
  36.  
  37. INSTALLATION & CONFIGURATION
  38. ============================
  39.  
  40. IMPORTANT : Version 1.4 should only be installed on C: !
  41.  
  42. Make sure you configure the BBS mailing system so that you receive the
  43. appropriate OLGA conference.  Also, if receiving .NDX files is optional
  44. for example the JCQWK system then ensure this is set to ON.
  45.  
  46.  
  47. FILES & DIRECTORY STRUCTURE
  48. ===========================
  49.  
  50. You'd probably be able to do this without any help but there follows some
  51. brief instructions anyway :
  52.  
  53.  
  54. You can do this manually or automatically using the INSTALL.EXE routine.
  55.  
  56. Automatic installation
  57. ======================
  58.  
  59. Unzip the contents of OLGACTL.ZIP in to any directory (preferably one that
  60. is not populated by any other program)  Then type INSTALL.EXE.  This will
  61. create all the necessary directories and copy the required files.
  62.  
  63.  
  64. Manual Installation
  65. ===================
  66.  
  67. Create a directory called OLGA.
  68.         CD\
  69.         MD\OLGA
  70.  
  71. Within the OLGA directory, create the following directories :
  72.         FACES
  73.         OLGAWORK
  74.  
  75.         CD\OLGA
  76.         MD FACES
  77.         MD OLGAWORK
  78.  
  79. The tree structure would look like :
  80.         \OLGA
  81.         \OLGA\FACES
  82.         \OLGA\OLGAWORK
  83.  
  84. All OLGA Control Centre files reside in the OLGA directory, with the
  85. exception of the files with the suffix of .FCE.  These are digitised photos
  86. that should be placed in the OLGA\FACES directory.
  87.  
  88. So, copy the faces files in to the faces directory.
  89.  
  90.         COPY \olga\*.FCE \olga\FACES
  91.  
  92. Now you are ready to go in to OLGA to complete the configuration.
  93.  
  94.  
  95. CONFIGURATION
  96. =============
  97.  
  98. Within \OLGA, type 'OLGA CONFIG'.
  99.  
  100.  
  101. The supplied configuration file has been set up with some defaults but you
  102. will need to check the following :
  103.  
  104. Player
  105.         Home Players
  106.         Enter all the players who will use OLGA at your home address.
  107.         These people will need their own personal log on to BBS's.  This
  108.         enables different members of the family to use OLGA.  Use the
  109.         full BBS sign-on name.
  110.  
  111. Current Player
  112.  
  113.         Must be set to one of the Home Players.  Only one home player
  114.         can be current at any one time.
  115.  
  116.         Faces
  117.                 Match YOUR face filename (held in \OLGA\FACES) with the
  118.                 full sign-on name. (if present)
  119.  
  120. Known Players
  121.  
  122.         Enter the names of your opponents - use the full sign-on name.
  123.                 Note that OLGA will 'remember' the names of opponents
  124.                 when they send e-mail to you.
  125.  
  126.  
  127. OLGA Exec
  128.         Enter the details of the OLGA Compatible games you wish to play.
  129.  
  130.         Name      - the unique name to identify the game, this should
  131.                     be recommended by the author of the game.
  132.  
  133.         Run       - the command to execute the game.
  134.  
  135.         Directory - where the game is located.
  136.  
  137.         Cmd       - if the 'game' is not an OLGA compatible game then
  138.                     set to N otherwise leave blank.
  139.  
  140.         As OLGA uses 'GAMEINST' to install an OLGA-compatible game, you
  141.         will probably never need to enter or maintain 'OLGA Execs'
  142.  
  143. Directories
  144.         Mail Download   - where the .QWK packets are downloaded (IN)
  145.         Mail Upload     - where the .REP packets are uploaded (OUT)
  146.         Note that OLGA should point to the same directories as your
  147.         communications program and your off-line reader.
  148.         Default Game    - where the games directory is held
  149.                         - this default is easily overridable.
  150.         Misc.   - slots for future expansion
  151.  
  152. BBS/ Conference
  153.  
  154.         Normally you will use Local OLGA conferences, but when you wish
  155.         to use an 'echoed' conference, for example the FidoNet UK Chess
  156.         conference, or ILinks' World Wide Chess conference then use the
  157.         'National/ International' BBS.
  158.  
  159.  
  160.         Enter the details of each BBS that has an OLGA conference as
  161.         follows:
  162.  
  163.         Name          - the name of the BBS.  Must be exactly what
  164.                         appears on the .QWK packet
  165.  
  166.         Format        - the type e-mail in use on that BBS. currently
  167.                         OLGA uses only QWK mail.
  168.  
  169.         Conference No - the number of the conference that holds OLGA
  170.                         moves.  This is usually set to 88 but check with
  171.                         the Sysop first.
  172.  
  173.         Packer        - the packer required for this BBS.
  174.  
  175.         Unpacker      - the unpacker required for this BBS.
  176.  
  177.         Description (National/International Conferences only)
  178.                       - enter a brief description of the conference
  179.                         e.g. 'ILink Chess'
  180.  
  181.         Packers - specify the format of your un/packer parameters.
  182.                         Already set for most popular types.
  183.  
  184.         Packer : Params
  185.  
  186.         Unpacker : Params Init - Just leave this as it is for now !
  187.  
  188.         It is assumed that the un/packers are included in the PATH.
  189.  
  190.         Use F1 from the main screen for the Configuration Checker
  191.         Execute this to see if you have configured OLGA correctly.
  192.  
  193.         If you are having real problems then you can run the
  194.         Configuration Checker from the DOS prompt :
  195.                  CD \OLGA
  196.                  CNFCHK
  197.  
  198. USER GUIDE
  199. ==========
  200.  
  201. OLGA should be easy to use without the aid of a manual so here are just a few
  202. notes you should bear in mind....
  203.  
  204. You MUST configure OLGA first !  See above.
  205.  
  206. Start OLGA by typing, you guessed it, OLGA.
  207.  
  208. You will be presented with a selection of mail packets, the most recent will
  209. be at the top of the list.  Packets that have already been read by OLGA will
  210. be displayed in a darker colour.  Select a packet.
  211.  
  212. After the mail has been read, the main screen will be displayed.  This will
  213. consist of the mail packet with OLGA Games on the left hand side and
  214. commands / menus on the right hand side.
  215.  
  216. LEFT HAND SIDE
  217. ==============
  218.  
  219. SELECTING INCOMING GAMES
  220.  
  221.  
  222. Select a game on the left hand side.
  223.         - when selected, the game will be executed
  224.  
  225. If you have already replied to the game then you should not be allowed to
  226. play the same move again.  If it is essential to do so, you may delete the
  227. entry on the Moves History Log - see Utilities.
  228.  
  229. You MUST have each game already installed and configured in OLGA, otherwise
  230. it would not be recognised as a valid game.  I.e.  OLGA Control Centre must
  231. know the unique name of the game, where to find it and how to execute it.
  232.  
  233. Again, this is configured automatically when using GAMEINST to install a
  234. game.
  235.  
  236. The reply you make will be transferred to the .REP file when you leave OLGA.
  237.  
  238.  
  239. SELECT NEW PACKET
  240. =================
  241.  
  242. The .QWK packets (*.q*) are displayed for selection.  Packets that have already 
  243. been processed are at a lower intensity.
  244.  
  245.  
  246. RIGHT HAND SIDE
  247. ===============
  248.  
  249. CONFIGURE
  250. See notes above.  Remember CNFCHK will check your configuration to see if it
  251. can spot any errors.
  252.  
  253. NEW EXECUTABLE
  254.  
  255. Use this option when you wish to initiate an OLGA Compatible game.  Select
  256. the game you wish to play.  The game should then ask you how many players
  257. will be in the game, the names of your opponents, and which BBS to use.
  258. The rest depends on the particular game being played.  Whoever initiates a
  259. game will always be Player 1.
  260.  
  261. UTILITIES
  262.  
  263. MAINTAIN REPLIES FOR SENDING
  264. Useful if you decide that you don't want the reply being sent to your
  265. .REP packet.  Note that you could use your OLR instead.
  266.  
  267. REINITIALISE HISTORY FILE
  268. This will empty the files that hold which games have been answered.
  269.  
  270. DELETE MOVES FROM REPLY/LOG
  271. This facility should not normally be used.  It holds a few details of each
  272. reply you make thus stopping you from replying twice to the same move.  Use
  273. with caution.  Note, remember to kill of the reply using an off-line reader
  274. if you are to remove an item from the log.
  275.  
  276. Other utilities - no explanation needed <g>:
  277.         PRINT CONFIG TO PRINTER
  278.         PRINT HISTORY TO PRINTER
  279.  
  280.  
  281. DOCUMENTS
  282. You can read this and other .DOC files.
  283.  
  284.  
  285.  
  286. OTHER OPTIONS
  287. =============
  288.  
  289. By pressing F1 in the main menu you will be able to re-read your
  290. mail or mark all your mail as unread.
  291.  
  292.  
  293. INSTALLING OLGA GAMES
  294. =====================
  295.  
  296. You can install OLGA games either
  297.         manually
  298.            or
  299.         automatically, using our own GAMEINST.EXE program.
  300.  
  301. Manual
  302.         Follow the instructions according to the game.
  303.  
  304. Automatic
  305.             Place the game OLGAXXXX.ZIP file in to C:\OLGA\OLGAWORK, 
  306.                 go in to the \OLGA directory and type GAMEINST.  
  307.                 The rest is automatic.
  308.  
  309.  
  310. IMPROVE YOUR IMAGE - APPEAR ON OLGA !
  311. =====================================
  312.  
  313. FACES / FACES FILE AREA
  314.  
  315. Why not digitise a photo of yourself so your opponents can see who they
  316. are up against ?  To do this you must :
  317.  
  318. 1) Get a passport sized photo.
  319.  
  320. 2) Get it digitised into the .BMP format. ( 96x100 with 16 colours )
  321.  
  322. 3) Convert this using the supplied FACECONV.EXE.
  323.    - the digitised photo will now have a .FCE suffix.
  324.  
  325. 4) The filename of this .FCE file must include the first letter of your
  326.    1st name, 1st four letters of your surname and a three digit number,
  327.    try 001.  For example : Ian Campbell would be ICAMP001.FCE.  This
  328.    will ensure everyone can upload a unique file to the BBS.
  329.  
  330. 5) Upload this to your BBS in the special OLGA FACES FILE AREA.
  331.    - this should be FILE AREA 88, but check with the Sysop first !
  332.    - if the BBS reports that the filename already exists, then increment
  333.      the serial number up by one until you are successful.
  334.  
  335. Note that if you cannot digitise or convert your own photo then we can do
  336. this for you.  See REGISTER.DOC for more details.
  337.  
  338.  
  339. QUESTIONS AND ANSWERS
  340. =====================
  341.  
  342.  
  343.  
  344. Q.  I have set up OLGA correctly, but it doesn't appear to detect an OLGA
  345.     mail when I select a packet.
  346. A.  If you are sure that there is some OLGA mail there for you then it could
  347.     be that you are not downloading the ".NDX" files.  Some QWK doors include
  348.     these files as standard, but others, like JC-QWK have them as an option.
  349.     You will need to set this option to "ON" and re-download your mail.
  350.  
  351.     Also, make sure you have the game configured correctly.  I.e. the name
  352.     assigned to the game must match exactly.
  353.  
  354. Q.  I have a game that could be converted to be OLGA-compatible.  What do I
  355.     do next ?
  356. A.  Making games "OLGA-compatible" is easy, take a look in PROGRAMR.DOC, 
  357.     that should tell you all you need to know but feel free to contact us for
  358.     support.
  359.  
  360. Q.  What's this about donations to the RSPCA ?
  361. A.  Any amount above £4 is put in to a special account for the RSPCA.  You can
  362.     send a separate cheque payable to "RSPCA Charity" if you like.
  363.  
  364. Q.  What do I get when I register ?
  365. A.  Rather than being a 'demo' or 'restricted' package, OLGA is shipped
  366.     in its entirety.  
  367.     Included in the £4, we will digitise the photos of you ( and any family-
  368.     member players - all inclusive) in to the OLGA format.
  369.  
  370.  
  371. Q.  I have internet access, does that help?
  372. A.  Indeedy.  I can u/l OLGA (c/w your new images) to any FTP server.
  373.