home *** CD-ROM | disk | FTP | other *** search
/ The Pier Shareware 6 / The_Pier_Shareware_Number_6_(The_Pier_Exchange)_(1995).iso / 035 / pmics.zip / readme < prev    next >
Text File  |  1994-12-13  |  8KB  |  201 lines
  1.                 ==================================
  2.                 PMICS User Guide: version 1.0 BETA
  3.                 ==================================
  4.  
  5. ------------
  6. Introduction
  7. ------------
  8.  
  9. PMICS is an OS/2 interface for playing chess via Internet Chess Server
  10. (ICS).  It supports access either through a dialup shell account,
  11. available through your favourite internet service provider, or
  12. SLIP/PPP protocols such as included with the OS/2 WARP Internet
  13. Connection (and also by some internet providers).
  14.  
  15. PMICS comes with source (for what it's worth...) and is freely
  16. redistributable under the terms of the GNU General Public License.
  17. The author has no connection with the Free Software Foundation, so all
  18. bugs are his responsibility.  Comments are welcome at chow@netcom.com.
  19.  
  20. -----------------------
  21. About this beta version
  22. -----------------------
  23.  
  24. Two executables are included.  Use pmicstcp.exe if you have OS/2 Warp,
  25. and pmics.exe otherwise; you can delete the one you don't use.  Both
  26. versions support 'shell account' connections to ics, and pmicstcp.exe
  27. additionally enables TCP/IP connection using the SLIP support in Warp.
  28.  
  29. A note about bloat: The code uses the GUI class libraries in IBM
  30. C/Set++, which simplifies the logic but bloats the binary.  When
  31. packaging an application one can either include the class library
  32. DLLs, which come to 1.5MB plus the application (pmics is 180K), or
  33. bind them statically with the application which results in a 600K
  34. pmics.  So the static version looks like the lesser of two evils; in
  35. addition it loads faster.
  36.  
  37. The format of the options has changed since pmics091.  Options now
  38. have the form -option or -option=value with more intuitive names (you
  39. can use '/' instead of '-' and case is significant).  If you used
  40. pmics091, please read through the options section for the new syntax.
  41.  
  42. Fixes from the alpha version:
  43.  
  44. *  -xper and -yper options have been removed; the window now initializes
  45.    itself properly.
  46. *  autoflag won't call flag if you have run out of time, including when
  47.    both flags have fallen.
  48. *  reduced 'flashing' of the status display
  49. *  removed translation of CR->LF.  If the return key echoed '^J' on your
  50.    host this should be fixed.
  51. *  option "-bs=del" maps Backspace to ascii 127 instead of the
  52.    default ascii 8; "-cr=lf" to map Enter to ascii 10 instead of the
  53.    default ascii 13.  these functions can also be selected from the
  54.    Session... menu
  55. *  option -localecho enables a simple local echo facility; the default
  56.    is no local echo.  this may be especially helpful under tcp/ip if
  57.    you don't see your characters being echoed.  it can also be selected
  58.    from the Session... menu
  59.  
  60. Bugs:
  61.  
  62. *  Help menu items don't do anything
  63. *  ^] doesn't work
  64.  
  65. If you have C++/Set, there is an excellent book on using the UI class
  66. library published recently: "OS/2 C++ Class Library" by Leong, et al.
  67. VNR 1995 (ISBN 0-472-01795-2).
  68.  
  69. ----------------
  70. Installing PMICS
  71. ----------------
  72.  
  73. In addition to pmics.exe (pmicstcp.exe, if running os/2 warp), the
  74. file pmics.hlp must be copied to the working directory where you
  75. invoke pmics.  The other files are source and are not needed to
  76. run the program.
  77.  
  78.  
  79. -------------
  80. Running PMICS
  81. -------------
  82.  
  83. Typing "start pmics" will run the program in its own session.  By
  84. default it assumes there is a modem on the serial port which will be
  85. used to dial into a shell account.  It grabs the first openable COM
  86. port at 19200 baud.  If this auto-mode doesn't doesn't work for you,
  87. specify your COM port and baud rate explicitly with -port=n and
  88. -baud=nnnn, e.g.
  89.  
  90.         start pmics -port=2 -baud=2400
  91.  
  92. for COM2 at 2400 baud.  After the chessboard window comes up, connect
  93. to your host system by typing your modem's dial commands
  94. (e.g. ATDTnnnmmmm), then logging in and telnetting to ics.
  95.  
  96. To use TCP/IP (which requires OS/2 Warp and SLIP access), specify the
  97. -tcp, -tcphost and -tcpport options instead of -port, -baud and -dial:
  98.  
  99.         start pmics -tcp -tcphost chess.lm.com
  100.  
  101. If this is successful, pmics will start up with the ICS login page
  102. displayed.
  103.  
  104. Once you are connected to ICS enter the command "style 12" so that
  105. pmics can parse the game status messages.  If you are a registered
  106. user then ICS will remember the style setting next time you log onto
  107. the server and you don't need to specify it again.
  108.  
  109. If the window is not the right size, use the command line parameters
  110. -x=nnn and -y=nnn to override the default window dimensions (currently
  111. the whole desktop).  An invocation suitable for 1024x768 is:
  112.  
  113.    start pmics -medium -x=800 -y=768
  114.  
  115. These display options are orthogonal to the serial/tcp session
  116. options.  Once you determine the right options it may be convenient to
  117. encode them in a shell script or desktop icon.
  118.  
  119. Options summary:
  120.    -small             use small board and piece bitmaps (VGA).  default.
  121.    -medium            use medium board and piece bitmaps (SVGA)
  122.    -large             use giant board and piece bitmaps (1280x1024)
  123.    -port=n            specify COMn port to use.  default: autodetect
  124.    -baud=n            specify COM port baud rate.  default: 19200.
  125.    -dial=string       specify a modem init string.  this can be a dial
  126.                       command, e.g.: -dial=ATDT2614700
  127.                                      -dial="ATS11=40 DT2614700"
  128.    -x=n               specify X dimension of window in pixels
  129.    -y=n               specify Y dimension of window in pixels
  130.    -commfont=fontname specify font to use for the comm window.
  131.                       default: "System VIO"
  132.    -commfontsize=n    specify point size of comm font.  default: 14
  133.    -tcp               applies only to pmicstcp.exe, which requires OS/2 Warp.
  134.                       use tcp/ip instead of serial port
  135.    -tcphost           specifies hostname or ip address of ICS machine.
  136.                       e.g.: -tcphost=chess.lm.com
  137.                             -tcphost=192.231.221.16
  138.                       default: chess.lm.com
  139.    -tcpport           specifies port number of ICS machine.  default: 5000
  140.    -autoflag          enable autoflag (available as menubar option)
  141.    -bs=del            translate Backspace to ascii 127 instead of 8
  142.    -cr=lf             translate Enter to ascii 10 instead of 13
  143.    -localecho         enable local echo of characters typed in the comm window
  144.  
  145. -------------
  146. Playing chess
  147. -------------
  148.  
  149. Select a piece with the left mouse button and release the button over the
  150. target square.  Clicking the right button reissues the last move you made.
  151.  
  152. The Board menu has a Flip option to rotate the board 180 degrees.
  153. This is also mapped to the F3 function key.
  154.  
  155. PMICS recognizes challenge messages and pops up a dialog informing you
  156. of the match parameters.  This also works when PMICS is minimized.
  157.  
  158. You can change the font used for the terminal window using the Board
  159. menu.  You can grab the border separating the board and terminal
  160. windows and drag it to resize them.  The main use of this is to
  161. temporarily enlarge the terminal window, e.g. for viewing large chunks
  162. of text or intense chat mode.
  163.  
  164. If the displayed position or status gets scrozzled, press the refresh
  165. button.
  166.  
  167.  
  168. -----------
  169. Future work
  170. -----------
  171.  
  172. - better default board size; bypass help file not found
  173. - Various improvements: make pushbuttons customizable, provide separate
  174.   entry field for input
  175. - Hook up to gnuchess.  Need to do lots of tedious work in gnuchess
  176.   to communicate with separate process.  I guess pmchess has laid the
  177.   groundwork in this area.
  178. - I had a prototype working where gnuchess played on the ICS (under user
  179.   'fuzzy') through pmics, but need a faster machine to make this interesting.
  180.  
  181.  
  182.  
  183. --------------
  184. Update history
  185. --------------
  186. 94/12/12   1.00    (beta)
  187. 94/11/22   1.00    (alpha)
  188.  
  189.  
  190. ----------------
  191. Acknowledgements
  192. ----------------
  193.  
  194. PMICS was inspired by the excellent DOS interface, GIICS, written by
  195. Tony Acero.  The bitmaps for the pieces are taken from the GNU program xboard.
  196. Serial port IOCTL magic was adapted from the PD comm program comtalk.
  197.  
  198. Kevin Nomura
  199. chow@netcom.com
  200. 94/12/12
  201.