home *** CD-ROM | disk | FTP | other *** search
/ Boldly Go Collection / version40.iso / TS / 14A / GGG_0101.ZIP / GGGRAPH.DOC < prev    next >
Encoding:
Text File  |  1992-06-10  |  9.1 KB  |  229 lines
  1.  
  2.      GGGraph 1.01...  Copyright (c) 1991-1992 by John Morris
  3.  
  4.  
  5. What is GGGraph?
  6. ----------------
  7.  
  8.   GGGraph is what is typically called a 'graphics shell' program which can
  9. receive special character sequences and turn them into graphics commands.
  10.  
  11.   GGGraph is not application-specific, but currently only works with TW2. TW2
  12. release 11.1x was designed to use GGGraphs special graphics capabilities
  13. to produce real graphics, along with ANSI graphics.  Because GGGraph isn't
  14. application-specific, you will not need to update GGGraph if TW2's graphics
  15. commands change. You simply replace the old graphics command file with a new
  16. one.
  17.  
  18.   GGGraph has a specific set of functions it can run.  The door programmer
  19. simply has to create a command file (???.CMD) which tells GGGraph which
  20. graphics commands to run when a certain sequence is sent thru the modem.
  21. Two different door programs could theoretically send graphics sequence '1'
  22. and GGGraph would produce two different results, depending on the CMD file.
  23.  
  24.   In this way GGGraph could be used to see graphics by several different
  25. doors by loading a different command file for each door.
  26.  
  27.   Since the graphic sequences are only 2 bytes in length, the graphics
  28. commands occur quite rapidly (No screen should take longer than 2 or 3
  29. seconds to be drawn, and that's at 300 bps!).
  30.  
  31. What is required to run GGGraph?
  32. --------------------------------
  33.  
  34.   Since GGGraph will produce 'real' graphics, it uses video mode 16, which
  35. is 640x350 with 16 colors. This mode is available on EGA, and VGA adapters
  36. only. You MUST have an EGA, or VGA to run GGGraph.
  37.  
  38.   A connection with the remote modem using the parameters: No parity, 8 data
  39. bits, and 1 stop bit  is required! This is because GGGraph uses a binary type
  40. code to send the two-byte graphics commands. One byte must have a range of
  41. 0 to 255, so you must have 8 data bits.
  42.  
  43. GGGraph has also been tested under a DOS window in OS/2 2.0.
  44.  
  45. GGGraph command line parameters
  46. -------------------------------
  47.  
  48.   GGGraph currently supports these command line parameters:
  49.   [option]    -- Please note, items in double brackets are optional.
  50.  
  51.  
  52.   /Bxxx          Sets the bps rate for use by GGGraph. /B2400 sets the bps rate
  53.                  at 2400
  54.  
  55.   /Cx[,ww,yy,zz] Set the communications port.  /C1 means use COM1
  56.                  GGGraph has defaults to:
  57.  
  58.                  COM1 - UART Base: 0x3f8  IRQ Mask: 0x10  Interrupt Vector: 12
  59.                  COM2 - UART Base: 0x2f8  IRQ Mask: 0x08  Interrupt Vector: 11
  60.  
  61.                  For COM1 & 2 you can use 'short' form of the /C command
  62.                  because the defaults are built in for them.
  63.                  If you wish to use a port above COM2, you need to use the
  64.                  long form of the /C command: /Cx,ww,yy,zz
  65.  
  66.                  x  - The com port number. You must use a number above 2
  67.                       to enable the long form of the /C command. The com port
  68.                       number isn't really important. You can use the number
  69.                       3 in any situation. What GGGraph really needs to know
  70.                       are the following numbers.
  71.                  ww - UART Base address (in hexadecimal format)
  72.                  yy - IRQ Mask          (in hexadecimal format)
  73.                  zz - Interrupt Vector  (in decimal format)
  74.  
  75.   /Ffilename.ext Loads in a specific CMD file. If you don't use the /F
  76.                  command then GGGraph will load TW2.CMD as the default.
  77.                  If you use the /F command, you must give the complete
  78.                  filename and extension. GGGraph will not run without a
  79.                  CMD file loaded.
  80.  
  81.   /N             If you have a 16550A UART chip, you can use this command to
  82.                  tell GGGraph NOT to use the FIFO buffers in the chip.
  83.  
  84.   /S             Tells GGGraph that it is okay to use sound. Using the speaker
  85.                  in some situations isn't always good, so by default, sound
  86.                  is OFF.
  87.  
  88. Examples:
  89.  
  90. GGGRAPH /B19200 /C2
  91.  
  92. This command sets the bps rate at 19200,N,8,1 on COM2
  93.  
  94. GGGRAPH /B1200 /C1 /S
  95.  
  96. means use COM1 at 1200,N,8,1, and it's okay to use the speaker
  97.  
  98. GGGRAPH /B115200 /C3,0x2e0,0x10,12 /N
  99.  
  100. means use COM3 where the UARTs base address is 0x2e0, and IRQ mask of 0x10,
  101. an interrupt vector of 12, and don't use the 16550 FIFO buffers. Set the bps
  102. rate at 115200,N,8,1.
  103.  
  104. Files that come with GGGraph
  105. ----------------------------
  106.  
  107. GGGraph comes with several files. 5 of them are TW2 11.1x specific. They are:
  108. CLASS?.DAT, and TW2.CMD    You must have these files in the current directory
  109. if you are running GGGraph with TW2. To turn your graphics on or off in TW2
  110. release 11.10 (and up) use the 'O' command at the 'TW2 Command?' prompt.
  111.  
  112. Non-specific files include GGGRAPH.DOC (this file), and MODERN.FON (font
  113. file).
  114.  
  115.  
  116. Commands available in GGGraph
  117. -----------------------------
  118.  
  119.   There are two basic commands available once you are inside GGGraph.
  120.  
  121.   Alt-C     Clears the screen  not usually needed in graphics mode, as the
  122.             remote door program will clear the screen quite often.
  123.  
  124.   Alt-S     Toggles the speaker on/off.  The remote end must be able to send
  125.             sound commands to GGGraph. (also see the /S command line switch)
  126.  
  127.   Alt-X     Exit GGGraph
  128.  
  129.  
  130. How to use GGGRaph
  131. ------------------
  132.  
  133.    GGGraph can be used as a very simple (and dumb) comm program. But it
  134. is best used when playing TW2.  Call up your favorite BBS using your normal
  135. comm program.  Right before you play TW2, SHELL out of your comm program
  136. and load GGGraph using the above command line parameters.  After GGGraph
  137. is loaded you can then enter the command to play TW2.  When you are thru
  138. playing TW2, you then hit ALT-X to leave GGGraph, you can then exit
  139. back to your normal comm program to continue using the BBS.
  140.  
  141.    To automate the process, you could make GGGraph one of your 'download
  142. protocols' in your comm program. That way you can simply hit 'PgDn' (or
  143. whatever your download command is) and have your comm program automatically
  144. shell and load GGGraph, and when you hit ALT-X, your comm program would
  145. automatically reload.
  146.  
  147. For instance, in Qmodem 4.3, you would load QInstall, go to the Protocol
  148. set-up section, and make a protocol called 'GGGraph'.  The select character
  149. could be '1', The Upload and Download batch files would be GGGRAPH.BAT,
  150. and the should be No filename prompt.  GGGRAPH.BAT would look like:
  151.  
  152. @Echo Off
  153. Gggraph /C%2 /B%3
  154. Exit
  155.  
  156. And thats it. The example assumes you have GGGraph in your Qmodem directory.
  157. Right before you have the BBS load TW2, simply hit either 'PgDn', or 'PgUp'
  158. and GGGraph will load.   Make sure TW2.CMD, and the CLASS?.DAT files are in
  159. the same direcotry as the one you load GGGraph in.
  160.  
  161. What I use to make GGGraph
  162. --------------------------
  163.  
  164. GGGraph started out as 'GSHELL' in late '89.  I was then using Microsoft
  165. C 5.1 to do my compiling.. but for some reason C5.1 couldn't compile the
  166. GSHELL code.. An 'Internal Compiler Error' of all things popped up when
  167. I tried to compile GSHELL.  QuickC 2.0 compiled it fine.. but it didn't
  168. support the memory models I needed.. so GSHELL was put on the back-burner
  169. till I could get time to work on it again.. this time as GGGraph.
  170.  
  171. GGGraph is compiled with Microsoft C 6.00A, and uses Microsofts graphics
  172. library.
  173.  
  174. For communications, I switched from a FOSSIL/Greenleaf CommLib combo to
  175. the shareware MCOMM library by Mike Dumdei.  I had used Mike's ANSIDRV
  176. routines in TW2 for about a year, liked them, so I am trying the whole
  177. MCOMM package out for the first time with GGGraph.
  178.  
  179. For sound, GGGraph uses my own little creation called Muzak which uses
  180. a macro language very similar to BASIC's PLAY statement. Muzak is
  181. written in C, and uses 'in-line assembly' liberally. Like the graphics
  182. commands, Muzak gets the macro strings from the command (.CMD) file.
  183.  
  184.  
  185. Need help?
  186.  
  187. HOW TO REACH ME
  188.  
  189. I support this program to the best of my ability. There are several different
  190. ways of contacting me.
  191.  
  192. Mail:
  193.  
  194. John Morris          (This address is subject to change!)
  195. 2620 Emily St.
  196. Reno, NV 89503
  197.  
  198. Netmail:
  199.  
  200. RBBS-Net 8:919/1 or 2  -OR-  Fidonet  1:213/760 or 761
  201.  
  202. Echomail:
  203.  
  204. The TW-ECHO & TW-BETA echomail conferences.  I am not affiliated with
  205. the TRADEWARS echo.
  206.                                                                   Page 47
  207.  
  208. BBS:
  209. The Abandoned Land     (These numbers subject to change!)
  210. (702) 746-1364
  211. (702) 746-1365
  212.  
  213. Voice:
  214. (702) 746-1358
  215.  
  216. If I'm not at home, and you have a bug report, you can leave a message about
  217. the bug on my answering machine. Hit '*' to bypass the message.
  218.  
  219. As you may hear on my answering machines message, I don't get a chance to
  220. return many phone calls.. maybe 1 in 100.. thats it.  I wish I could
  221. return more of them, but this program is just a hobby at the moment, and
  222. I have lots of other things I need to do. Its mainly a lack of time. I always
  223. return mail left to me on my BBS. So if you must have a reply, e-mail me
  224. on The Abandoned Land.
  225.  
  226.  
  227. If you wish to obtain more information on how GGGraph works, drop me a line
  228. or call me. I'll be more than happy to supply more info.
  229.