home *** CD-ROM | disk | FTP | other *** search
/ ftp.uni-stuttgart.de/pub/systems/acorn/ / Acorn.tar / Acorn / acornet / fun / games / hextris.spk / !Hextris / !Help < prev    next >
Text File  |  1988-11-08  |  13KB  |  257 lines

  1. Documentation file for !Hextris version 0.20
  2.  
  3.  
  4.  
  5. Hextris is public domain. It is dedicated to all those, who deliver true quality public domain software.
  6.  
  7. This file describes the desktop game Hextris for the Acorn RISCOS range of personal computers. The game is quite simply a variation of the grand classic 'Tetris' game of the 1980s, though much harder. It is not necessary to read this file in order to play the game, so if you don't care about learning all the esoteric features of the game, just stop reading by the end of this paragraph and get playing!
  8.  
  9. If you reached this paragraph anyway, you will probably want to know a little more about the game of Hextris, so below is the table of contents of this file, each line is the name of a section describing some feature of Hextris.
  10.  
  11.  
  12.  
  13. Contents ______________________________________________________________________
  14.  
  15.     Features
  16.     Gameplay
  17.     The Hextris Menu
  18.     Scoring
  19.     Extras
  20.     Technical
  21.     Disclaimer and Addresses
  22.  
  23.  
  24.  
  25. Features ______________________________________________________________________
  26.  
  27. Hextris is a desktop game, handwritten in assembler for smallness and fast execution. Below is listed the main features of Hextris.
  28.  
  29.     Fully multitasking game in RISCOS desktop.
  30.     Handwritten in ARM assembler, taking very little processor time.
  31.     Compact program (approximately 16KB).
  32.     User customisable. Settings can be saved.
  33.     Control by keyboard or mouse.
  34.     Adaptive to mode changes.
  35.     Optimised redrawing.
  36.     Permanent highscore table.
  37.  
  38.  
  39.  
  40. Gameplay ______________________________________________________________________
  41.  
  42. Open the Hextris game window by clicking on its icon on the iconbar. The game is started by clicking the mouse select button within the game window.
  43.  
  44. Hextris can be controlled by either keyboard or mouse. The mode of control is selected by clicking the corresponding item within the menu 'Hextris.Options.Control'.
  45.  
  46.  
  47. Keyboard control
  48. ----------------
  49. The control keys can be altered in the submenu of 'Hextris.Option.Control.Keys'. The default keys are as follows:
  50.  
  51. Z    left
  52. X    right
  53. '    rotate counter clockwise
  54. /    rotate clockwise
  55. <space>    drop
  56. H    toggle help
  57. P    pause (click in game window to resume game)
  58.  
  59. The game can also be paused by clicking the mouse select button within the game window. Note that Hextris will be paused if another application claims the input focus of the Wimp.
  60.  
  61.  
  62. Mouse Control
  63. -------------
  64. When Hextris is controlled by mouse, the brick is moved horizontally by the movement of the mouse. The left mouse button rotate the brick counterclockwise, while the right mousebutton rotates the brick clockwise. The middle button drops the brick.
  65.  
  66. Pausing the game under mouse control is obtained by either closing the game window or clicking the mouse adjust button in the Score/Help window. The game is started/resumed by clicking the mouse select button within the game window.
  67.  
  68. If Hextris is played with mouse, it does not claim the input focus of the Wimp. This means that you can use an editor, while your girlfriend play Hextris with the mouse.
  69.  
  70.  
  71. Hextris can be customised in its appearance in a variety of ways. The customisation is accessed in the submenu 'Hextris.Options'. The next section will describe most of the other features of Hextris.
  72.  
  73.  
  74.  
  75. The Hextris Menu ______________________________________________________________
  76.  
  77. Below is a description of each item in the Hextris menu, ordered top-down, as they appear on-screen.
  78.  
  79.  
  80. Hextris.Info
  81. The submenu of this item is the standard info box.
  82.  
  83. Hextris.Options
  84. The submenu of this item provides access to the various options of Hextris.
  85.  
  86. Hextris.Options.Control
  87. The submenu of this item is for selecting which control to use, either keys or mouse. Clicking this item toggles between the two modes of control.
  88.  
  89. Hextris.Options.Control.Keys
  90. Click this to select the keyboard for playing. The submenu of this item is used for selecting new control keys. See the section 'Gameplay' for details.
  91.  
  92. Hextris.Options.Control.Mouse
  93. Click this to select the mouse for playing. See the section 'Gameplay' for details of how to control Hextris with the mouse.
  94.  
  95. Hextris.Options.Sprites
  96. Clicking any of the four items in the submenu of this item, will change the appearance of Hextris, by loading a new set of sprites. If you have designed your own sprites, you can write the name of the spritefile into one of the icons (See the 'Technical' section for further details). The four menu items described below are the default names.
  97.     
  98. Hextris.Options.Sprites.medium
  99. Click this to select medium size, multicoloured appearance of the bricks.
  100.  
  101. Hextris.Options.Sprites.large
  102. Click this to select extra small size, multicoloured appearance of the bricks.
  103.  
  104. Hextris.Options.Sprites.small
  105. Click this to select small size, multicoloured appearance of the bricks.
  106.  
  107. Hextris.Options.Sprites.lhomo
  108. Click this to select the large size, homegeneous coloured appearance of the bricks. Note that this is a special variant and only applicable in 256 colour modes. There are also small and medium size versions of this, called 'shomo' and 'mhomo' respectively.
  109.  
  110. Hextris.Options.Size
  111. The extent of the playarea can be controlled in the submenu of this item.
  112.  
  113. Hextris.Options.Colour
  114. Click within the submenu of this item to change the background colour of the playarea. Note that some bricks may be invisible, if the background colour is the same as the brick.
  115.  
  116. Hextris.Options.Adapt mode
  117. Click this item to toggle Hextris's automatic adaptation to mode changes. When this option is set, Hextris will try its best to adapt to a mode change, in effect ensuring a continuous fast update of the playarea. Note that disc access will occur on modechanges, when this option is enabled. See the section 'Technical' for further details.
  118.  
  119. Hextris.Options.Help
  120. Click this item to toggle the help feature. You can also toggle the help feature by clicking select within the Score/Help window.
  121.  
  122. Hextris.Options.Save
  123. Clicking this item will save all the current settings of the options on disc, such that Hextris will appear the same, next time it's loaded. All options, which can be set within the 'Hextris.Options', menu are saved.
  124.  
  125. Hextris.Show
  126. The submenu of this item controls opening of various information windows. Clicking directly on this item, opens the Help/Score window.
  127.  
  128. Hextris.Show.Help
  129. Click this item to open the Score/Help window. This window will display your current score and the number of lines you have cleared. If the help feature is enabled, the window will also show you the next brick to appear.
  130.  
  131. Hextris.Show.Statistics
  132. Click this item to open the statistics window. This window displays how many times each brick has occurred since you loaded Hextris.
  133.  
  134. Hextris.Show.Highscores
  135. Click this item to open the highscores window.
  136.  
  137. Hextris.Quit
  138. Click this to quit Hextris. Note that this item is only present on the iconbar menu.
  139.  
  140.  
  141.  
  142. Scoring _______________________________________________________________________
  143.  
  144. Scoring is awarded according to a rather complex scheme. All scoring is proportional to the level of play, ie. how many lines have been cleared. For each ten lines cleared, the level is advanced and the speed is increased.
  145.  
  146. The more lines you clear in one go, the more points you get per line cleared. That is, clearing two lines in one go will yield a higher scoring than clearing one line in two goes.
  147.  
  148. A small bonus is awarded for dropping the brick. The bonus is proportional to the number of lines the brick was dropped.
  149.  
  150. When the help feature is enabled all scoring will be reduced by 25%, due to the
  151. easier play.
  152.  
  153. If you have obtained a highscore, it will only be recorded, if the size of the game area is such that the number of lines is less than or equal to two times the number of columns.
  154.  
  155.  
  156.  
  157. Extras ________________________________________________________________________
  158.  
  159. Hextris has a number of shortcuts available, as described below.
  160.  
  161. Clicking the adjust mouse button on the iconbar will open both the game window and the Score/Help window. Note that the Score/Help window is also automatically opened, if the help feature is enabled.
  162.  
  163. Closing the game window with the adjust button will close all the windows of Hextris.
  164.  
  165. Clicking the select button in the Score/Help window will toggle the help feature.
  166.  
  167. If you have attained a highscore and Hextris is waiting for you to type it in, you are free to close the Hexscores window or start a new game by clicking in the game window. Hextris will then automatically insert the name of the last highscorer into the list of highscores.
  168.  
  169.  
  170.  
  171. Technical _____________________________________________________________________
  172.  
  173. This section describes the more esoteric features of Hextris. Reading this section will, among other things, enable you to customise the appearance of Hextris, by defining your own sprites!
  174.  
  175. Hextris includes a collection of spritefiles within the directory '!Hextris.Sprites'. Each brick consists of four sprites, where each sprite has the shape of a hexagon. A spritefile must contain at least three sprites. Spritefiles are named according to the mode the sprites within the file are defined in.
  176.  
  177. A spritefile is named 'BXY_abcdef'. We call 'BXY' the modeprefix. The elements of the filename are as described below:
  178.  
  179. 'B' is one of the digits '0', '1', '2' or '3'. The digit represents the base two logarithm of the number of bits per pixel (BPP) of the mode the sprites are defined in. That is, for modes with 16 colours, B equals '2', while for 256 colour modes, B equals '3' etc.
  180.  
  181. 'X' is a digit '0', '1', '2' etc. The digit represents the XEigFactor for the mode the sprites are defined in. The XEigFactor is the ratio between the external horizontal resolution and the internal horizontal resolution. F.ex in mode 12, the XEigFactor is one, while in mode 13, the XEigFactor is two.
  182.  
  183. 'Y' is similar to 'X', though 'Y' represents the YEigFactor.
  184.  
  185. 'abcdef' is a unique string, that is, a filename of at most six characters.
  186.  
  187.  
  188. When the 'Adapt mode' feature is disabled, Hextris will scale sprites and translate colours according to the current screen mode. Hextris will *not* try to adapt to the current mode. This can effect slow update of the game window. Hextris will only attempt loading of a new spritefile, if the current spritefile is incompatible with the current screen mode. This is the case when Hextris uses 256 colour sprites and the mode is changed to a 16 colour mode.
  189.  
  190. Otherwise, when the 'Adapt mode' feature has been enabled from the menu 'Hextris.Options', Hextris will, upon a mode change or a change of sprites (from the menu 'Hextris.Options.Sprites'), try its best to adapt to the mode. Hextris will try each of the following actions, in the order they appear below.
  191.  
  192. 1 Load the spritefile, whose name is ticked in the submenu 'Hextris.Option.Sprites', prefixed by the modeprefix of the current Wimp screen mode.
  193.  
  194. 2 Load the spritefile with the same name as above, but with with an optimal mix of the default modeprefix and the modeprefix of the current screenmode.
  195.  
  196. 3 Load the spritefile with the same name as above, but using the default modeprefix.
  197.  
  198. 4 Load the default spritefile.
  199.  
  200. 5 Load the spritefile named '212_small'
  201.  
  202. When Hextris has succeeded in one of the above actions, the name of the file loaded, is stored in the default spritefile name.
  203.  
  204. See the file '!Hextris.Sprites.!ReadMe' for further details of how to design your own sprites.
  205.  
  206.  
  207.  
  208. Disclaimer and Addresses ______________________________________________________
  209.  
  210. First the utterly boring stuff...
  211.  
  212. Hextris is the exclusive copyright of Mads Meisner-Jensen. Hextris is Public Domain and may be freely copied, provided that all files are retained, and no changes made. No charge whatsoever for this software should be made under any circumstances, including charging for public domain discs!
  213.  
  214. Hextris is used at your own risk. I, The author Mads Meisner-Jensen, cannot accept any liability for any loss or damage arising from the use of Hextris
  215.  
  216. Any commercial use with the aim of profit of any part of this software and documentation, in part or whole is illegal without my written permission.
  217.  
  218. The files included in release 0.20 are, in alphabetic order:
  219.  
  220. !Boot
  221. !Help
  222. !Hiscores
  223. !Options
  224. !Run
  225. !RunImage
  226. !Sprites
  227. Sprites.!ReadMe
  228. Sprites.112_large
  229. Sprites.112_medium
  230. Sprites.112_small
  231. Sprites.211_large
  232. Sprites.211_medium
  233. Sprites.211_small
  234. Sprites.212_large
  235. Sprites.212_medium
  236. Sprites.212_small
  237. Sprites.312_large
  238. Sprites.312_lhomo
  239. Sprites.312_medium
  240. Sprites.312_mhomo
  241. Sprites.312_shomo
  242. Sprites.312_small
  243. Templates
  244.  
  245.  
  246.  
  247. Now some not so boring stuff...
  248.  
  249. If you have *any* comments, bug reports etc., please don't hesitate to contact me. You can contact me via electronic mail or human mail. Please - no phone calls. I read my e-mail almost every working day.
  250.  
  251. Mads Meisner-Jensen
  252. Valdemarsgade 6, st.tv.
  253. DK-9000 Aalborg
  254. Denmark
  255.  
  256. e-mail: mmj@vlsi-gw.vlsi.auc.dk
  257.