home *** CD-ROM | disk | FTP | other *** search
/ ST-Computer Leser 2002 January / STC_CD_01_2002.iso / GAMES / BOINKO21 / README.TXT < prev   
Text File  |  2002-01-03  |  13KB  |  333 lines
  1.  
  2.      Documentation for BoinkOut2
  3.      Current Revision: 2.1
  4.  
  5.      Homepage:  http://www.netset.com/~baldrick/boinkout2.html
  6.  
  7. What's new?
  8.  
  9.      GEMscript support and some RSC modifications by Matthias Jaap
  10.               
  11. What is it?
  12.  
  13.      A "BreakOut" style game.  Bounce the ball off of the paddle
  14.      to destroy the bricks.  Destroy all the non permanent bricks
  15.      and the level is finished.
  16.  
  17.      Originally released for the Magic Gaming Competition 99, where
  18.      it came in second place.
  19.  
  20.      What Resolutions does it support?
  21.  
  22.      Right now realistically.  ST High and Above.  There is code in
  23.      the program to work with ST Medium.  But it is not working at the
  24.      moment.  It will attempt to run in whatever resolution you
  25.      boot it in as if the screen were big enough for it to run.
  26.      This in one way is annoying, but in another avoids some of the
  27.      resolution detection problems that I had in the past when
  28.      working on AstroPanic.
  29.  
  30.      ie.  If the screen resolution isn't high enough.  It's damn
  31.      hard to play ;)
  32.  
  33.      What Color Depth does it support?
  34.  
  35.      Any.  With the default images, it's happiest in 8 bit color (256
  36.      colors) or higher.  However you can load your own background
  37.      image with whatever depth you like (1-8 planes).
  38.  
  39.      What Img formats does it support?
  40.  
  41.      Ximg and normal Atari Image formats should work for your backgound
  42.      images.  BoinkOut2 does not support Truecolor Ximg files.
  43.  
  44.      What is "Timing"?
  45.  
  46.      The entire program operates off of the VDI and AES.  The
  47.      timing value is what you want the default minimum timing 
  48.      to be.  For an ST this should be 0.  However for a TT
  49.      with a graphics card.  I recommend in the range of 30.
  50.      An 060 seems to work alright at 60.
  51.      You will want to set the timing to whatever you feel is
  52.      the most enjoyable for your system.
  53.  
  54.      Any cool things not listed in the Menu?
  55.  
  56.      Yes one.  Close the gameplay window.  Hold down the Right Shift key
  57.      and select New Game from the Menu.  This should launch you into
  58.      the demo mode.  You will then be able to watch the game run through
  59.      the levels.
  60.  
  61. Controls
  62.  
  63.      The game is controled with the mouse.  Moving the mouse will
  64.      move the paddle in the play area.  Extra features of the game
  65.      can be accessed from the Menu Items or Hotkeys.
  66.  
  67.      HOTKEYS
  68.  
  69.      Certain keys or combinations of keys operate as shortcuts.
  70.  
  71.      Control - O   Start a New Game.
  72.  
  73.      Control - N   Start a New game.  Opens new window if necessary.
  74.  
  75.      Esc           Pause a game in progress. Pressing again unpauses.
  76.  
  77.      Control - Q   Quit the program
  78.  
  79.      Control - L   Load a background image. User selectable via
  80.                     the file selector.
  81.  
  82.      Control - J   Open the Jump to Level dialog.
  83.  
  84.      Control - C   Copy to clipboard the current editable text field.
  85.  
  86.      Control - V   Paste clipboard into current editable text field.
  87.  
  88.      Help          Opens the BOINKOUT.HYP file if ST-GUIDE is present
  89.      
  90.      Menu Items
  91.  
  92.      About BoinkOut2
  93.  
  94.           Displays information about the game.  Revision and URL.
  95.  
  96.           Selecting URL string in dialog will launch web browser to
  97.           the BoinkOut2 page under the following conditions.
  98.           
  99.              1. User has an enviromental string of either
  100.                     WWW_CLIENT or BROWSER configured to their browser
  101.                     
  102.              2. The browser supports command line URL starts
  103.              
  104.              3. It all works better under an AV_SERVER system
  105.              
  106.      New Game
  107.  
  108.           Starts a New Game.  Will abort a game in progress.  Will
  109.           open a new window if necessary.
  110.  
  111.      Jump to Level
  112.  
  113.           Opens a windowed dialog that displays the following information.
  114.           File name of the Level set you are currently using.
  115.           Number of levels in that level set.
  116.           It also allows you to enter a level and press jump.  If it's a valid
  117.           level a new game will be started at that level.  This only works
  118.           if you have a Game window open.
  119.  
  120.      Pause Game
  121.  
  122.           Pauses a game in progress.  Selecting again will unpause
  123.           the game.  Only pauses/unpauses if the Game Window is the top window.
  124.  
  125.      Quit
  126.  
  127.           Exits the program.
  128.  
  129.      Set Object Colors
  130.      
  131.           Opens the Object Colors Dialog.
  132.           
  133.           This allows you to change what colors which the different objects
  134.           in the game will be drawn with to the screen.   Select the name
  135.           for the object that you wish to change it's color, then select
  136.           a color from the color box.
  137.           
  138.          When you have finished editing the object colors, select "Set Colors".
  139.          If you do not wish to change any colors simply close the window.
  140.           When you choose "Set Colors" the level you are on will restart.
  141.           
  142.           
  143.      Set Timing
  144.  
  145.           Opens the Timing Dialog.  For "What is timing" see above.
  146.           
  147.           Suggested timing values to start with:
  148.  
  149.           Normal ST      0   (Includes All 8 mhz 68000 Atari's)
  150.           TT/Nova Gfx    30
  151.           060 clones     60  (Seems to be a good place to start)
  152.  
  153.           You will want to experiment with the timing for your own
  154.           system.  Let me reitterate.  Experiment with the speeds
  155.           what is a good speed for one person will be a quick trip
  156.           to game end for another.  This is for entertainment, set
  157.           the timing to where you have fun.
  158.           
  159.      Load New Background...
  160.  
  161.           Opens system file selector.  This allows you to select a
  162.           new (X)IMG file to operate as the backdrop to the game
  163.           play area.  See "What image formats " above.
  164.  
  165.      Sound ON/OFF
  166.  
  167.           This toggles whether to play any sounds or not.  When off
  168.           your boss or wife won't know what you are doing ;)
  169.  
  170.      Load Level Set...
  171.  
  172.           Opens system file selector.  This allows you to select a
  173.           new LVL file.  LVL files are level description files for
  174.           BoinkOut2.  You can make your own LVL files and share
  175.           them with your friends.
  176.  
  177.      View High Scores
  178.  
  179.           Opens the High Score window.  This will show you how well
  180.           you or your friends have done in the past.  It will also
  181.           show you the first time you play, that I have watched too
  182.           many episodes of "Are You Being Served?", over the years.
  183.  
  184.      Save Preferences
  185.  
  186.           This option will save your game preferences.
  187.           At the moment it saves your timing variable and
  188.           your object color settings.
  189.  
  190.  
  191. Game Play
  192.  
  193.      BoinkOut2 at it's heart is a breakout game.  If you don't know
  194.      what breakout is then play it for a few minutes and you will know ;)
  195.  
  196.      However BoinkOut2 is also close to the family of Arkanoid.  Kind
  197.      of a Breakout+.
  198.  
  199.      The game takes place in the game window.  We will refer to this
  200.      as the play area.  At the top of the play area, you will see
  201.      three fields.
  202.  
  203.      The first is preceded by a strange shaped litle object that is
  204.      a representation of the ball used in play.  The number next to
  205.      it shows how many balls you have left.  Note.  If it says 1
  206.      you are on your last ball.  Once you hit 0 the game is over.
  207.  
  208.      The next field is the Level indicator.  This shows what level
  209.      you are on.  The built in levels of BoinkOut2 number 36, once
  210.      (if) you hit 36 you will wrap and start at level 1 again.
  211.  
  212.      The last field on the right is your score.
  213.  
  214.      Below this should be an array of blocks.  Level 1 has 7 rows
  215.      and 9 columns of blocks.  Level 1 has all normal blocks.
  216.  
  217.      There are several types of blocks in the game.
  218.  
  219.      1. Normal bricks.        One hit and they are gone.
  220.      2. Normal Spin bricks.   Look a bit different one hit.
  221.      3. Double Spin bricks.   Two hits to get rid of this.
  222.      4. Triple Spin bricks    Three hits...
  223.      5. Quadruple Spin bricks Four hits...
  224.      6. Permanent bricks      Can not be destroyed.
  225.      7. Magic Bricks          See below
  226.  
  227.      Magic Bricks are the fun ones.  You never know quite what is
  228.      going to happen.  The play area could be erased, all the bricks
  229.      can become invisible, multiple balls can come out.  There are
  230.      some suprises waiting for you with these.
  231.  
  232.      At the bottom of the play area, is an open area containing your
  233.      paddle.  This is what you use to hit the balls back up.  A ball
  234.      hitting the bottom of the play area is lost.
  235.  
  236. Making your own Level Sets.
  237.  
  238.      To make your own level sets open up your favourite text processor
  239.      and edit away!  Actually is fairly easy to do.  The built in
  240.      levels exist in a file called BOINKOUT.LVL, this will show you
  241.      how all the levels that you have played are put together.
  242.      I've also included another file called TEST.LVL, this is not
  243.      a recommended set.  But shows that you can load more than one
  244.      level set.
  245.  
  246.       Always check at http://www.netset.com/~baldrick/boinkout2.html for
  247.       new level sets.  If you have a level set you have created please
  248.       send it to me and I will make it available for other people.
  249.       Please Name the level set in the level set and include your name
  250.       and any other information you would like behind a #.  The Bumper
  251.       Level set has an example of how I did this.  You can feel free
  252.       to add more information to yours, just remember that these notes
  253.       must start with a '#'.
  254.  
  255.      All the rules for building your own levels exist in either of the
  256.      .LVL files.  They are fairly easy.  Levels have 63 blocks, 9 columns
  257.      by 7 rows.  The identifiers for the block types are in the files.
  258.      One big warning.  NO SPACES in the data area.  This will cause the 
  259.      file to be misinterpreted.
  260.      
  261.      NOTE:  There is a hard coded maximum of 99 levels that can be loaded
  262.      from a LVL file.
  263.  
  264. Trouble Shooting:
  265.  
  266. Hey sometimes my balls bounce off the bottom of the play area instead
  267. of being lost?
  268.  
  269.      You are the lucky recipient of the Magic Bottom!  Magic bottom
  270.      can be invoked by a magic block.  However sometimes the clipping does 
  271.      miss a ball and sends it bouncing back up.  Smile don't complain.
  272.  
  273. It takes forever to load images in TrueColor modes!
  274.  
  275.     If you think it is bad now then obviously you didn't ever play
  276.     an earlier version of BoinkOut2 in TrueColor.  It's possible that
  277.     the routines could be optimized more, however this is no longer
  278.     a priority for me.  If someone would like to patch this then let
  279.     me know.
  280.  
  281. My web browser doesn't go to the Boinkout page when started.
  282.  
  283.     Some Desktops clip the length of the command line.  This appears
  284. to be occuring with this routine.  Once the web browser is open another
  285. selection on the URL in the About dialog should take you to the
  286. correct page.
  287.  
  288. My images look odd!
  289.  
  290.     This can happen in a planar mode (2-256 colors).  The reason for
  291. this is that BoinkOut2 converts the images pallete to the system
  292. palette.  For some images this creates no noticeable problems, yet
  293. for others it creates quite marked differences (see normal back 
  294. drop image in a 16 color or less mode).
  295.  
  296.    You have a few options.
  297.    
  298.    1. Use a different image
  299.    2. Change your system palette
  300.    3. Don't worry about it.
  301.  
  302. Finals notes:
  303.  
  304.      I also owe alot of thanks to a lot of people for getting it to this state.
  305. All the people on my beta list (Charles Silver, Edward Baiz, David Leaver and
  306. Paul Williams to name a few (my memory is lapsing and I don't have enough time
  307. to log in and get the rest.  Please accept my apologies if I left you out) and
  308. SWE and kellis, both of whom did alot of real time testing for me via #atariscne
  309. on IRC.
  310.  
  311.      I especially need to thank Thothy (Thomas Huth), who has been working on 
  312. the PC-Gem side of this project.  He has helped work out a number of problems and
  313. kept this project from sitting on my back burner.  I've heard from Thothy that the
  314. PC-GEM port is dead.  Not that it shouldn't be compatible, just wasn't any interest
  315. in the program.  However we can all hope that he will still take a look at the Atari
  316. version from time to time and add patches.
  317.  
  318.     Thanks as well to "Marvin" Bressler who adapted BoinkOut2 to GCC,
  319. added a new magic effect and submitted several patches across the whole project.
  320. Including the new "magic" effect of Gravity.
  321.  
  322.      Thanks for the Gemscript support added by Matthias Jaap.
  323.  
  324.      I also owe alot of thanks (as we all do) to many other programmers over
  325. the years who have helped me out when I've gotten into hard spots.  I'd list
  326. you all, but then everyone would realize that I don't program anything I just
  327. recompile ;)
  328.  
  329.      Have fun and enjoy,
  330.  
  331.      Dan Ackerman
  332.      baldrick@netset.com
  333.      http://www.netset.com/~baldrick/