home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 7 Games / 07-Games.zip / YATZYNET.ZIP / YATZYUS.IPF < prev   
Text File  |  1991-02-08  |  21KB  |  421 lines

  1. :userdoc. 
  2. :h1 res=205.Extended help for Yatzee
  3. :i1 id=generel.Extended help for Yatzee
  4. This program is a computer-version of a game of dice called Yatzee.
  5. :p.To get an overview of the game and its possibilities, select 
  6. :hp1.Contents:ehp1. in the menu :hp1.Options:ehp1. in the action bar, or 
  7. press Ctrl+C.
  8. :p.To get an overview of the rules of Yatzee, choose
  9. :link reftype=hd res=1002.rules:elink..
  10. :h2.The game sheet
  11. :i2 refid=generel.Game sheet
  12. Each player gets his own :hp1.game sheet:ehp1., which not only shows the
  13. players dices and score, but also all the other players dices and score. 
  14. :p.The game sheet opens by starting the program YATZYNET.EXE. When this 
  15. program is executed, it is important, that current directory is the one where
  16. the system was installed. This is also true if you put the game in a 
  17. group-menu. Don't forget to mention the right directory in the 
  18. "Working directory" entryfield.
  19. :p.The game sheet is a vindow, that contains several child windows. Each of
  20. these child windows shows a participating players 
  21. :link reftype=hd res=1004.dices:elink. and
  22. :link reftype=fn refid=pointtavle.score-board:elink.. The child windows are
  23. self contained and can be freely manipulated, i.e. minimized. Except from 
  24. your own window, you are not allowed to use them for playing.
  25. :p.You play the game on your own child window, which as a default is placed
  26. to the left on the game sheet. Normally you will manipulate the dices with
  27. the mouse, but you can also use the keyboard. Take a look on the 
  28. :link reftype=hd res=206.Keys help:elink. for a description of the meaning
  29. of the keys. The description of how to select and deselect the dices and
  30. how you throw the dices is found in
  31. :link reftype=hd res=1004.dices:elink..
  32. :p.At the same time as you are playing, others can play too. There is no
  33. notion of your &odq.turn&cdq., unless the players all agree upon it.
  34. As soon as a player does something in his child window, this is immediately
  35. reflected on the other players game sheets. Everybody are therefore always
  36. informed of the progressing game.
  37. :p.It is not necessary, that all participants commence on the same time. A
  38. player is able to begin playing after some or all the others have finished.
  39. :p.The game is over when all the players has placed a score in all the 
  40. score categories. A new game can begin when the 
  41. :link reftype=hd res=1001.server-program:elink. has terminated and is 
  42. restarted.
  43. :h2.Playing on one computer
  44. :i2 refid=generel.Playing on one computer
  45. The game is aimed at one game sheet on each players computer, but it is 
  46. possible to create all game sheets on a single computer. If you do that,
  47. you must also execute the
  48. :link reftype=hd res=1001.server-program:elink. on this computer too, and 
  49. not on the 
  50. :link reftype=hd res=1003.LAN:elink.-server. Also, you should 
  51. :hp2.not:ehp2. enter a :link reftype=hd res=643.servername:elink. in the 
  52. dialogbox :hp1.Insert player:ehp1..
  53. :h2.Language support
  54. :i2 refid=generel.Language support
  55. Normally the program will start in the language that OS/2 has been told to 
  56. use for this computer. If the language is not supported, english is used.
  57. :p.You can ask the program to use another language than the default by 
  58. entering the country code when you start the program. For example will
  59. the following command make the program run in danish, even on an american
  60. computer:
  61. :xmp. 
  62. YATZYNET 45
  63. :exmp.
  64. :p.The different country codes normally equels the countrys international
  65. dial-numbers. Here are some examples:
  66. :dl tsize=16 compact.
  67. :dthd.Country
  68. :ddhd.Country code
  69. :dt.Belgium
  70. :dd.32 
  71. :dt.Denmark
  72. :dd.45 
  73. :dt.France  
  74. :dd.33
  75. :dt.Germany
  76. :dd.49 
  77. :dt.Italy
  78. :dd.39 
  79. :dt.Holland
  80. :dd.31 
  81. :dt.Norway
  82. :dd.47 
  83. :dt.Spain  
  84. :dd.34 
  85. :dt.Sweden
  86. :dd.46 
  87. :dt.Schwitzerland
  88. :dd.41 
  89. :edl.
  90. :note.Only english and danish are currently supported. If anybody wants to 
  91. translate it to other languages (or to correct my english), please contact me
  92. on the address mentioned in 
  93. :link reftype=hd res=1005.Acknowledgments:elink..
  94. :h2.Limitations
  95. :i2 refid=generel.Limitations
  96. The game allows up to ten simultaneous players.
  97. :p.If the program is minimized while new players are inserted, their child
  98. windows are placed under each other on the game sheet.
  99. :h2.Information for programmers
  100. :i2 refid=generel.Information for programmers
  101. The program utilizes a lot of unique OS/2-features, such as user-developed
  102. controls, 
  103. (:link reftype=hd res=1004.dices:elink. and sets of dices), multiple
  104. threads (in the
  105. :link reftype=hd res=1001.server-program:elink.),
  106. Information Processing Facility (this help), Named
  107. Pipes (communication between the game sheets and the server-program), Dynamic
  108. Link Libraries (for various language-dependent resources), National 
  109. Language Support, use of user profiles (for storage of the player- and
  110. servername), Common User Access Multiple Document Interface, 
  111. an undo-facility, and so on.
  112. :p.It was developed using the IBM :hp1.Programming Tools and 
  113. Information:ehp1.
  114. version 1.2 and the IBM C/2 version 1.1. The editor used was the IBM Live
  115. Parsing Editor. The development process was 
  116. undertaken on an IBM Portable P70-061 with 4MB memory. The operating system
  117. was IBM OS/2 Standard Edition 1.2. Note that this program, which is aimed at 
  118. a LAN-environment, is developed on a stand-alone PC without any 
  119. LAN-facilities.
  120. :p.Since so many unique OS/2-facilities have been used, the program is a 
  121. good illustration of the potentials of OS/2. The program can, besides the
  122. Yatzee-game, be used as an example of OS/2's broad capabilities.
  123. :p.Any questions, comments or error reports should be directed to the address
  124. mentioned in 
  125. :link reftype=hd res=1005.Acknowledgments:elink..
  126. :h1 res=206.Keys help for Yatzee
  127. :i1 id=taster.Keys help for Yatzee
  128. The following keys can be used during the game:
  129. :dl. 
  130. :dthd.Key
  131. :ddhd.Function
  132. :dt.Ctrl+I
  133. :dd.:link reftype=hd res=101.Insert player:elink.
  134. :dt.Ctrl+T       
  135. :dd.:link reftype=hd res=102.Transfer throw:elink.
  136. :dt.Ctrl+R          
  137. :dd.:link reftype=hd res=103.Reset dices:elink.
  138. :dt.Ctrl+D
  139. :dd.:link reftype=hd res=1004.Dices:elink.
  140. :dt.F10                           
  141. :dd.Transfer the focus to the actionbar
  142. :edl.
  143. :p.Keys for throwing and selection of dices:
  144. :dl break=fit.
  145. :dthd.Key
  146. :ddhd.Function
  147. :dt.Spacebar
  148. :dd.Toggles the dice with focus between selected and not selected
  149. :dt.Arrow keys
  150. :dd.Move focus between the dices
  151. :dt.Enter
  152. :dd.Thow the dices which p.t. is selected. Note that the dice which has the
  153. focus always is selected and participates in the throw, even though it on the
  154. time for the throw is not selected.
  155. :edl.
  156. :p.Other keys:
  157. :dl.
  158. :dthd.Key
  159. :ddhd.Function
  160. :dt.Alt+                          
  161. :dd.Provide categories in the dialogbox  
  162. :link reftype=hd res=258.Transfer throw:elink.
  163. :edl.
  164. :p.Besides the above mentioned keys, OS/2's normal keys can be used - i.e.
  165. F1 for help.
  166. :h1.Help for actionbar
  167. :i1 id=menuer.Help for actionbar
  168. In this item, there is help for the different menu-choices.
  169. :h2 res=100.Options
  170. :i2 refid=menuer.Options
  171. Here you select between a row of choices, which controls the game.
  172. :p.Look at the the help for the individual items to get a description.
  173. :h3 res=101.Insert player
  174. :i2 refid=menuer.Insert player
  175. When you select this item, you can insert a player by entering his or hers
  176. name. If you are playing in a 
  177. :link reftype=hd res=1003.LAN:elink.-environment, the name of the computer 
  178. on which the
  179. :link reftype=hd res=1001.server-program:elink. runs must also be entered.
  180. :p.It is only possible to insert one player per game sheet. When this has
  181. happened, the item turns grey and cannot be selected again.
  182. :h3 res=102.Transfer throw 
  183. :i2 refid=menuer.Transfer throw
  184. When you select this item, you transfer your throw to the
  185. :link refid=pointtavle reftype=fn.score-board:elink.. The item cannot be 
  186. selected until you have thrown the 
  187. :link reftype=hd res=1004.dices:elink. at least once since the last 
  188. transfer to the score-board.
  189. :h3 res=108.Undo transfer
  190. :i2 refid=menuer.Undo transfer
  191. When you select this item, you undo the last transfer of a throw to the
  192. :link refid=pointtavle reftype=fn.score-board:elink.. After the selection of
  193. this item, you are in the same situation as just before the transfer took 
  194. place. This means, that if you had one or two throws left, you are now able
  195. to make them.
  196. :note.This item can only be selected just after a transfer of a throw to the
  197. :link refid=pointtavle reftype=fn.score-board:elink.. If you for example have
  198. made a :link reftype=hd res=103.Reset dices:elink. in the meantime, the 
  199. :hp1.Undo transfer:ehp1. is not applicable.
  200. :h3 res=103.Reset dices
  201. :i2 refid=menuer.Reset dices
  202. When you select this item, you removes any selections of dices and they are
  203. all reset to aces. This item can only be selected just after that a throw
  204. has been transferred to the 
  205. :link refid=pointtavle reftype=fn.score-board:elink..
  206. :h2 res=104.Window 
  207. :i2 refid=menuer.Window
  208. When you select this item, you can select between your own child window with
  209. dices and the other players child windows.
  210. :p.This item makes the program independent of a mouse.
  211. :h3 res=105.Dices 
  212. :i2 refid=menuer.Dices
  213. When you select this item, you give your own 
  214. :link reftype=hd res=1004.dices:elink. focus.
  215. :p.This item makes the program independent of a mouse.
  216. :h3 res=107.About
  217. :i2 refid=menuer.About
  218. When you select this item, you show the programs About-dialogbox.
  219. :h1.Dialogboxes 
  220. Help to the dialogboxes in the game.
  221. :h2.Insert player     
  222. :i1 id=indsæt.Insert player
  223. Help to the entryfields of the dialogbox :hp1.Insert player:ehp1..
  224. :h3 res=642.Name of player 
  225. :i2 refid=indsæt.Name of player
  226. In this entryfield you enter the name of the player. The name helps the other
  227. players identifying each other. It is possible for two or more players to 
  228. have the same name, but it is recommended to use unique names. 
  229. :p.The entryfield can contain a maximum of 39 characters, which will be 
  230. remembered between games.
  231. :h3 res=643.Name of server 
  232. :i2 refid=indsæt.Name of server
  233. When you play in a :link reftype=hd res=1003.LAN:elink.-environment, the 
  234. :link reftype=hd res=1001.server-program:elink. must be started on the 
  235. LAN-server. The machine-identification of the server must be entered in this
  236. entryfield. 
  237. :p.If you are in doubt about which servers you have access to, you can use 
  238. the NET VIEW-command. If you want further information, see your local 
  239. network-administrator or consult the handbook 
  240. :hp1.OS/2 LAN Server Network Administrators Guide:ehp1.. 
  241. :p.The entryfield can contain a maximum of 8 characters, which will be 
  242. remembered between games.
  243. :h2 res=258.Transfer throw
  244. :i1.Transfer throw
  245. In this dialogbox, you specify where to place your throw. It is only possible 
  246. to choose between categories not chosen before. The program makes a 
  247. suggestion, but if you want to make another choice, you can select between
  248. the available options. Either click on the down-arrow or press Alt+ on the 
  249. keyboard. 
  250. :p.It is possible to undo the transfer by selecting 
  251. :link reftype=hd res=108.Undo transfer:elink..               
  252. :h1 res=1001.The server-program 
  253. :i1.Server-program
  254. This program is the center of communication between the game sheets, whether 
  255. the game takes place on one or more computers. When more computers are 
  256. involved, the server-program must be executed on the server in the 
  257. :link reftype=hd res=1003.local area network:elink.. 
  258. The name of the server-program is YASERVER.EXE. The server-program must be 
  259. started before the first player can be inserted. When the server-program has
  260. been started, it waits for the first insertion. If it does not receive an 
  261. insertion within two minutes, it will bring itself to an end. When the last 
  262. player has terminated and closed the game sheet, it will also bring itself to
  263. an end. When at least one player has an open game sheet, the server-program
  264. allows fifteen minutes of inactivity before it brings itself to an end.
  265. :p.It is possible to start the server-program from any computer in the 
  266. network via the NET RUN-command. The current drive must be the
  267. network-drive upon which the server-program is placed. If you 
  268. want further information, see your local network-administrator or 
  269. consult the handbook 
  270. :hp1.OS/2 LAN Server Network Administrators Guide:ehp1.. 
  271. :p.During playtime, the server-program writes to its window whenever a 
  272. player is inserted and terminated. If you want more exhaustive information,
  273. you can pass any parameter to the program, when it is started. For example
  274. the following command causes full information written to the window about the 
  275. various messages, which the server-program processes:
  276. :xmp.
  277. YASERVER 1
  278. :exmp.
  279. :h1 res=1002.Rules for Yatzee 
  280. :i1.Rules for Yatzee
  281. The game of Yatzee is played with five dices, and is won by the player with 
  282. the highest score when the game is over. 
  283. :p.The game consists of fifteen rounds per player. For each round, the 
  284. player can make up to three throws. After each throw, the player can 
  285. optionally deselect any number of dices or none at all. After the first or
  286. second throw, the player may transfer the throw to the score-board. After 
  287. the third throw, the throw :hp5.must:ehp5. be transferred. It is possible for
  288. a dice to participate in a throw even though it earlier in the same round 
  289. was deselected.
  290. :p.There is fifteen score-categories, and each round results in one of them
  291. being filled, possibly by nil. It is only possible to transfer once to a 
  292. score-category. However, under certain circumstances, it is possible to 
  293. undo the last transfer. For further information, see    
  294. :link reftype=hd res=108.Undo transfer:elink.. 
  295. As a generel rule, the score in a category is equal to the number of pips on 
  296. the dices which is a part of the name of the score-category. Only the
  297. :hp2.Yatzee:ehp2. score-category is an exception from this. 
  298. :p.The upper six categories on the score-board are called :hp2.Aces, Twos,
  299. Threes, Fours, Fives and Sixes:ehp2.. For each, only the dices belonging 
  300. to the name counts when the score is calculated. If for example a throw 
  301. consisting of one ace, two threes, one fiver, and one sixer is transferred 
  302. to the category :hp2.Threes:ehp2., 2 times 3 equals 6 points are reached. If 
  303. the throw one ace, two threes, and two sixes are transferred to the category 
  304. :hp2.Sixes:ehp2., 12 points are reached. For these six upper categories, it 
  305. is possible to get a special :hp1.bonus:ehp1. of 50 points, when the sum of 
  306. their scores is greater than 62. This equals an average of three dices in 
  307. each category. Until a throw has been transferred to all these six 
  308. categories, the bonus-category keeps a record with a possible surplus or 
  309. deficit. When all the categories have received a score, the bonus-category 
  310. contains the sum of the scores inclusive any bonus.
  311. :p.The next four score-categories is called :hp2.One pair, Two pairs, 
  312. Three alike:ehp2. and :hp2.Four alike:ehp2.. When a throw is transferred 
  313. to these categories, the score is given according to the name of the 
  314. category. For example a throw of two threes, one fiver and to sixes 
  315. transferred to :hp2.One pair:ehp2. yields 
  316. 2 time 6 equals 12 points, because the highest of the two possible pairs are
  317. selected. The same throw yields 18 points (the sum of 2 times 3 and 2 times 
  318. 6) when transferred to :hp2.Two pairs:ehp2.. 
  319. :note.When a throw containing four alike is transferred to :hp2.Two 
  320. pairs:ehp2., it yields nil.
  321. :p.The next to score-categories are respectively :hp2.Small:ehp2. and
  322. :hp2.Large:ehp2.. :hp2.Small:ehp2. yields 15 points, if the five dices
  323. show 1, 2, 3, 4 and 5 in any order. :hp2.Large:ehp2. yields 20 points
  324. when the ace in the just mentioned throw is replaced with a sixer. 
  325. The category :hp2.Full house:ehp2. demands, that the transferred throw 
  326. consists of two of one kind and three of another kind. As an example a throw
  327. that consists of three aces and two fives yields the sum of 3 times 1 and 2
  328. times 5 equals 13 point.
  329. :note.When a throw containing five alike is transferred to :hp2.Full 
  330. house:ehp2., it yields nil.
  331. :p.The following score-category is called :hp2.Chance:ehp2., and yields the 
  332. sum of the dices transferred. When as an example a throw containing 1, 2, 3, 
  333. 4 and 6 is transferred, it yields 16 points. Any throw transferred to 
  334. :hp2.Chance:ehp2. results in some points.
  335. :p.The last score-category is the one naming the game: :hp2.Yatzee:ehp2..
  336. When five dices of the same kind are transferred, it yields 50 points, no
  337. matter what the dices show.
  338. :h1 res=1003.Local area network 
  339. :i1.Local area network
  340. LAN is an acronym for :hp5.L:ehp5.ocal :hp5.A:ehp5.rea :hp5.N:ehp5.etwork.
  341. This stands for a number of stand-alone computers (:hp1.clients:ehp1.)
  342. connected to a host-computer (:hp1.server:ehp1.) via high-speed connections. 
  343. :p.The
  344. :link reftype=hd res=1001.server-program:elink. of the Yatzee-game 
  345. YASERVER.EXE) must be executed on the server-computer in the local area 
  346. network, and the name of this computer must be entered when the 
  347. client-program of the Yatzee-game (YATZYNET.EXE) is executed on the 
  348. clients in the network.
  349. :h1 res=1004.The dices 
  350. :i1.Dices
  351. The game of Yatzee is played with five dices. Check 
  352. :link reftype=hd res=1002.rules:elink. for a more exhaustive explanation of 
  353. their meaning.
  354. :p.You are able to select or deselect a dice by clicking on it with 
  355. mousebutton 1 (normally the left button). When a dice is deselected, it does 
  356. not participate in the next throw. A deselected dice is marked with two 
  357. crossing lines.
  358. :p.You throw the dices by doubleclicking with mousebutton 1 on any dice. 
  359. :note.The dice you doubleclicks is :hp1.always:ehp1. selected and 
  360. participates in the throw. 
  361. :p.Under certain circumstances the game does not allow that you manipulate
  362. the dices - for example when all three throws have been made. They are then
  363. greyed. Under other circumstances - when you have transferred a throw or 
  364. reset the dices - you are not allowed to deselect dices. 
  365. :p.If you want to use the keyboard instead of the mouse for manipulating the 
  366. dices, you can do that. See how in 
  367. :link reftype=hd res=206.Keys help:elink..
  368. :h1 res=1005.Acknowledgments
  369. :i1.Acknowledgments
  370. This program is a result of work undertaken in the period of October to 
  371. December 1990 by Peder Madsen.
  372. :p.Different people have more or less contributed to the program and deserves
  373. to be mentioned:
  374. :p.The
  375. :link reftype=hd res=1001.server-program:elink.
  376. is based on an article in the IBM magazine
  377. :hp1.Personal Systems Developer:ehp1. from winter 1990 entitled 
  378. &odq.A Multi-User Server Using Named Pipes&cdq.. This article was written by
  379. Bryan Jackson from the company XcelleNet, Inc., Atlanta, USA.
  380. :p.The development of the dices are inspired by an article from IBM Systems
  381. Journal vol. 29, No. 1, 1990 entitled &odq.Effective application development
  382. for Presentation Manager programs&cdq. by Susan Franklin and Tony Peters.
  383. :p.Inspiration has also come from a DOS-based version of the Yatzee-game
  384. written by Bj¢rn Krogh.
  385. :p.Thanks also to my wife Mette and my two daughters Vibe and Helene, who has
  386. spent many lonely nights, while I worked on this program.
  387. :p.If you use this game, please send 20 USdollars to:
  388. :xmp.
  389.          Peder Madsen
  390.          Dalgas Have 68, st. t.v.
  391.          DK-2000 Frederiksberg
  392.          Denmark, Europe
  393. :exmp.
  394. :p.You will then get the possibility of new versions or offerings of other
  395. programs that I make.
  396. :p.Please direct comments and error reports to the above address.
  397. :p.The program is free of charge (except as mentioned above) and you may copy
  398. the program freely. The program may not be sold or distributed commercially
  399. or otherwise for profit. I reserve all rights and priviligies to this program. 
  400. :p.Installation and use of this program is on your own responsibility. The 
  401. author disclaims responsibility for any damage to your computer and its data.
  402. :p.Please note, that I have done the translation from danish to english 
  403. myself, and that it therefore might contain some errors. I will welcome any
  404. corrections.
  405. :p.Copyright (c) 1990 by Peder Madsen.
  406. :fn id=pointtavle.
  407. The score-board is the right part of a players child window. It constantly 
  408. monitors the players score in each score-category. At the bottom there is a 
  409. total, which at all times contains the sum of the players points. In this 
  410. total, any bonus-points are included. 
  411. :p.The line with the bonus-category (the seventh from the top) can be in two
  412. different modes: When throws have been transferred to all the six upper 
  413. categories, the bonus-line denotes any bonus. When not all the categories 
  414. have received a throw, the bonus-line denotes the current status. A negative 
  415. number means, that if bonus were to be settled now, none would be given. Zero
  416. or a positive number means, that bonus would be given.
  417. :p.For futher information concerning the rules for getting bonus, check 
  418. :link reftype=hd res=1002.rules:elink..
  419. :efn.
  420. :euserdoc.
  421.