home *** CD-ROM | disk | FTP | other *** search
/ Aztec Shareware Collection / AZ_096.ISO / ginrum / ginrummy.doc < prev    next >
Text File  |  1993-06-25  |  24KB  |  526 lines

  1. =======================
  2.  
  3.        GinRummy
  4.  
  5.          from
  6.  
  7.   Universal Software
  8.  
  9. -----------------------
  10.  
  11. Copyright (c) 1991,1993
  12.  
  13.     David A. Teach
  14.  
  15. -----------------------
  16.  
  17.      Version 4.2
  18.  
  19. =======================
  20.  
  21.  
  22. Requirements / Recommendations to play
  23. ======================================
  24.  
  25. EGA, VGA, MDA, AT&T 400, PC 3270, or Hercules graphics system required.
  26.  
  27. A Microsoft, Logitech, or compatible mouse is recommended.
  28. Three button rodents work better for the hint feature.
  29.  
  30. An IBM or compatible AT computer with 8 mHz or faster CPU speed is
  31. also recommended.
  32.  
  33.  
  34. How to play this computer game
  35. ==============================
  36.   When using the mouse, commands are selected with either the Left or
  37. Right mouse buttons.  When in keyboard mode, the numbers or letters for
  38. the commands are highlighted in light green.  For 2 color systems, the
  39. active keys have a line drawn under them.
  40.  
  41. ***** Note *****
  42. The keyboard commands are only possible if a mouse is not detected, or
  43. if you are in forced keyboard mode; otherwise, the mouse is the default
  44. selecting device.
  45.  
  46. ***** Hercules graphics users: The mouse pointer doesn't seem to work
  47. when I simulate Herc. graphics on my VGA card, but it might work on a
  48. real Hercules graphics machine.  If not, disable the mouse or use the
  49. KEYBOARD option.
  50.  
  51.  
  52. The Title Screen:
  53.  
  54. BEGIN GAME -
  55.    Typing 'B' or clicking the left or right mouse button on the BEGIN
  56. GAME box starts the game with the shown options.  Hitting ENTER will
  57. also choose this.
  58.  
  59. OPTIONS -
  60.    Typing 'O' or clicking on OPTIONS will bring up the game Options
  61. Menu.  (see below)
  62.  
  63. HIGH SCORES -
  64.    This displays the top 20 high scores list.
  65.  
  66. STATISTICS -
  67.    This displays the current player's cumulative game statistics.
  68.  
  69. QUIT -
  70.    QUIT will exit the program.
  71.  
  72.  
  73. The Options Menu:
  74.  
  75. MAIN MENU -
  76.    This option will bring you back to the main menu. (Title screen)
  77. You can hit either the letter M or the ENTER key to select this in
  78. keyboard mode.
  79.  
  80. NAME -
  81.    The default name is 'PLAYER'.  You can change this by typing 'N' 
  82. or clicking the mouse pointer within the red box around the name, typing
  83. a new name, and pressing ENTER (or a mouse button).  Backspace is the
  84. only editing key allowed if you make an error while typing in the name.
  85. Upper and lower case letters, numbers 1 through 9, characters ! . , " -
  86. : / ?, and spaces are also allowed.  The name can be a maximum of 8
  87. characters long.
  88.  
  89. GIN SCORE -
  90.   This is the amount of points that a player scores when he win a hand
  91. with a GIN.  Usually this is 25 points but some people use 20 points.
  92. The 'G' key toggles this option between the two.
  93.  
  94. UNDERCUT -
  95.   This is the amount of points that a player scores when he undercuts
  96. the other player's knock.  Usually this is 25 points but some people
  97. use 10 points.  The 'U' key toggles this option between the two.
  98.  
  99. SCORE LIMIT -
  100.    Clicking on SCORE LIMIT cycles the maximum score to play to by 50
  101. points, from 0 to 500.  The RIGHT mouse button, or '+' INCREASES the 
  102. score by 50; and the LEFT mouse button, or '-' DECREASES the score.
  103.  
  104. OKLAHOMA -
  105.    Changing the OKLAHOMA option to YES will play the game by Oklahoma
  106. rules. (see rules below)  The double points on a spade as first upcard
  107. is still in effect even if knocking is disabled.  The 'O' key toggles.
  108.  
  109. BIG CARDS -
  110.    The default card set has more realistic-looking cards, but the suits
  111. may be a little small for some people to see clearly.  If this is so,
  112. or you just like the one pip better, changing this option to YES will
  113. give you cards with one big number and one big symbol for the suit.
  114. Hit the letter 'B' to switch this option to YES or NO.
  115.  
  116. EASY GAME -
  117.    If the computer consistantly pounds on you, toggle EASY to YES.  This
  118. will make the computer always pick the largest value unused card in its
  119. hand for discarding instead of following its better choosing formulas.
  120. The 'E' key selects this option from keyboard.
  121.  
  122. KNOCKING -
  123.    If this option is YES, you are allowed to knock if possible. (See
  124. knock rules below)  Otherwise you must GIN to win a hand.  If knocking
  125. is disabled, a zero will be drawn for the knock card value instead of
  126. the normal knock value.  Type 'K' to toggle knocking on or off.
  127.  
  128. POINTER -
  129.    Clicking on this option will change the shape of the mouse pointer. 
  130. There are seven different shapes to choose from.  Obviously, this will
  131. not have any effect if you are not using a mouse, but 'P' still works.
  132.  
  133. SORT BY -
  134.    'R' from Keyboard.  This toggles the sorting of cards in your hand: 
  135. RANK = Unmatched cards are arranged highest to lowest, regardless of
  136.    suit.  Cards of same value are then arranged by suit.
  137. SUIT = Unmatched cards are arranged highest to lowest within the four
  138.    possible suits.  Order: Spades, Hearts, Diamonds, Clubs. (Bridge)
  139.  
  140. SAVE -
  141.    Selecting SAVE will save all options to the GINRUMMY.CFG file.  This
  142. file is loaded when the program is run, so your name and favorite
  143. options are already set.  If this file is not present, or is corrupted,
  144. it will be created with the default options.  At present, the NOBLANK
  145. option is not saved in this configuration file.  'S' from the keyboard.
  146.  
  147.  
  148. Player Statistics Screen:
  149.    Clicking within the Main Menu box will bring you back to the main
  150. menu. (Title screen)  You can hit the letter M or the ENTER key to
  151. select this in keyboard mode.
  152.  
  153.  
  154. Game Play -
  155.    To start play, a player must draw a card from either the Deck or the
  156. Discard pile.  To do this, click the mouse pointer on the deck or on the
  157. discard pile on the playing screen, OR click on the words DECK or on
  158. DISCARD PILE in the red boxes at the bottom of the screen.  In keyboard
  159. mode, type the highlighted letters 'D' for DECK, or 'P' for DISCARD PILE
  160. to choose.
  161.    You then must choose a card to discard.  Click the mouse pointer on
  162. the card in your hand that you want to discard (the card you want to
  163. replace with your drawn card).  To do this in keyboard mode, the
  164. numbers 1 2 3 4 5 6 7 8 9 0 appear under your hand.  Choose the number
  165. under the card you want to discard, or you can discard the drawn card
  166. by clicking on the discard pile, on the words DRAWN CARD in the red box
  167. at the bottom of the screen, or type 'D' in keyboard mode.  If the
  168. drawn card is taken from the discard pile, you can undo the draw by
  169. clicking on the card drawn, or within box around UNDO, or by typing 'U'
  170. on the keyboard.  After you discard, the computer will draw and discard.
  171.  
  172.    Play continues until one of you gins, knocks, or draws the second to
  173. the last card in the deck.  You can also type 'Q' or click on the QUIT
  174. option in a red box at the bottom right of the screen to return, upon
  175. confirmation, to the title screen.  Double-clicking on the QUIT option
  176. will also send you to the title screen.
  177.    If after you discard, the total points remaining in your hand are
  178. equal to or less than the knock value, you will be asked if you want to
  179. knock.  Click on YES, or on the knock card to end the hand by knocking.
  180. Click on NO, or on the discard pile to continue the hand without yet
  181. knocking.  If you select the 'Play to Gin' box, you will play that hand
  182. until gin is reached by you, or until the computer gins or knocks.  You
  183. cannot knock again until the next hand, but the computer still can.
  184. Keyboard mode highlights the 'Y' and 'N' for choosing yes or no, or 'P'
  185. to play to gin.  If you have disabled knocking or have selected 'Play
  186. to Gin' earlier in the hand, this question will not appear.
  187.    After one of you wins a hand, scores are accumulated until reaching
  188. the limit set in the options menu, whereupon one of you wins the game. 
  189. You can then play again from zero, or quit to the main intro menu.
  190.  
  191.  
  192. The Color Bars -
  193.    To help you see how your cards are arranged, the computer will draw
  194. colored bars above your matched cards.  The computer sorts the cards
  195. in your hand into the arrangement that gives you the lowest deadwood
  196. score (or it tries to).  Above all cards in your hand that are matched
  197. into sets of 3 or 4 of a kind, a BLUE bar will be drawn.  Above the
  198. cards matched into a run will be drawn a GREEN bar. 
  199.    If the COMPUTER player draws from the discard pile instead of the
  200. deck, a RED bar will be put over the discard pile until the next turn. 
  201. This means that the computer took the card that you just discarded. 
  202. Since the computer goes so fast, this is done to simulate a more
  203. realistic play in which you can see from where your opponent draws.
  204.    Also, if a player Knocks, and the other player can lay off some
  205. deadwood on the knocking player, a RED bar will be drawn over (or
  206. under) all the laid off cards.
  207.    When you ask the computer to give you a hint on drawing a card or
  208. when choosing a discard, a YELLOW bar will be placed over the card 
  209. that he recommends for you to select.
  210.  
  211.  
  212. Hints -
  213.    The center button (recommended), or both left and right buttons 
  214. pressed simultaneously will ask the computer for a hint.  When using
  215. the keyboard, the letter H brings up the hint suggestion.
  216.  
  217. CAREFUL: if you are using both left and right mouse buttons to ask for
  218. hints, you must make sure that the mouse pointer is NOT OVER a regular
  219. choice area, (deck, card in hand, quit, etc.) or else the game will
  220. usually think that you made a normal choice with a single button.  If
  221. you have a center button, use that instead; this will work for hints
  222. ANYWHERE on the screen, even over normal choice areas.
  223.  
  224.    IF YOU HAVE A THREE BUTTON MOUSE, BUT THE CENTER BUTTON DOESN'T DO
  225. ANYTHING, you probably are using a different mouse driver than the one
  226. which came with your mouse.  A three button mouse MUST be driven by a
  227. three button mouse driver.  Most of the Microsoft mouse driver programs
  228. are for two button rodents.  They seem to work fine for all operations
  229. of the mouse except for the center button.  If you have a problem, look
  230. around the BBS's for a newer mouse driver, (I use Logitech mouse driver
  231. version 6.20) or contact the company where you purchased your mouse.
  232.  
  233.  
  234. The Screen Saver -
  235.    If no keyboard or mouse input is detected for a certain amount of
  236. time during the game, the screen will blank out to prevent burn-in.  The
  237. time limit for this is set by the game score limit.  The time of waiting
  238. is two second per score limit point; which means that a limit of 100 will
  239. blank the screen in 200 seconds (3 minutes, 20 seconds), and a limit of
  240. 600 points will wait 20 minutes (1200 seconds).  The minimum time is one
  241. minute, even if the score limit is set to zero.  If your favorite score
  242. limit does not match your wanted screen saver time, learn to live with a
  243. compromise.
  244.    To activate the screen blanker immediately, move the mouse cursor
  245. into the upper right hand corner and the screen will automatically blank
  246. out.  This can be handy for the traditional use of a "Boss key" function.
  247. In keyboard mode, the ESCAPE key is the activation key.
  248.  
  249. *** To get out of the blank screen, press any key or mouse button. ***
  250.  
  251. *** NOTE: NO SCREEN BLANKING WILL OCCUR IF THE NOBLANK OPTION IS ON.
  252. ALSO, SINGLE PAGE VIDEO CARDS (AT&T 400, PC3270, 64K EGA) CAN NOT
  253. SUPPORT THE SCREEN SAVER AT THIS TIME.  FOR THESE, THE NOBLANK OPTION
  254. IS HARDCODED AS 'TRUE' (ON).
  255.  
  256.  
  257. The Score file -
  258.    At the end of each game, the program checks for a score file called
  259. GINRUMMY.SCR in the current directory.  If it is not there, it is
  260. created.  This file saves your 20 best average scores (the final score
  261. divided by the number of hands played).  Also saved is your name (you
  262. must use the command line name option, or change the default player name
  263. if you don't want 'PLAYER' saved as your name), the final score, the
  264. score limit, the number of hands played, whether the Oklahoma option is
  265. on or off (Y or N), and the date the game was played.  Scores are not
  266. saved for the Computer player.  If your score file is corrupted, or you
  267. just want to clear the score list and start over, erase (or rename) the
  268. GINRUMMY.SCR file.  Zero average scores (lose or draw) are not saved.
  269.  
  270. ******* If you quit a hand before the END of the game, the score file
  271. WILL be updated for the hands that were played only if the score of the
  272. human player is greater than zero. 
  273.  
  274.  
  275. The Statistics file -
  276.    Also at the end of each game, the program checks for a stats file
  277. called GINRUMMY.STA in the current directory.  If it is not there, it 
  278. is created.  This file saves cumulative totals for average score per 
  279. hand against the computer, the total number of games won and lost, the
  280. total number of hands played and the player's name.  If your stats file
  281. is corrupted, or you just want to clear the list and start over, erase
  282. (or rename) the GINRUMMY.STA file.  You can have up to 20 different 
  283. names currently running in this stats file.  If the current player name
  284. is not found in this file, it is added to the top of the file with zero
  285. totals.  WARNING, if this addition makes more than 20 names, the name on
  286. the bottom of the list (the oldest) is truncated.  Hands played to a draw
  287. ARE counted in this.  Games played to a draw (only possible if zero
  288. score limit, or when quiting a game after one draw) are also counted.
  289.  
  290. ******* If you quit a hand before the END of the game, the stats file
  291. WILL be updated if there was at least one hand played to a finish.
  292.  
  293. ******* If you are playing GinRummy on a write-protected or read-only
  294. drive, the stats will start from zero when you start the game; they will
  295. be kept for when you are in the program, but cannot be saved upon exit.
  296.  
  297.  
  298. Notes on the Computer player -
  299.    The computer does NOT "cheat" when playing.  It does not look at the
  300. deck before choosing to draw, it does not look at your hand, or do any
  301. other thing that a human player cannot do.  The computer chooses its
  302. discard by a set of fixed formulas that do not have any room for human
  303. "intuition" or for many of the different possible arrangements of the
  304. hand that might make a good human player choose a different card than
  305. the computer.
  306.    The "Hint" function uses about the same formulas for choosing a
  307. player's selection that the computer uses for its moves.  This means if
  308. you depend too heavily on the hints, you will end up winning only about
  309. half of your games.  (During about 500 hands of play testing I have
  310. around a 59% winning percentage since keeping statistics.)
  311.  
  312.  
  313. Command Line Options:
  314.    The default setting for the two options NAME and SCORE LIMIT can be
  315. set from the command line, overriding (but not overwriting) the
  316. configuration file settings.  This can be handy to set up some batch
  317. files for different players on one machine.
  318.  
  319. At the DOS prompt, you can do the following:
  320.  
  321. To get a quick help screen for the command line options, type GINRUMMY 
  322. followed by /? or ? or help or HELP.  This must be the first parameter.
  323.  
  324. To list all of the contents of the statistics file from the DOS prompt,
  325. (in case you forget who is in there) type: GINRUMMY list
  326.  
  327. To set the SCORE LIMIT: GINRUMMY nnn   -- where "nnn" is a number
  328. from 000 to 999.  ex. GINRUMMY 234
  329.  
  330. For numbers less than 100, you MUST use leading zeros.  ex. 025
  331.  
  332. If the limit is 0, then exactly one hand will be played, even if it
  333. ends in a draw.
  334.  
  335. To have the game use your name instead of the default name, you can
  336. state it as a command line option.  ex. GINRUMMY Dave
  337.  
  338. For the Command line option of Player Name, the length limit is 8 
  339. characters and the name must be ONE word.  You can use BobSmith, or
  340. Ron_Hill, etc., but typing Paul Schoenberger will give you Schoenbe for
  341. your name.  If you want a space in your name, you can put one in only
  342. with the Name Change from the options menu.
  343.  
  344. The name used is the LAST word on the command line that is NOT otherwise
  345. recognized as a command, so be sure not to have any gibberish on the
  346. line when you start the game: GINRUMMY Mike ASDF  will make your name
  347. ASDF not Mike.
  348.  
  349. KEYBOARD 
  350. To force the game to play in keyboard mode when a mouse is detected, 
  351. use the command line option KEYBOARD to enable keyboard play.
  352.  
  353. Be careful of mixing keyboard and mouse play.  Since this game will
  354. automatically select keyboard mode if a mouse is not detected, this
  355. option should only be used if a mouse is falsely detected on your
  356. computer, or you can't turn off your mouse and you need to play using
  357. the keyboard.
  358.  
  359. NOBLANK
  360. To disable the screen saver function, use the word NOBLANK in your
  361. command line options.  This parameter will also disable the manual
  362. screen blanking (boss key), since both are really the same function.
  363.  
  364. LAPTOP
  365. If you have a monochrome monitor, like on most LCD laptop computers,
  366. the switch LAPTOP will use a brighter shade for some of the colors
  367. and for any highlighted letters to make them easier to see.  If a
  368. monochrome graphics card is detected by the game, this option will
  369. be used automatically, so this switch is only necessary when you have
  370. a monochrome monitor hooked up to a color graphics card.
  371.  
  372. GO
  373. To go directly into the game, bypassing the intro screen, use the
  374. command GO from the DOS prompt.  ex. GINRUMMY John B:\ go
  375.  
  376. If you want to have the configuration and save files read and saved
  377. from or to a different drive or directory, you may specify a file path
  378. on the command line.  Valid paths must start with a backslash (\)
  379. or a drive letter and colon (B:) or parent directory dots (..) 
  380. Valid path examples are:
  381.   GINRUMMY A:
  382.   GINRUMMY \GAMES\MYSAVE
  383.   GINRUMMY D:\WORK\
  384.   GINRUMMY \
  385.   GINRUMMY ..
  386.   GINRUMMY ..\STUFF
  387. If just the drive letter is given, then the current path is used on
  388. that drive. (meaning if you are in D:\GAMES and then change to drive C:
  389. and run "GINRUMMY D:" then your game files will be saved in D:\GAMES.
  390. As always, if a path not is specified, the current directory is used.
  391. If a path is given, it is tested at game startup, and if it is invalid
  392. for any reason, the current directory will be made the default path.
  393.  
  394. Since the game looks only at the first seven parameters, too much 
  395. garbage on the command line might miss a legitimate option:
  396. GINRUMMY 1 2 3 4 5 6 7 GO  will NOT execute the GO command.
  397.  
  398. These options can be put in any order and are all case INsensitive,
  399. except for the Player Name.
  400.  
  401.  
  402. Rules of the Game  -  Taken from "Official Rules of Card Games",
  403. =================     62nd edition, U.S Playing Card Company, 1968
  404.  
  405. Rank of cards:
  406.    (High) K, Q, J, 10, 9, 8, 7, 6, 5, 4, 3, 2, A.
  407.  
  408. Value of cards:
  409.    Face cards 10, Ace 1, other cards their pip value.
  410.  
  411. The Deal:
  412.    Each player is dealt 10 cards, the next card is turned face up,
  413. forming the discard pile.  The rest of the deck is placed beside it,
  414. face down.
  415.  
  416. Object of play:
  417.    To form MATCHED SETS, consisting of three or four of a kind, or
  418. sequences of three or more cards of the same consecutive rank in the
  419. same suit.
  420.  
  421. The Play:
  422.    The human player and the computer take turns by drawing a card from
  423. either the deck or the top of the discard pile, then choosing a card
  424. from their hand to discard.  In this game, you always go first.  Players
  425. alternate until:
  426.  
  427.    1) A player can GIN.
  428.    2) A player KNOCKS.
  429.    3) Only 2 cards are left in the deck.
  430.  
  431. A Draw:
  432.    If only two cards remain in the deck at the start of a turn, a player
  433. may choose a card from the discard pile and continue his turn; but if
  434. either player draws from the deck, the hand is a draw. No points are
  435. scored for a draw hand, but it counts as a game played.  The cards are 
  436. then re-shuffled and dealt again for a new hand.
  437.  
  438.    The number of cards remaining in the deck is shown as a small white 
  439. number on the top of the deck.  If the number or cards left is 7 or lower,
  440. the number on the deck will be red instead of white.
  441.  
  442. GIN:
  443.    If, after discarding, all of the remaining cards in the
  444. player's hand are formed into matched sets, the player has GIN.  This
  445. scores 25 points, plus the value of his opponent's unmatched cards
  446. (deadwood).
  447.  
  448. KNOCK:
  449.    A player can KNOCK if, after discarding, the total of his unmatched
  450. cards is 10 points or less.  He does not have to knock when able to do
  451. so.  After knocking, the hand is over, and both players count the points
  452. of their unmatched (deadwood) cards.  The other player (non-knocking)
  453. does not count the points of any deadwood card he can play on the
  454. knocking player's MATCHED SETS.  This is called LAYING OFF.  The knocking
  455. player CANNOT lay off any of his deadwood cards, and the player laying
  456. off CANNOT alter his or his opponent's matched sets in order to lay off
  457. more cards, or combine his and the other player's deadwood cards to form
  458. matched sets.  If, after laying off, the knocking player has FEWER
  459. points than his opponent, he scores the difference in points.  If the
  460. non-knocking player has LESS or SAME points than his opponent, he has
  461. UNDERCUT him and scores 25 points, plus the point difference in
  462. unmatched cards. 
  463.  
  464. (If you can't remember all this, don't worry; the computer does all the
  465. laying-off, counting, and rule enforcement for you.)
  466.  
  467. OKLAHOMA:
  468.    If the Oklahoma option is on, play is the same except that the value
  469. of the first card on the discard pile (the upcard), determines the knock
  470. value, whether it is taken or not.  That means, if the first upcard is a
  471. 5, then the players can only knock if they have 5 points or less in
  472. deadwood cards.  If an ACE is the first upcard, a player must GIN to win
  473. the hand.  If the first upcard is a SPADE, all points scored in that
  474. hand are DOUBLED.  To remind you if this, a RED box will be drawn around
  475. the knock card when the first upcard is a spade.
  476.  
  477. Winning:
  478.    Play continues until a player's accumulated score is greater or equal
  479. to the agreed scoring limit, usually 100.  You can then quit the game or
  480. play a new game from zero.
  481.  
  482. ======================================================================
  483. This SHAREWARE program is written in Turbo Pascal Version 6.0
  484.  
  485. The Mouse unit is from the book "Turbo Pascal Advanced Programmer's
  486. Guide" by Stephen K. O'Brian.  This unit was slightly modified by me.
  487.  
  488. Please feel free to call or write to me if you have any questions, 
  489. comments, improvements, or find any bugs.
  490.  
  491. If you like this program and want to support the efforts of a shareware 
  492. programmer, please send cash or check for any amount that you feel my
  493. GinRummy game is worth to you to:
  494.  
  495. David Teach
  496. 14304 46th Street #39
  497. Tampa, FL  33613
  498.  
  499. Phone: (813) 975-1099
  500. CompuServe ID: 70743,2753
  501.  
  502. If you send in the registration fee for GINRUMMY, I will mail to you my
  503. latest version and will also give you my other card game, CRIBBAGE.
  504.  
  505. =========================================================================
  506.  
  507. What is Shareware Software?
  508.  
  509. Shareware, or user-supported software, is a popular way of marketing
  510. software for the program's author.  Shareware software is copyrighted.
  511. The authors encourage you copy their software and share it with friends.
  512.  
  513. If you like the program and continue using it, you should send in the
  514. "registration fee".  This is a wonderful deal for the consumer.  If you
  515. try a program and don't like it, you owe the author nothing.
  516.  
  517. However, if you find you are using the program, then it is only right
  518. to pay the "registration fee" which usually ranges from $5.00 to $90.00
  519. depending on the program.  Please support these authors.  They have
  520. worked hard to give you their products and can only do so in the future
  521. if you encourage them.  Shareware software will then continue to flourish
  522. and everyone will benefit.  Where else can you "TRY BEFORE YOU BUY".
  523.  
  524. =========================================================================
  525.  
  526.