home *** CD-ROM | disk | FTP | other *** search
/ CD Actual 9 / CDACTUAL9.iso / share / Dos / VARIOS / siena / solpeg22 / SOLIPEG.DOC < prev    next >
Encoding:
Text File  |  1996-10-20  |  11.1 KB  |  310 lines
  1.  
  2.  
  3.     Solipeg, a Classic Marble Puzzle Game for the
  4.     Psion Series 3a, 3c and Siena
  5.     Version 2.2 (and 2.2 Lite)
  6.     Copyright (C) 1993, 1994, 1995, 1996 J Cade Roux
  7.  
  8.     This program is free software; you can redistribute it and/or modify
  9.     it under the terms of the GNU General Public License as published by
  10.     the Free Software Foundation; either version 2 of the License, or
  11.     (at your option) any later version.
  12.  
  13.     This program is distributed in the hope that it will be useful,
  14.     but WITHOUT ANY WARRANTY; without even the implied warranty of
  15.     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16.     GNU General Public License for more details.
  17.  
  18.     You should have received a copy of the GNU General Public License
  19.     along with this program; if not, write to the Free Software
  20.     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  21.  
  22. *   N.B. For space reasons the GNU General Public License is not
  23. *   included with this Psion palmtop product.
  24. *
  25. *   Source code is available from the author.
  26.  
  27.  
  28.                              Installation
  29.  
  30. This program (versions 1.2 onwards) will only run on the follwing
  31. machines:
  32.  
  33.         Psion Series 3a
  34.         Psion Siena
  35.         Psion Series 3c
  36.  
  37. Running it on a Series 3 Classic will give a warning and terminate.
  38.  
  39. When moving up to 2.2 (or any version), I recommend using the
  40. de-install procedure first (Shift-Ctrl-Delete) to clear out the
  41. environment variable.
  42.  
  43. To install Solipeg, copy Solipeg.app it to any directory (like \APP\)
  44. and install it using Install (Psion-I) from the system screen.
  45.  
  46. To access the external library (PUZZLIB.SLL is the same as the internal
  47. library in te full version and is provided for the Lite version), copy
  48. PUZZLIB.SLL to any \SOLIPEG\ directory.  Other libraries may be
  49. provided in the future.
  50.  
  51. To enable the digitized sound effects (NOT available on the Siena),
  52. copy SOLI*.WVE to any \WVE directory.  These sounds are freely
  53. distributable.
  54.  
  55. Please read the credits section at the end of this document.
  56.  
  57.  
  58.                             De-installation
  59.  
  60. To de-install the program, press Shift-Ctrl-Delete - this causes the
  61. program to free all environment space it uses (see revision history at
  62. the end of this file) and exit.  Then delete the .APP file, the .WVE
  63. files, and any .SOL or .SLL files which were created or installed.
  64.  
  65.  
  66.                                  Rules
  67.  
  68. This is the classic Solitaire game played with marbles or pegs on a
  69. board.  Solipeg is the name of an old commercial game produced in the
  70. early part of this century.  There are two board shapes, and two rule
  71. sets.
  72.  
  73. The two board shapes are:
  74.  
  75.   000                     000
  76.   000                    00000
  77. 0000000                 0000000
  78. 000O000                 000O000
  79. 0000000                 0000000
  80.   000                    00000
  81.   000                     000
  82.  
  83. English pattern         French pattern
  84.  
  85. The object is to remove pegs one by one from the board by jumping over
  86. them (similarly to Chinese Checkers), leaving just one peg in the
  87. center hole (or not, as the particular rules decree - in certain
  88. problems, for instance, that is impossible).
  89.  
  90. The standard rule set allows only N-S-E-W jumps i.e.  no diagonals.  In
  91. the diagonal rules, jumps are allowed in all eight directions.
  92.  
  93. In more complicated restrictions - see Hoyle - a specific peg can be
  94. designated as a "ball on the watch", which can only be used to make the
  95. final jump.  Other pegs can also be designated as "dead balls", which
  96. are compelled to remain stationary and may only be captured on the
  97. final move(s).  These may be implemented in future versions as new ball
  98. types in the board editor and then restrict play accordingly.
  99.  
  100. The game Puzzle-Peg (Third Edition, 1924, Lubbers & Bell Mfg. Co.,
  101. Clinton, Iowa, USA, 50 cents) included a small booklet (23 pages),
  102. "Problems in Puzzle-Peg", which details over 100 different
  103. end-game-type problems which can be played on the standard English
  104. board, sent in by players of their earlier versions.  It also contained
  105. adverts for other games of theirs.  All 104 of the problems are
  106. included in this distribution - embedded in the library.  The Lite
  107. version contains only the standard two starting positions, although an
  108. external library is provided which is comparable to the internal
  109. library.
  110.  
  111.  
  112.                                 Playing
  113.  
  114. By pressing the keys in the following pattern, the cursor can be moved
  115. one position in that direction.  If the shift key is held, a jump will
  116. be attempted in that direction, removing the peg jumped.  Only one peg
  117. may be jumped at a time, and so only one peg is removed with each turn.
  118.  
  119.                 NW          N        NE
  120.  
  121.                          E  R  T
  122.                 W        D     G     E
  123.                          C  V  B
  124.  
  125.                 SW          S        SE
  126.  
  127. N.B. For version 2.0/2.1, the keys chosen are more widely compatible
  128. with various Series 3a range international keyboards, eliminating the
  129. requirement for an external resource file to configure Solipeg,
  130. although that ability is retained.
  131.  
  132. In Version 2.2, to take advantage of the Siena's numeric keypad, the
  133. following will also work:
  134.  
  135.                 NW          N        NE
  136.  
  137.                          7  8  9
  138.                 W        4     6     E
  139.                          1  2  3
  140.  
  141.                 SW          S        SE
  142.  
  143.  
  144. Alternatively, the arrow keys can be used in a similar manner, although
  145. no diagonal moves/jumps can be made with them.  If shift is held with
  146. the arrow keys a jump is made.
  147.  
  148. If the move selected is illegal/impossible, a beep will warn the user.
  149.  
  150. To undo a move, use the Esc or Delete key.  To redo a move, use the
  151. Shift-Delete or Shift-Esc key.
  152.  
  153.  
  154.                                  Menu
  155.  
  156. File:
  157.  
  158.         New - Starts a new game.  The last starting position (last
  159.         Open, Save, Library, or External Library) is reloaded.
  160.  
  161.         Open - Opens a single save game (.SOL)
  162.  
  163.         Save - Saves a single game board (.SOL)
  164.  
  165.         Library - Opens a starting position from the internal library.
  166.  
  167.         External - Opens an external library for a list of problems -
  168.         first choose a library file (.SLL) and then choose a problem by
  169.         name
  170.  
  171. Play:
  172.         Undo Jump (when available) - Undo last move
  173.  
  174.         Redo Jump (when available) - Redo last move
  175.  
  176.         Options - Play options
  177.  
  178. Special:
  179.  
  180.         Statistics - Show statistics of past game play
  181.  
  182.         Exit - Quit Solipeg
  183.  
  184.  
  185.                                 Editing
  186.  
  187. Solipeg includes a board editor.  To use this, go into edit mode
  188. using the DIAMOND key, and then pieces can be toggled on and off
  189. using the space bar.  Then the game can be saved or one can resume play
  190. mode to play the board.  Games saved in either mode are equivalent.  By
  191. default, the \SOLIPEG directory is suggested for saved games, but they
  192. can be saved to any directory, and this directory does not need to
  193. exist on any drive.
  194.  
  195.  
  196.                                Compiling
  197.  
  198. Solipeg was written as an HWIM application and, as such, is not
  199. portable.  The source archive is freely available from the author.  To
  200. translate Solipeg to languages other than English, the resource script
  201. can be translated and added to any Series 3a and does not require any
  202. changes to the program.
  203.  
  204.  
  205.                                 Credits
  206.  
  207. PC Development Tools: Psion SIBO SDK V2 with TopSpeed C compiler and
  208. associated tools, Multi-Edit 7.0 editor for DOS and Windows by American
  209. Cybernetics
  210.  
  211. Amiga Development Tools: DeluxePaint IV
  212.  
  213. 2.2:
  214.         Update for the Siena
  215.  
  216. 2.0/2.1:
  217.         Undo option inspired by the much inferior Microsoft
  218.         Entertainment Pack game Pegged (which has no redo feature).
  219.  
  220.         Design for the undo manager and task do/undo/redo system is
  221.         based on C++ code for Visual C++/MFC/Windows from Dr. Dobb's
  222.         Journal, February 1996, "Implementing Multilevel Undo/Redo" by
  223.         Jim Beveridge.
  224.  
  225. 1.4:
  226.         Suggestions: Mark Jelic, Les Hall
  227.  
  228.  
  229.                                 Contact
  230.  
  231. Suggestions for improvements are always welcome.  Please contact me
  232. (eMail virtually guarantees same day response):
  233.  
  234. Cade Roux
  235. P.O. Box 513
  236. Boutte, LA  70039  USA
  237.  
  238. 73733.1014@compuserve.com
  239. http://ourworld.compuserve.com/homepages/cade/
  240.  
  241.  
  242.                                 History
  243.  
  244. 2.2:    Siena-compatible version
  245.  
  246. 2.1:    Fix to memory leakage any time a new game was started
  247.  
  248. 2.0:    Major code revision
  249.  
  250.         Undo-Redo added.
  251.  
  252.         Last Internal Library Puzzle added to saved information
  253.         upon exit.
  254.  
  255.         Last board position (from last open, save, library, or
  256.         external library puzzle) remembered on a new game.
  257.  
  258.         Fixed filenames to save and default to the correct extensions.
  259.  
  260.         Removed the about window - it's too annoying.  The program no
  261.         longer strictly complies with the GPL, but splash screens are
  262.         too annoying - what to do?
  263.  
  264.         Internal mechanism for determining if the application's
  265.         resource file is the correct version.
  266.  
  267. 1.5:    Internal code revision for article for PDA Developers.
  268.         Small change to the environment storage - If moving from 1.4
  269.         to 1.5, I recommend de-installing using the Shift-Ctrl-Delete
  270.         (Environment variable is now 23 bytes).
  271.  
  272. 1.4:    External libraries of problems can now be loaded.  These are
  273.         a standardized form of resource files.
  274.  
  275.         Two versions of the program are supplied - solipeg.app
  276.         (Normal), solipegl.app (Lite).  The Lite version has only a
  277.         minimal internal library.  Lite version suggested by Mark Jelic
  278.         (via CIS).
  279.  
  280.         The internal library represents 26K worth of individually saved
  281.         games (using minimum 256-byte blocks on internal disk, 512-byte
  282.         blocks on RAM SSD means this would take up 52K if saved as
  283.         individual files!) - a quite considerable savings when
  284.         compressed to a single 6K resource and then embedded.  This is
  285.         now supplied as an external library (puzzlib.sll) for Solipeg
  286.         Lite.
  287.  
  288.         This version also includes a history of the result of the last
  289.         5 completed games, plus the average number of marbles left,
  290.         plus the number of games played - these numbers can be reset
  291.         using Shift-Ctrl-Delete (the environment variable now requires
  292.         19 bytes).  Statistics option suggested by Les Hall (via CIS).
  293.  
  294. 1.3:    All 104 problems now in embedded library with descriptive names.
  295.         Stores some options in environment var "$05$sp1" for recall.
  296.         The special key combination Shift-Ctrl-Delete will delete the
  297.         environment variable (6 bytes) and exit the game without
  298.         updating them - useful for de-installation.
  299.  
  300. 1.2:    First HWIM S3a-only release:
  301.  
  302.         Completely rewritten for HWIM with full OO techniques.
  303.         Uses grey and sound.
  304.         More options - Sound, and window position.
  305.         Library embedded as a resource, save and open modified slightly
  306.  
  307. 1.1:    First release allowing individual save games.  Jump count
  308.         removed - not necessary, and minor/cosmetic bug fixes.
  309.  
  310. 1.0a:   Initial release