home *** CD-ROM | disk | FTP | other *** search
/ M.u.C.S. Disc 2000 / MUCS2000.iso / spiele / yukon / english / yukoneng.txt < prev   
Text File  |  1996-01-23  |  20KB  |  598 lines

  1.                            Documentation to
  2.  
  3.                                 Yukon
  4.  
  5.                                 Rel. F
  6.                               8/15/1996
  7.  
  8.                                   by
  9.  
  10.                               Dirk Haun
  11.                              Europastr. 8
  12.                            D-64569 Nauheim
  13.  
  14.                         dirk_haun@wi2.maus.de
  15.  
  16.  
  17.  
  18. Contents
  19. ========
  20.  
  21.  1  Introduction
  22.     1.1  Compatibility
  23.  
  24.  2  How to play Yukon
  25.     2.1  Goal of the Game
  26.     2.2  Game Variations
  27.     2.3  The Play Area
  28.     2.4  The Game Rules
  29.     2.5  The Point System (Casino Style)
  30.     2.6  High Scores and Best Times
  31.  
  32.  3  Usage
  33.     3.1  The Popup Menu and the Menu list
  34.     3.2  Keyboard
  35.  
  36.  4  The YUKONDAT folder
  37.     4.1  The Cards
  38.     4.2  The Sounds
  39.     4.3  The Resource
  40.  
  41. Appendix
  42. ========
  43.  
  44.  A  The YTool Program
  45.  
  46.  B  CrazySounds
  47.  
  48.  C  Tips and Hints and other notes
  49.  
  50.  D  Thanks to ...
  51.  
  52.  E  Copying
  53.  
  54.  F  Fairware
  55.  
  56.  
  57.  
  58. 1  Introduction
  59. ***************
  60.  
  61. Caution, play this game at your own peril! This game can consume large
  62. amounts of time that could be better spent on something more
  63. productive. Eventually after every failed round, you will want to
  64. throw your mouse into the corner. But then say "Oh well, ONE more
  65. game..." Don't tell me, I have warned you.
  66.  
  67.  
  68. 1.1  Compatibility
  69. ==================
  70.  
  71. Yukon runs on all Ataris with all TOS versions (and therefore all
  72. compatible systems). The resolution must be at least 640 x 400 to use
  73. card set that comes in the archive. If you want to run it in a lower
  74. resolution you need to create a smaller card set. If you run Yukon in
  75. a resolution with less than four colors, it will run in monochrome.
  76.  
  77.  
  78.  
  79. 2  How to play Yukon
  80. ********************
  81.  
  82.  
  83. 2.1  Goal of the Game
  84. =====================
  85.  
  86. The goal of the game is this, you must take the stacks of shuffled
  87. cards and sort and stack them by suit and in value order (Ace, 2, 3,
  88. ..., Queen, King).
  89.  
  90.  
  91. 2.2  Game Variations
  92. ====================
  93.  
  94. Yukon has three game variations. In order these are
  95.  
  96.  Classic:  Only kings can be placed on an empty field.
  97.  
  98.  Medium:   Any card can be placed on an empty field.
  99.  
  100.  Light:    Same as Classic, except that when you have gone through the
  101.            deck you can click on the empty frame at the bottom and go
  102.            through the deck again.
  103.  
  104.            Nothing comes without a price though this costs you $5.
  105.  
  106. These supposedly insignificant differences make for three versions of
  107. one strategy. But these three differences also make varying levels of
  108. difficulty.
  109.  
  110.  
  111. 2.3  The Play Area
  112. ==================
  113.  
  114. On the play area there are 13 stacks, on these when you begin, you
  115. will find some, a lot or no cards. The first card on the seven stacks
  116. on the right will be up, and all the cards on the stack on the far
  117. left will be over. You want to put the cards onto the four suit
  118. stacks, that you see vertically between the stack on the far left and
  119. the stacks on the right. The last stack on the left of course is the
  120. remainder of the deck of cards.
  121.  
  122.  
  123. 2.4  The Game Rules
  124. ===================
  125.  
  126. The face up cards on the seven stacks on the right can be moved and
  127. stacked on each other. Click and hold the left mouse button on the
  128. card(s) you want to move, then move the mouse cursor to the new
  129. location for the cards and let go of the button. You must always
  130. alternate the colors, a red (Heart, Diamond) on a black (Club, Spade)
  131. card as you lay them. You can lay more cards on the stack switching
  132. colors and decending in numbers as you go all the way down to Ace if
  133. you want.
  134.  
  135. If you want to place a card (on one of the four suit stacks on the
  136. left), all you need to do it give it one quick click. You can also
  137. place the card on the correct stack yourself. But once you place a
  138. card on one of the suit stacks it is out of the game, it can not be
  139. moved again.
  140.  
  141. If you move the last face up card off of a stack, then the next face
  142. down card on that stack (if there is one) will be turned face up. If
  143. there are no move cards on a stack then you will have an empty stack,
  144. and depending upon your game variant (more on this later), you will be
  145. able to move another card(s) here (i.e. a solitary card or a stack
  146. with a king on the bottom) or any card you want. Different is the
  147. variation "Classic", in which only a king may be moved onto empty
  148. stacks.
  149.  
  150. When you have no more moves with the starting cards, you can bring a
  151. new card into the game, by clicking on the stack on the far left. The
  152. topmost card will be turned over and placed on top of the stack on the
  153. far left top. If you can't use this card, you can repeat the process.
  154. A stack may form here, and you will always be able to move the top
  155. card on this stack, if of course you have some place to put it.
  156.  
  157. The end of the game is recognized automatically by Yukon. If you can't
  158. finish the game, Yukon will then display an alert "No more moves". But
  159. if you uncover all the cards so that the game can be finished, then
  160. Yukon will automatically move all the cards to the appropriate of the
  161. four suit stacks on the left. So long as Yukon doesn't show any
  162. reaction then you still have moves you can make. (these moves may only
  163. be cosmetic in appearance though).
  164.  
  165. Please think: That the automatic clearing of the table avoids the
  166. annoying and tedious moving of all the cards at the end of the game.
  167. If at the end of the game you do not notice this action, then there
  168. are some cards that you must move, or the routine will not work (one
  169. could equally write a routine, so that Yukon could play alone ...).
  170.  
  171. An example of a situation where the automatic clearing of the table
  172. doesn't start: When you have in the game variation "Classic" in the
  173. right side of the play area all of the cards face up and you only have
  174. three kings on this side and now on the left side the last card on the
  175. stack (deck) is uncovered, so the clearing of the table will not
  176. begin. Reason: The four kings must be located face up and must be on
  177. the bottom of a stack on the right side of the play area. When you
  178. have done this, then the automatic clearing of the table should start.
  179. (unless, you find the rest of the cards on the left hand stacks, you
  180. might have to move some cards off of the deck stack before the
  181. clearing will begin).
  182.  
  183.  
  184. 2.5  The Point System (Casino Style)
  185. ====================================
  186.  
  187. You start the race in this game with empty pockets and go from there
  188. to 52 dollars into debt (one dollar for every card). For every card
  189. that you get on the four suit stacks on the left, it will give you
  190. five dollars back. Theoretically you can even make a profit ...
  191.  
  192. When you begin a new round, you must buy a new deck of cards. This
  193. will cost you 52 dollars.
  194.  
  195. To undo a move costs three dollars and to go through the deck again
  196. (in the variation "Light") costs five dollars.
  197.  
  198.  
  199. 2.6  High Scores and Best Times
  200. ===============================
  201.  
  202. A high score or best time is always only written when you win a game.
  203.  
  204. When you have won a game and have a high score, you will be given the
  205. choice to either save the high score or to continue playing with your
  206. current points. Unless of course if you are playing the timed game
  207. where each game is a new one. If you save your score in the point
  208. game, then after the save, your points will be set back to zero (and
  209. thus -52). Only 5 high scores and best times are kept for each
  210. variation, so each time you get a new high score an old one will be
  211. destroyed.
  212.  
  213.  
  214.  
  215. 3  Usage
  216. ********
  217.  
  218.  
  219. 3.1  The Popup Menu and the Menu list
  220. =====================================
  221.  
  222. With one click of the right mouse button (in an empty area in the
  223. window) you can display the popup menu. Then you can select any of the
  224. following items:
  225.  
  226.   About Yukon
  227.      Gives a short description of Yukon.
  228.  
  229.   Game Variation
  230.      Here you can switch between the three game variations. You will
  231.      then see an alert with three buttons "Classic", "Medium" and
  232.      "Light". The current variation is the `default' button and is
  233.      also in the title bar of the window.
  234.  
  235.      If you have already moved some cards or played a game in a
  236.      different variation, the game will completely restart and your
  237.      points will be set back to -52 dollars. If you click on the
  238.      current game variant again, Yukon will continue without changing
  239.      anything.
  240.  
  241.   Timed Game
  242.      When you select this item, you turn the timed game on (or off).
  243.      The time will be shown on the left (where the points are normally
  244.      displayed). The time will begin at 0:00 and continue to count up
  245.      until you have either finished or lost the game. There are no
  246.      points in the timed game.
  247.  
  248.   High Scores or Best Times
  249.      With this you will see the five top scores or best times for the
  250.      current game variation.
  251.  
  252.   Undo Move
  253.      With the Undo key or this menu selection you can go back one (1)
  254.      move. This will cost you three (3) dollars.
  255.  
  256.   New Start
  257.      With this you restart the game completely. Any points you have
  258.      will be set back to zero (and from there to -52).
  259.  
  260.   Quit
  261.      This is how you quit the game.
  262.  
  263. The menu bar has the following additional items:
  264.  
  265.   New Game
  266.      With this menu selection you start a new round.
  267.  
  268.   Load Cards
  269.      Here you can load another set of cards.
  270.  
  271.  
  272. 3.2  Keyboard
  273. =============
  274.  
  275. The most important functions can also be accessed from the keyboard.
  276. In the following list `^' represents the Control key. You of course
  277. need to press this with the other key to access the function.
  278.  
  279.     [Help]  Displays a small help file.
  280.     [Undo]  Undo a move.
  281.     [Space] Uncover a new card off the pile.
  282.     ^Space  Pause (window will be minimized, halts a timed game)
  283.      ^N     Start a new game
  284.      ^R     Restart (new game with your points set back)
  285.      ^Q     Quit program
  286.      ^V     Change game variation
  287.      ^Z     Timed game on or off
  288.      ^H     Show high scores or best times
  289.      ^L     Load a new deck of cards
  290.  
  291. You can change these shortcuts (apart from the Help and Space
  292. shortcuts) by changing the YUKON.RSC file.
  293.  
  294.  
  295.  
  296. 4  The YUKONDAT folder
  297. **********************
  298.  
  299. In the folder named YUKONDAT Yukon is looking for the following files:
  300.  
  301. The YUKONDAT folder has to be in the same directory as YUKON.PRG. If
  302. you want to place it somewhere else you can define an environment
  303. variable $YUKONDAT pointing to that directory.
  304.  
  305.  
  306. 4.1  The Cards
  307. ==============
  308.  
  309. In the folder YUKONDAT, you will find several sets of cards for
  310. several resolutions. Yukon will look in the files in this folder with
  311. the file mask *.IMG, it will then choose the best cards for the actual
  312. resolution. That will happen by the motto "biggest possible, the most
  313. colors possible". If Yukon doesn't find appropriate cards for the
  314. actual resolution, it will refuse to run with an appropriate message.
  315.  
  316. If you want to install your own set of cards for Yukon, there is
  317. nothing standing in your way. You must make a file including the 15
  318. cards in four suits, also including a background for the play field
  319. and seven backsides (which will be cycled through during play) that is
  320. one large (X)IMG. Please notice that the card data must be a graphics
  321. file in IMG- or XIMG-format with a maximum of eight bit planes. I have
  322. created a tool to do this all for you, it is called YTool, it will
  323. combine all the seperate image files into one file (you will have one
  324. image for each of the cards, the background and back sides).
  325.  
  326.  
  327. 4.2  The Sounds
  328. ===============
  329.  
  330. In certain game situations you can be alerted with background sound.
  331. Yukon can play these sounds when you have one of the following:
  332.  
  333.    ∙ a computer which has DMA sound hardware (STe or Mega STe, TT,
  334.      Falcon)
  335.  
  336.    ∙ the program "MacSound" (comes with MagiCMac)
  337.  
  338.    ∙ the program "Petra"
  339.  
  340. The sounds must be in HSN-format (created by the program CrazySounds),
  341. they must be in the YUKONDAT folder and must have the following names:
  342.  
  343.  START.HSN    played when you start Yukon (only once)
  344.  
  345.  INTRO.HSN    played when you start or restart a game
  346.  
  347.  SCHADE.HSN   played when your game doesn't go well
  348.  
  349.  JUBEL1.HSN   played when you win a game, but your score or time
  350.               doesn't make it onto the `best' list. (high score or
  351.               best time)
  352.  
  353.  JUBEL2.HSN   played when you win a game and you do make it onto one
  354.               of the `best' lists.
  355.  
  356.  BELL.HSN     played when you try an illegal or impossible move
  357.  
  358.  UNDO.HSN     played when you undo your last move
  359.  
  360.  NEWCARD.HSN  played when you bring in a new card into the game by
  361.               clicking on the stack in the lower left corner
  362.  
  363.  DROP.HSN     played when you place a card on one of the four suit
  364.               stacks
  365.  
  366.  MOVE.HSN     played when you move a card or a stack of cards from one
  367.               stack to another
  368.  
  369.  QUIT.HSN     played when you want to quit Yukon
  370.  
  371. You can use all of these files, some of them or none of them, Yukon
  372. doesn't care. That means if you don't want an Intro sound, then leave
  373. the appropriate file out of the YUKONDAT folder or rename it.
  374.  
  375. Translation: "schade" means "pity" in German, "Jubel" means
  376. "applause".
  377.  
  378.  
  379. 4.3  The Resource
  380. =================
  381.  
  382. Yukon has a built-in German resource. On startup, Yukon looks for a
  383. file called YUKON.RSC in its YUKONDAT folder. If it's there, it will
  384. be used instead of the built-in resource.
  385.  
  386. Yukon comes with an English resource (the file YUKON.RSC in the folder
  387. ENGLISH). Just copy it to your YUKONDAT folder before you start Yukon.
  388.  
  389. The file can be easily modified using any common resource construction
  390. program. It should be obvious how to translate this file to another
  391. language.
  392.  
  393.  
  394.  
  395.  
  396. A  The YTool Program
  397. ********************
  398.  
  399. What it's for
  400.  
  401. With YTool you can make all of the image files (the cards for Yukon),
  402. into one file CARDS.IMG. So, with this you can make individual cards
  403. and then use this tool to turn them into one large image file, that
  404. Yukon (as of Rel. E) will accept as a card file.
  405.  
  406.  
  407. Usage
  408.  
  409. At the start of Ytool, you will be asked to select a path ("Quellpfad"
  410. meaning "source path" in German). This is the path in which all of the
  411. cards in image format are located. The cards must have the following
  412. names. [Yes in german, I can't help that!]
  413.  
  414.    ∙ Herz (Hearts):
  415.  
  416.        herzas.img, herz2.img, herz3.img, herz4.img, herz5.img, herz6.img,
  417.        herz7.img, herz8.img, herz9.img, herz10.img,
  418.        herzbube.img, herzdame.img, herzking.img,
  419.  
  420.    ∙ Karo (Diamonds):
  421.  
  422.        karoas.img, karo2.img, karo3.img, karo4.img, karo5.img, karo6.img,
  423.        karo7.img, karo8.img, karo9.img, karo10.img,
  424.        karobube.img, karodame.img, karoking.img,
  425.  
  426.    ∙ Kreuz (Clubs):
  427.  
  428.        kreuzas.img, kreuz2.img, kreuz3.img, kreuz4.img, kreuz5.img,
  429.        kreuz6.img, kreuz7.img, kreuz8.img, kreuz9.img, kreuz10.img,
  430.        kreubube.img, kreudame.img, kreuking.img,
  431.  
  432.    ∙ Pik (Spade):
  433.  
  434.        pikas.img, pik2.img, pik3.img, pik4.img, pik5.img, pik6.img,
  435.        pik7.img, pik8.img, pik9.img, pik10.img,
  436.        pikbube.img, pikdame.img, pikking.img,
  437.  
  438.    ∙ Background of the play area - tabletop pattern:
  439.  
  440.        leer.img
  441.  
  442.    ∙ Back sides of the cards:
  443.  
  444.        rueck1.img, rueck2.img, rueck3.img, rueck4.img, rueck5.img,
  445.        rueck6.img, rueck7.img
  446.  
  447. The cards for a suit (Herz, Karo, Kreuz, Pik) can also be saved in a
  448. single file. If you do it this way, then the cards must be in a single
  449. row, and in order (Ace, 1, 2, ..., King). It also must be saved under
  450. the name of the suit in German (e.g. herz.img).
  451.  
  452. The seven backsides will be cycled through during the play, so for the
  453. first game rueck1.img will be used.
  454.  
  455. The IMG files can have between 1 and 8 planes (as many colors as you
  456. wish), YTool will then attempt to make an IMG file with the
  457. probability of producing at least this many planes.
  458.  
  459. The IMG file that is produced is not specially packed and could be
  460. resaved with a program, which has the ability to save packed IMG files
  461. (e.g. Look'n See or GEM-View).
  462.  
  463. Once YTool has read all of the card image files, it will ask you for a
  464. name to save it out as. (e.g. cards.img).
  465.  
  466.  
  467. Translation: "As" is the German word for "ace", "Bube" means "knight",
  468. "Dame" means "queen", "leer" means "empty" and "Rueckseite" means
  469. "back side".
  470.  
  471.  
  472.  
  473. B  CrazySounds
  474. **************
  475.  
  476. The samples Yukon can play are in a format used by the popular German
  477. program "CrazySounds". The format is fairly straightforward: It has a
  478. header of 90 bytes followed by the sound data.
  479.  
  480.     typedef struct
  481.     {
  482.       char    id[20];     /* 'HSND1.1' */
  483.       long    length;     /* length of sound data */
  484.       int     frequency;  /* frequency, see below */
  485.       int     stereo;     /* 1=stereo, 0=mono */
  486.       char    res[20];    /* not of interest here */
  487.       char    info[41];   /* comment */
  488.     } HSN_HEAD;
  489.  
  490. The `frequency' field holds the sample's frequency divided by 10. It
  491. should be any of the following values: 625, 1250, 2500, or 5000. It is
  492. recommended to use `1250' as this can be played on most computers
  493. (since the Falcon can't play 6250 Hz samples, old STs can't play
  494. higher frequencies, etc.).
  495.  
  496.  
  497.  
  498. C  Tips and Hints and other notes
  499. *********************************
  500.  
  501.    ∙ Yukon remembers to the game variation, the last variation you
  502.      play will be the one you start with the next time you play Yukon.
  503.  
  504.    ∙ If when you are playing a timed game, you need to take a break,
  505.      then you can stop the clock by "iconify"ing the window. You can
  506.      do this by either pressing the Alternate key and clicking on the
  507.      window closer or by pressing the Control key and the Space bar.
  508.      If you are sucessful with this the game window will now be
  509.      minimized (it will appear as an icon with the title Yukon). When
  510.      you are ready to resume playing you can either press Control -
  511.      Space again or double click on the icon. This will bring the
  512.      window back.
  513.  
  514.    ∙ Yukon looks for its YUKONDAT folder in the same path where
  515.      YUKON.PRG itself is placed. If you don't like this you can define
  516.      an environment variable YUKONDAT and set it to the folder which
  517.      Yukon should use instead.
  518.  
  519.  
  520.  
  521. D  Thanks to ...
  522. ****************
  523.  
  524. I would like to thank the following people:
  525.  
  526.    ∙ all my beta-testers,
  527.  
  528.    ∙ Marianne C. Herdt for the new cards,
  529.  
  530.    ∙ Dan Ackerman for translating Rel. E,
  531.  
  532.    ∙ ... and, of course, all those nice people who have donated money
  533.      for Yukon.
  534.  
  535. Dirk Haun, August 15, 1996
  536.  
  537.  
  538.  
  539. E  Copying
  540. **********
  541.  
  542. You may copy Yukon freely as long as you stick to the following
  543. conditions:
  544.  
  545.    ∙ You are not allowed to sell Yukon.
  546.  
  547.    ∙ You may only charge costs for disks, postage, etc. at the normal
  548.      rates.
  549.  
  550.    ∙ Yukon may not be included on cover disks (or other media
  551.      connected with computer magazines).
  552.  
  553.    ∙ You should not alter the archive, if possible. You are not
  554.      allowed to remove any files from the archive (if not for legal
  555.      reasons). You are permitted to add files containing documentation
  556.      or resources for other languages, new sets of cards or samples.
  557.      You are not allowed to add bbs-banners or other forms of
  558.      advertising.
  559.  
  560.    ∙ You are not allowed to change the program YUKON.PRG and the
  561.      german documentation (YUKON.TXT and YUKON.HYP/.REF).
  562.  
  563. You may ask the author for exceptions of these restrictions.
  564.  
  565. If you as a user of Yukon find any violation against the above
  566. conditions, please inform me about it. Thank you.
  567.  
  568.  
  569.  
  570. F  Fairware
  571. ***********
  572.  
  573. Yukon is fairware. That means you are asked for a donation but you can
  574. decide yourself how much you will send me. If you understand the
  575. concept of fairware, then please send your donation for Yukon to
  576.  
  577.     Dirk Haun
  578.     Europastr. 8
  579.     D-64569 Nauheim
  580.     Germany
  581.  
  582. or you can transfer your donation directly to my bank
  583.  
  584.     Account number 8042947
  585.     Kreissparkasse Gross-Gerau
  586.     Bank code number 50852553
  587.  
  588. If you have any questions or comments about Yukon, write me at my home
  589. address or send me e-mail at
  590.  
  591.     Dirk Haun @ WI2   or   dirk_haun@wi2.maus.de
  592.  
  593. on MausNet (please only mail < 16 KByte!!!).
  594.  
  595.  
  596.  
  597.  
  598.