home *** CD-ROM | disk | FTP | other *** search
/ Gold Fish 3 / goldfish_volume_3.bin / files / fish / disks / d1083.lha / Programs / AntiMatter / AntiMatter.doc < prev    next >
Encoding:
Text File  |  1995-01-26  |  16.8 KB  |  572 lines
  1.  
  2.  
  3.     AntiMatter User Manual
  4.  
  5. ($VER: AntiMatter.doc $Revision: 1.5 $ $Date: 95/01/25 22:30:27 $)
  6.  
  7. Copyright © 1995 Adam Levin-Delson  All Rights Reserved
  8.  
  9. Permission is hereby granted to distribute the AntiMatter executable and
  10. documentation via electronic means and in Amiga software collections for
  11. which no charge or only a small amount of money more than production costs is
  12. charged.
  13.  
  14.  
  15. AntiMatter is a single-player strategy game in which the computer hides a
  16. number of atoms in a chamber.  You must determine the locations of the atoms
  17. by firing plasma rays into the chamber and observing where the rays (which
  18. are influenced by the atoms) emerge.
  19.  
  20.  
  21. This documentation is divided into the following categories:
  22.  
  23. 1  Features         - Features of this implementation.
  24.  
  25. 2  Instructions     - How to play AntiMatter.
  26.  
  27. 3  Bug reports      - How to report bugs to the author.
  28.  
  29. 4  Source code      - How to obtain the Source code.
  30.  
  31. 5  Acknowledgements - Acknowledgements and credits.
  32.  
  33. 6  Release history  - Describes the various versions of AntiMatter.
  34.  
  35.  
  36. Documentation is available during gameplay at the press of the Help key.  To
  37. enable this feature, assign "AM:" to the directory where AntiMatter.doc can
  38. be found.
  39.  
  40.  
  41. =============================================================================
  42.  
  43.     1  AntiMatter Features - Features of this implementation.
  44.  
  45.  
  46. Stereo sound
  47. - Four-channel stereo sound follows the action!
  48. - Conforms to the Amiga's "channel-locking" convention, allowing channels to
  49.   be stolen by higher priority requests, and later returned to the original
  50.   owner.
  51.  
  52. Animated Pointer
  53. - 30fps animated pointer using a proprietary vertical-blank interrupt handler.
  54. - Multiple instantiations of AntiMatter share the animating routine.
  55.  
  56. Configurable
  57. - The player can choose how large a chamber to use (6x6 through 14x14)
  58.   as well as how many atoms will be hidden (3 through 8).  (See "Starting
  59.   AntiMatter".)
  60.  
  61. OS-sensitive
  62. - Runs under AmigaOS 1.3, 2.x and 3.x and on all 680x0 processors.
  63.  
  64. Low memory usage
  65. - Opens a lo-res screen and uses a "shading" pattern to extend the color
  66.   palette.
  67. - Chip RAM audio samples are shared for the various sound effects.
  68.  
  69. Well tested
  70. - Developed using Enforcer and Mungwall.
  71.  
  72.  
  73. =============================================================================
  74.  
  75.     2  AntiMatter Instructions - How to play AntiMatter.
  76.  
  77.  
  78. A new game is set up when Antimatter is first invoked.  Changing the
  79. configuration of the board (see "Starting AntiMatter") will also set up a
  80. new game, as will selecting "New game" from the "Project" menu.
  81.  
  82.  
  83. The instructions are divided into the following sub-categories:
  84.  
  85.     2.1  Starting Antimatter
  86.  
  87.     2.2  Firing rays
  88.  
  89.     2.3  Ray travel
  90.  
  91.     2.4  Marking choices
  92.  
  93.     2.5  Scoring
  94.  
  95.     2.6  Menus
  96.  
  97.     2.7  Online Help
  98.  
  99.     2.8  Tips
  100.  
  101.  
  102. =============================================================================
  103.  
  104.     2.1  Instructions - Starting Antimatter
  105.  
  106.  
  107. Antimatter can be started from either the Workbench (by double-clicking on
  108. the Antimatter icon) or from the shell.  Game preferences can be specified
  109. from either interface.
  110.  
  111. --------------------------------------
  112.  
  113.     2.1a  Starting AntiMatter - Workbench
  114.  
  115.  
  116. The number of atoms and size of the chamber can be set in AntiMatter's icon
  117. (using "Information" from the Workbench) with "ATOMS=" and "SIZE=" tooltypes.
  118. An additional ToolType parameter, "SOUNDPRI=" can be used to set the priority
  119. of AntiMatter's sound effects.  If SOUNDPRI is set to the special value
  120. "999", AntiMatter will not generate any sounds.
  121.  
  122. Valid numbers of atoms range from 3 to 8; chamber size from 6 (6x6) to 14
  123. (14x14).
  124.  
  125. The default values for the tooltypes are as follows:
  126.  
  127.     ATOMS=4
  128.  
  129.     SIZE=8
  130.  
  131.     SOUNDPRI=127
  132.  
  133.  
  134. --------------------------------------
  135.  
  136.     2.1b  Starting AntiMatter - Shell
  137.  
  138.  
  139. The number of atoms and size of the chamber can be specified when starting
  140. AntiMatter from the Command Line (Shell).  An additional argument can be used
  141. to set the priority of AntiMatter's sound effects.  If SOUNDPRI is set to the
  142. special value "999", AntiMatter will not generate any sounds.
  143.  
  144. Valid numbers of atoms range from 3 to 8; chamber size from 6 (6x6) to 14
  145. (14x14).
  146.  
  147. The syntax of the command depends upon the version of the operating system
  148. installed on your Amiga.
  149.  
  150.  
  151. Newer versions of AmigaDOS (specifically, version 2.04 and later) use the
  152. "ReadArgs" syntax:
  153.  
  154.     Antimatter ATOMS=4 SIZE=8 SOUNDPRI=127
  155.  
  156. Older versions use a Unix-style syntax:
  157.  
  158.     AntiMatter -a4 -s8 -p127
  159.  
  160.  
  161. Both formats shown above illustrate the default AntiMatter values.
  162.  
  163.  
  164. --------------------------------------
  165.  
  166.     2.1c  Starting AntiMatter - Sound Priority
  167.  
  168.  
  169. AntiMatter allocates all four Amiga audio channels to create action-specific
  170. stereo sound.  A priority level of 127 will prevent any other application
  171. from stealing AntiMatter's audio channels.  Anything less than 127 (down to
  172. -128) will allow applications with a higher audio priority to steal the
  173. channels.  AntiMatter will attempt to reallocate stolen channels as soon as
  174. they are freed.
  175.  
  176.  
  177. =============================================================================
  178.  
  179.     2.2  Instructions - Firing Rays
  180.  
  181.  
  182. Fire a ray by positioning the laser (cursor) at one of the chamber entrances
  183. (the squares along the chamber edges) and clicking the left mouse button.
  184.  
  185. The entrance (and exit, if the ray ultimately exited the chamber) will then
  186. be indicated with a colored marker (described in Ray travel) determined by
  187. how the chamber's atoms influenced the ray.
  188.  
  189.  
  190. =============================================================================
  191.  
  192.     2.3  Instructions - Ray travel
  193.  
  194.  
  195. A ray will normally travel in a straight line (an Unimpeded flight, the ray
  196. passes straight through the chamber) unless acted upon by one or more atoms.
  197.  
  198. There are two primary ways in which a ray can be effected by atoms:
  199.  
  200. Absorption - The ray is absorbed by an atom in the chamber.
  201.  
  202. Deflection - The ray is caused to veer 90° from a straight line.
  203.              There are two special cases of Deflections known as Reflections.
  204.  
  205.  
  206. Note that the influence of multiple atoms in the chamber can combine to yield
  207. complex results.
  208.  
  209.  
  210. --------------------------------------
  211.  
  212.     2.3a  Ray travel - Unimpeded flight
  213.  
  214.  
  215. If there are no atoms directly in the ray's path, nor along the left or right
  216. of the path, the ray will pass straight through the chamber, exiting on the
  217. opposite side.
  218.  
  219. The entrance and exit locations will be indicated with like-color markers.
  220.  
  221.  
  222. --------------------------------------
  223.  
  224.     2.3b  Ray travel - Absorption
  225.  
  226.  
  227. If a ray is fired directly into an atom, it is absorbed, and does not exit
  228. the chamber.
  229.  
  230. The square where the ray entered the chamber will be indicated with a black
  231. marker.
  232.  
  233.  
  234. --------------------------------------
  235.  
  236.     2.3c  Ray travel - Deflection
  237.  
  238.  
  239. If a ray would pass immediately alongside an atom the ray will be deflected
  240. away from the atom at a right angle to its original path.
  241.  
  242. If the ray would have passed the atom on the atom's right side, the ray is
  243. deflected to the right.
  244.  
  245. If the ray would have passed on the atom's left side, it is deflected to the
  246. left.
  247.  
  248.  
  249. Note that the deflection occurs one square *before* the ray and the atom
  250. would be next to each other.  The entrance and exit locations will be
  251. indicated with like-color markers.
  252.  
  253.  
  254. There are two important conditions that result in a special type of
  255. deflection known as a Reflection.
  256.  
  257.  
  258. ......................................
  259.  
  260.     2.3d  Ray travel - Reflection
  261.  
  262.  
  263. If the deflecting atom is alongside the square at which the ray would enter
  264. the chamber, the ray is unable to be deflected, and is instead reflected
  265. directly back out.
  266.  
  267. This reflection is indicated with a white marker at the attempted entrance
  268. point.
  269.  
  270.  
  271. A reflection also occurs if there are two atoms straddling the ray's path (ie
  272. they are exactly one square apart and the ray is traveling down the path
  273. between them).  The ray is deflected both right and left at the same time,
  274. but cannot overcome either atom, and is instead reflected back along the path
  275. from which it came.
  276.  
  277. The ray emerges from the same location it entered, and the reflection is
  278. indicated with a white marker.
  279.  
  280.  
  281. =============================================================================
  282.  
  283.     2.4  Instructions - Marking choices
  284.  
  285.  
  286. As you fire rays into the chamber, and observe the results, you will start to
  287. form an idea of where the hidden atoms are.
  288.  
  289. You can mark your suspected locations by positioning the cursor over the
  290. desired location in the center grid of the chamber and clicking the left
  291. mouse button, creating a white marker.
  292.  
  293. Clicking on the same location again will remove the marker.  While you may
  294. place as many markers in the center grid of the chamber as you like, you will
  295. not be able to score your guesses if you have more markers than there are
  296. atoms hidden in the chamber.
  297.  
  298.  
  299. =============================================================================
  300.  
  301.     2.5  Instructions - Scoring
  302.  
  303.  
  304. During game play, you may place as many markers in the center grid of the
  305. chamber as you like.  In order to calculate your score, however, you may have
  306. no more markers than there are atoms hidden in the chamber.
  307.  
  308. Once you believe that you have correctly guessed the location of all the
  309. atoms in the chamber, (as indicated by your white markers in the center
  310. grid), choose the menu item "Guess/How did I do?".
  311.  
  312. If the "How did I do?" menu choice is ghosted (disabled), you have too many
  313. markers on the center grid of the chamber.  Simply click on the unneeded
  314. markers until you have as many (or fewer) markers as there are atoms hidden
  315. in the chamber.
  316.  
  317. To calculate your score, the actual locations of the atoms will be displayed.
  318. Atoms which you correctly guessed will be marked with a checkerboard marker,
  319. atoms which you missed will be solid red, and atoms which you thought existed
  320. but didn't are left in white.
  321.  
  322. Your score is calculated from the number of rays fired, and the number of
  323. atoms correctly guessed.  The lower your score the better.
  324.  
  325.  
  326. =============================================================================
  327.  
  328.     2.5a  Instructions - Score calculation
  329.  
  330.  
  331. The formula used for calculating the score is:
  332.  
  333.  
  334.     ( 5 * ( A - C ) ) + R
  335.  
  336.  
  337.     where
  338.  
  339.  
  340.     A is the number of atoms embedded in the chamber.
  341.  
  342.     C is the number of atoms correctly identified
  343.       with markers in the center of the chamber.
  344.  
  345.     R is the number of ray markers along the edges
  346.       of the chamber.
  347.  
  348.  
  349. =============================================================================
  350.  
  351.     2.6  Instructions - Menus
  352.  
  353.  
  354.     AntiMatter has three main menus:
  355.  
  356.  
  357.     2.6a  Project menu
  358.  
  359.     2.6b  Prefs menu
  360.  
  361.     2.6c  Guess menu
  362.  
  363.  
  364. --------------------------------------
  365.  
  366.     2.6a  Menus - Project Menu
  367.  
  368.  
  369. The "Project/New Game" menu item (Keyboard shortcut "Right-Amiga N") will
  370. begin a new game with the selected game parameters of chamber size and number
  371. of atoms.
  372.  
  373. The "Project/About..." menu item ("Right-Amiga A") gives credit for the
  374. original board game upon which AntiMatter is based.
  375.  
  376. The "Project/Quit" menu item ("Right-Amiga Q") will exit the game.
  377.  
  378.  
  379. --------------------------------------
  380.  
  381.     2.6b  Menus - Prefs Menu
  382.  
  383.  
  384. There are several menu selections that will help you tailor AntiMatter to
  385. your desired level of difficulty.  The "Prefs/Atoms" and "Prefs/Size of
  386. Chamber" menu items will allow you to set the number of atoms and the size of
  387. the chamber.  The currently selected values are displayed in a "ghosted" or
  388. dimmed manner.  As soon as you change one of these parameters, a new game
  389. will be created using the new value(s).  You can choose from both the "Atoms"
  390. and "Size of Box" menus without releasing the "menu" (right) mouse button in
  391. between.  This is known as extended-selecting the items.
  392.  
  393. These preferences can also be specified when AntiMatter is invoked from
  394. either the Workbench or Shell.
  395.  
  396.  
  397. --------------------------------------
  398.  
  399.     2.6c  Menus - Guess Menu
  400.  
  401.  
  402. The "Guess/Clear Markers" and "Guess/Set Markers" menu items (Keyboard
  403. shortcuts "Right-Amiga C" and "Right-Amiga S", respectively) will allow you
  404. to clear or set all the center grid markers at once.
  405.  
  406. The "Guess/How did I do?" menu item ("Right-Amiga T") will tally up your
  407. score.  You will be unable to select this item if there are too many "guess"
  408. markers on the center grid.
  409.  
  410.  
  411. =============================================================================
  412.  
  413.     2.7  Instructions - Online Help
  414.  
  415.  
  416. Pressing the "Help" key during game play will interrupt the action and call
  417. up "AmigaGuide" to display this documentation.
  418.  
  419. AmigaGuide will be instructed to look in the same directory that AntiMatter
  420. is located in for "AntiMatter.guide".
  421.  
  422. Should either AmigaGuide or the guide file not be found, AntiMatter will
  423. attempt to call up "More" (actually Sys:Utilities/More) on
  424. "AM:AntiMatter.doc".
  425.  
  426.  
  427. =============================================================================
  428.  
  429.     2.8  Instructions - Tips
  430.  
  431.  
  432.     2.8a  Preferences
  433.  
  434.     2.8b  Beginner games
  435.  
  436.     2.8c  Deflections
  437.  
  438.     2.8d  Impossibilities
  439.  
  440.  
  441. --------------------------------------
  442.  
  443.     2.8a  Tips - Preferences
  444.  
  445.  
  446. The default size of 8x8 and 4 atoms is a good starting point, but feel free
  447. to make the chamber smaller or the atoms fewer when learning how the rays are
  448. effected by the atoms.
  449.  
  450.  
  451. --------------------------------------
  452.  
  453.     2.8b  Tips - Beginner Games
  454.  
  455.  
  456. To help in understanding how rays are effected by the atoms, you may choose
  457. to fire rays into all possible entrances, then select the "Guess/How did I
  458. Do" menu to see the locations of the atoms, and then study the path of all
  459. the rays.
  460.  
  461.  
  462. --------------------------------------
  463.  
  464.     2.8c  Tips - Deflections
  465.  
  466.  
  467. Keep in mind that Deflections occur one square before the ray would be
  468. alongside an atom.
  469.  
  470.  
  471. --------------------------------------
  472.  
  473.     2.8d  Tips - Impossibilities
  474.  
  475.  
  476. There are configurations of atoms ("molecules") which cannot be completely
  477. determined even if rays are fired into all chamber entrances.
  478.  
  479. The likelihood of such molecules increases with the number of atoms embedded
  480. in the chamber.
  481.  
  482.  
  483. =============================================================================
  484.  
  485.     3  Bug reports - How to report bugs to the author.
  486.  
  487. Bug Reports are encouraged, and may be sent electronically or by mail to the
  488. author.
  489.  
  490. The first person to report each reproducible bug will receive a corrected
  491. copy as soon as it is available.
  492.  
  493.  
  494. =============================================================================
  495.  
  496.     4  Source code - How to obtain the Source code.
  497.  
  498. SAS 'C' (v6.51) source code for AntiMatter is available from the author for
  499. US$10 (this includes postage in the United States; peoples of all other
  500. countries [unite!] must include appropriate postage to pay for the shipment
  501. of one diskette from the US to your country).
  502.  
  503. 680x0 assembler source code for AnimPtr, the sharable vertical-interrupt
  504. handler for pointer animation is available for US$5.
  505.  
  506. Note that the source code for AntiMatter and AnimPtr are not redistributable.
  507. They may, however, be used as the basis for other programs, which may be
  508. distributed as you see fit, so long as an acknowledgement of my original
  509. source is clearly given.
  510.  
  511.  
  512. --------------------------------------
  513.  
  514.     4.a  AntiMatter - Contacting the author
  515.  
  516.  
  517. Contact me to report bugs found in AntiMatter, or to obtain a copy of the
  518. source code.
  519.  
  520. My mail address is:
  521.  
  522.     Adam Levin-Delson
  523.     22325 53rd Ave SE
  524.     Bothell, WA  98021  USA
  525.  
  526. My E-Mail address is:  aklevin@bix.com
  527.  
  528.  
  529. =============================================================================
  530.  
  531.     5  AntiMatter - Acknowledgements
  532.  
  533.  
  534. AntiMatter is based upon the board game "Black Box", by Eric Solomon.  It was
  535. originally produced by Waddingtons House of Games in the United Kingdom, and
  536. then by Parker Brothers in the United States of America.
  537.  
  538. AntiMatter is Copyright © 1988-1995 Adam Levin-Delson  All Rights Reserved
  539.  
  540.  
  541. Many thanks to the following people:
  542.  
  543.     Bernie Cosell and Bruce Barnett, for their kind help in providing
  544.       information and materials pertaining to the two board-game
  545.       versions of "Black Box".
  546.  
  547.     Michael Sinz, Peter Cherna, Spencer Shanson and Carolyn Scheppner,
  548.       all of(at the time) Commodore Business Machines.
  549.  
  550.     Peter Kunath for audio channel-sharing example code.
  551.  
  552.     Boyd & Gian Edmondson for beta-testing.
  553.  
  554.     Toby Douglass for bug-reporting.
  555.  
  556. =============================================================================
  557.  
  558.     6  AntiMatter - Release history
  559.  
  560.  
  561. AntiMatter's version number can be found in the information provided by the
  562. "About..." menu selection as well as from the AmigaDOS "Version" command.
  563.  
  564.     Version     Date           Comments
  565.     1.0                1988    Working (audioless) version.  Not distributed.
  566.     1.XX        1993 - 1994    Took advantage of AmigaOS 2.x/3.x features.
  567.                                Added animated pointer.
  568.                                Added sound routines.
  569.     2.0         06 Jan 1995    First full release.
  570.     2.1         25 Jan 1995    Fixed bug preventing Euro36 screens from opening.
  571.                                (Toby Douglass found this.)
  572.