home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 5 / amigaformatcd05.iso / screenplay / shareware / mastermind / mastermind.doc < prev    next >
Text File  |  1996-08-13  |  8KB  |  220 lines
  1.  
  2. Program name:  MasterMind V1.6
  3.  
  4. What it does:  Implements the game of Master Mind 
  5.  
  6. Author:        Kamran Karimi
  7.  
  8. Written with:  SAS/C 6.50
  9.  
  10. Source:        Included
  11.  
  12. Machine:       Amiga 1200
  13.  
  14. Program status:You can run the program freely, but I retain the Copyright 
  15. to the program including the source and the executable form of it.
  16. -----------------------------------------------------------------------------
  17.  
  18. Directory contents:
  19.  
  20.  MasterMind <-- The program itself
  21.  
  22.  MasterMind.doc <-- The file you are reading now
  23.  
  24.  MasterMind.jl <-- this is a demo of how to use MasterMind. To use it,
  25.                    first run MasterMind, then this program
  26.  
  27.  MasterMind.jl.doc <-- a short explanaition of masterMind.jl
  28.  
  29.  Source/MasterMind.c <-- source of mastermind
  30.  
  31.  Source/Misc.h <-- header used by MasterMind.c
  32.  
  33.  Source/MasterMind.jl.c <-- source of MasterMind.jl
  34.  
  35.  Source/MasterMind.jl.h <-- header used by MasterMind.jl.c
  36. -----------------------------------------------------------------------------
  37.  
  38.  
  39.  What Is Master Mind?
  40.  
  41.  Master Mind is a simple but interesting game: The Amiga chooses some
  42. colors randomly and places them in a row. You have to guess not only
  43. the colors, but also their places in the row. To do this, you guess
  44. some colors and place them in a row as you see appropriate. When done,
  45. the Amiga shows you the results by way of white and black circles.
  46.  
  47.  A white circle shows that a color you have guessed is among the ones 
  48. the Amiga has chosen. A black circles says that one of the colors you
  49. have guessed matches one of the Amiga's, more than that, it says that
  50. the column of this color is the same as that of the Amiga's. Neither
  51. white nor black circles don't say to which of your guessed colors they
  52. belong. Also if a black circle appears for one of your guessed colors,
  53. then no white circle will be shown for it.
  54.  
  55.  You use these information to help a better guess in the next row, until
  56. you either find the correct colors and their order, or you lose.
  57.  
  58.  No timer is provided for this version so you can think as long as you 
  59. want.
  60.  
  61.  Note that in this progam the Amiga does not choose duplicate colors. This 
  62. simplifies the game.
  63. -----------------------------------------------------------------------------
  64.    
  65.  This Implementation:
  66.  
  67.  You can change many properties of the game including Board dimension 
  68. and the number of colors to guess among.
  69.  
  70.  The board can be as small as having just one column and one row.
  71. Maximum number of rows and columns depends on the Amiga the program is 
  72. running on. See 'What You Get...' for more information.
  73.  
  74.  If number of rows exceeds 11 in PAL (8 in NTSC) the screen is changed into
  75. an interlaced one. (unless you have OS2.0 or newer and suppress this with
  76. 'NOINTERLACE' in tool types or 'e' in command line).
  77.  
  78.  The default configuration has 10 rows for PAL (8 for NTSC), 4 columns
  79. and 6 colors to choose among. To configure the board, click on the
  80. 'Configure' gadget. three string gadgets appear, into which you can enter 
  81. number of rows, columns and number of colors to choose among. When done,
  82. click on the 'Done!' gadget. Note than selecting a large screen in an
  83. Amiga with little chip memory may lead to program termination, so consider
  84. the amount of your chip RAM when configuring.
  85.  program compute the permutation of total colors and number of columns. row
  86. number should be less than this.
  87.  Any configuration not appropriate from the program's point of view is 
  88. changed to defualt values.
  89.  
  90.  To start playing, you should fill the first row, that is the lowest row
  91. in the board. fill the row with colors. When done, click on the '<- Done'
  92. gadget. You should not choose duplicate colors and all the row should be
  93. filled. Considering these are done, the program shows you white and black
  94. circles as appropriate and you can begin filling the next row up.
  95.  
  96.  The game starts officially when you click '<- Done' the first time. After
  97. that 'Quit Game' and 'Configure' gadgets become disabled, and 'Cheat!' and
  98. 'Abort!' are enabled.
  99.  
  100.  If you are filling the top rows of the board, you may want to click the
  101. right mouse button. This opens a window near the mouse pointer with the 
  102. color gadgets. You can drag this any where you like. Clicking right mouse
  103. button another time, puts the color gadgets to their original place. 
  104.      
  105.  Another option is cheating, if you click on the 'Cheat!' gadget, one of the
  106. colors the Amiga has chosen is shown, but not its position.
  107.  
  108.  After the game has begun, you can terminate the current play by clicking
  109. on the 'Abort!' gadget. After this, a window opens showing the correct 
  110. settings and you should close it to continue.
  111.  
  112.  You lose a game when you fail to find the colors and their order in the
  113. last row. In this case also, the window with correct color and order is
  114. showed, which you should close before continuing.
  115.  
  116.  If you win, you should click on the 'OK' gadget to continue.
  117.  
  118.  Some text appears in the upper right corner of the screen. This may be
  119. considered as help. Error texts are in red and accompanied by a screen beep.
  120.   
  121.    
  122.  What You Get If You Have...
  123.  
  124. OS1.2 or OS1.3:
  125.  In this case you have the basic game. You can choose among at most 12
  126. colors. board dimentions can have up to 24 rows in PAL (18 rows in NTSC)
  127. and 9 columns.
  128.  
  129. OS2.0:
  130.  You get a Public Screen with the name of MasterMind (if not suppressed
  131. with 'CUSTOMSCREEN' in tool types or 'm' in command line).
  132.  The board can have up to 99 rows and 12 columns. If the number of rows
  133. becomes more than 24 in PAL (18 in NTSC) or the number of columns becomes 
  134. greater than 9, an scrollable window is opened. This is reflected in the 
  135. screen name. You may not be able to use very large boards because of lack 
  136. of chip RAM.
  137.  
  138. OS2.0 and ECS:
  139.  Here the program tries to open a PAL screen on NTSC machines (if not
  140. suppressed with 'NOPAL' in tool types or 'n' in command line).
  141.  
  142. OS3.0:
  143.  Nothing that the user can see, but OS3.0 graphics routines are used in 
  144. this case. As I don't have access to 3.0 includes, few 3.0-specific
  145. features could be used.
  146.  
  147.  
  148.  ARGUMENTS:
  149.  To change configuration before starting the program, you may use command
  150. line arguments (if started from CLI) or tool type arguments (if started
  151. from WorkBench). To change the tool types, you should use 'Information'
  152. or 'Info' from WorkBench menus on the icon of the program. 
  153.  In Shell, type 'MasterMind ?' for a brief explanation of command line
  154. arguments. In Workbench, all the arguments are present in the program
  155. icon, but either set to default values or disabled by appending a ';' to
  156. them (like ';CUSTOMSCREEM').
  157.  
  158.  To change board columns:
  159.   In CLI:       Enter: 'g' or 'G' followed immidiately with the number you
  160.                  want. Example: g5.
  161.   In WorkBench: Type 'GUESS' and the number you like in tool types.
  162.                  Example: GUESS=6.
  163.   Default:      4.
  164.   Minimum:      1.
  165.   Maximum:      Machine dependent (9 or 12).      
  166.  
  167.  To change board rows:
  168.   In CLI:        Enter 't' or 'T' fllowed immidiately with the number you
  169.                   want. Example: T80. 
  170.   In WorkBench:  Type 'TRIES' and the number you like in tool types.
  171.                   Example: TRIES=12.
  172.   Default:       10 for PAL, 8 for NTSC.
  173.   Minumum:       1.
  174.   Maximum:       Machine dependent (24/18 or 99).
  175.  
  176.  To change number of colors to choose among:
  177.   In CLI:        Enter 'c' or 'C' followes immidiately with the number you
  178.                   want. Example: c12.
  179.   In WorkBench:  Type 'COLORS' and the number you like in tool types.
  180.                   Example: COLORS=3.
  181.   Default:       6.
  182.   Minimum:       2.
  183.   maximun:       12.
  184.  
  185.  To prevent opening a public screen:
  186.  (Ignored under 1.2 and 1.3)
  187.   In CLI:        Enter 'm' or 'M'.
  188.   In WorkBench:  Type 'CUSTOMSCREEN' in tool types.
  189.   Default:       Opens a public screen.
  190.  
  191.  To prevent the programm from opening an interlaced screen:
  192.  (Ignored under 1.2 and 1.3)
  193.   In CLI:        Enter 'e' or 'E'.
  194.   In WorkBench:  Type 'NOINTERLACE' in tool types.
  195.   Default:       Uses interlace screen.
  196.  
  197.  To prevent the program from opening a PAL screen in NTSC machines:
  198.  (Ignored under 1.2 and 1.3)
  199.   In CLI:        Enter 'n' or 'N'.
  200.   In WorkBench:  Type 'NOPAL' in tool types.
  201.   Default:       tries to opens a PAL screen.
  202. -----------------------------------------------------------------------------
  203.  
  204.  
  205.  My Address:
  206.  
  207.  You can reach me at the following addresses:
  208.  
  209.  Mail (More Reliable):
  210.  
  211.         Kamran Karimi
  212.         89-Nastaran/Ghandehari
  213.         Khosh Shomali str.
  214.         14578 - Tehran
  215.         Iran
  216.  
  217.  
  218. Internet: karimik@sun.iust.ac.ir
  219.  
  220.