README

   1 Welcome to
   2
   3    R O C K S   ' N '   D I A M O N D S   ' 9 8
   4    -------------------------------------------
   5
   6 A game for Unix/X11 by Holger Schemel, (c) 1995-98 by Holger Schemel.
   7
   8 Introduction
   9 ============
  10 This is a nice little game with color graphics and sound for your
  11 Unix system with color X11. You need an 8-Bit color display or better.
  12 It will not work on black&white systems, and maybe not on gray scale systems.
  13
  14 If you know the game "Boulderdash" (Commodore C64) or "Emerald Mine"
  15 (Amiga), you know what "ROCKS'N'DIAMONDS" is about.
  16
  17
  18 Getting started
  19 ===============
  20 Just 'cd' to the directory 'rocksndiamonds-*' (Unix) or 'rocks-*' (DOS)
  21 and type 'rocksndiamonds' (Linux) or 'rocks' (DOS/Windows)!
  22 This works only on Linux and DOS systems, because the included binary was
  23 compiled for Linux (i386/libc5) (if you have the Unix package) and DOS
  24 (if you have the DOS/Windows package).
  25 If you have another Unix system like HPUX, NetBSD or SUN, you first have to
  26 type 'make' to compile it.
  27 This may be needed on Linux systems, too, depending on your kernel version,
  28 your libc version, your binary format, your processor, ...
  29
  30 (The included binary was compiled on the following system:
  31 AMD K6, kernel 2.0.35, libc5, gcc 2.7.2.1, ELF format)
  32
  33
  34 The Menues
  35 ==========
  36 You can see eight blue circles on the left side of the eight green menu
  37 texts; these are buttons to activate the menu commands by simply clicking
  38 on them with a mouse. The button will then change to red.
  39 (You can control the menues over the keyboard or joystick, too. Just use
  40 the arrow keys and the 'Return' or 'Enter' key or, if you use a joystick,
  41 the appropriate direction and the fire button.)
  42
  43 The menu 'name' / 'team'
  44 ------------------------
  45 When you start the game the first time, your login name will appear in
  46 the 'NAME:' field. If you want to use a different name for playing, for
  47 example a funny player name or a name for cheating, you can click on the
  48 button and enter a new name.
  49
  50 This menu will show the text 'team' instead of 'name' if you activated
  51 the team (local multiplayer) mode in the setup menu. See below.
  52
  53 The menue 'level'
  54 -----------------
  55 Choose any level from the current level series you want. The former
  56 'handicap' limitation in choosing levels has been removed because of
  57 beeing annoying.
  58
  59 If the level number is red, you have choosen a 'ready' level series (which
  60 is read-only and cannot be modified by the level editor); if it is yellow
  61 you have choosen a 'user' level series (which is writable and can be changed
  62 by the builf-in level editor). See below for using the level editor.
  63
  64 To choose new level series, click on the button on the left and choose
  65 the new level series. Scroll the page up and down with the blue arrow
  66 buttons if there are more level series than would fit on the screen.
  67
  68 Hall of fame
  69 ------------
  70 Click on this button to see a list of the best players of this level.
  71 Click again to go back to the main menu.
  72
  73 Level creator
  74 -------------
  75 This brings you to the level editor, if you have switched to a 'yellow'
  76 (writable) level series.
  77
  78 Info screen
  79 -----------
  80 This screen shows you all elements which appear in the game and presents
  81 you the background music loops which you can listen to while playing the
  82 levels (not available on all systems).
  83
  84 Start game
  85 ----------
  86 This will start the game. The game will be automatically recorded 'on tape'
  87 if you have choosen this from the setup menu (see below). If you haven't
  88 choosen auto-recording level, but want to record this certain game, press
  89 the 'record' button on the level tape recorder to start game and recording.
  90
  91 Setup
  92 -----
  93 To change some things in the game, use the setup menu.
  94 You can enable/disable "Sound" (enables/disables _all_ sounds in
  95 the game), "Sound loops" (only useful on Linux systems), "Game music"
  96 (can always be enabled on very fast systems [exception: you don't
  97 like it], on slower systems it will take some percent of CPU time
  98 which will slow things down a bit) and "Toons", which will forbid/
  99 permit the little animated toons.
 100
 101 Forget about the setup options "Buffered Gfx" and "Fading" -- they
 102 have no effect at the moment and will probably disappear in future
 103 versions of the game. (Double-buffering is now always activated, because
 104 systems are fast enough now compared to 1995, when the last version of the
 105 game was released. Especially soft-scrolling needs the double-buffering.
 106 About fading from one screen to another with silly effects: Most players
 107 will probably deactivate it after a few minutes (see also "quick doors").)
 108
 109 Enable "scroll delay" to avoid scrolling at each step, giving you an area
 110 where you can walk without scrolling until you get near enough to the screen
 111 border.
 112
 113 Enable "soft scroll" for soft-scrolling. Looks nice, but may need a
 114 relatively fast graphics card. Systems from 1998 and later should be fast
 115 enough for enabling soft-scrolling.
 116
 117 Enable "quick doors" if you are unpatient when switching between the
 118 several game screens where the doors have to be opened or closed. You will
 119 almost surely enable this if you design your own levels and therefore
 120 often switch between game and editor screens.
 121
 122 Set "auto-record" to "on" if you want to automatically record each game
 123 by the built-in level tape recorder.
 124
 125 For configuration of input devices like keyboard and joysticks, choose
 126 the sub-menu "input devices".
 127
 128 "Exit" quits the setup menu without saving the changes, "Save and exit"
 129 will save and then return to the main menu.
 130
 131
 132 Input Devices (sub-menu of the setup menu)
 133 ------------------------------------------
 134
 135 "Player" lets you choose one of the four players.
 136
 137 "Device" lets you choose the input device you want for this player;
 138 you can choose between the keyboard and one of the maximal four supported
 139 joysticks. (Normally you won't have more than two joysticks, but the Linux
 140 joystick driver supports more than two joysticks.)
 141
 142 "Customize" / "Calibrate" lets you calibrate a joystick or customize the
 143 keyboard keys used for moving left, right, up and down, "snapping" fields
 144 without moving towards them and placing bombs. Just press the key you want
 145 to use for the specified action or press Return or Enter to stay with the
 146 already configured values.
 147
 148 "Exit" brings you back to the setup screen.
 149
 150
 151 Quit
 152 ----
 153 Exit the game.
 154
 155
 156 How To Play The Game
 157 ====================
 158 When the game has started, you can see the playfield on the left side
 159 and a control field on the right side. The control field contains the
 160 following elements:
 161
 162 Level indicator         Tells you which level you are playing.
 163
 164 Emeralds                Shows you how many emeralds you still need
 165                         to win the current level.
 166
 167 Dynamite                Shows you how many dynamite bombs you have.
 168
 169 Keys                    Shows you which keys you have in your inventory.
 170
 171 Score                   Shows the current score. In some levels there
 172                         are some extra items giving extra score points.
 173
 174 Time                    The seconds you have still left to play the level.
 175
 176 Stop/Pause/Play         Game controls to stop the game, pause it and go on
 177                         playing. If the tape recorder is recording your
 178                         game, it is stopping/pausing/playing as well.
 179
 180 Music buttons           The three music buttons can be used to control the
 181                         background music loop, the 'looping' sounds and
 182                         all other sounds. The little red light shows you
 183                         if it is enabled or disabled.
 184
 185 About the game itself: Of course you know Boulderdash, so you will know
 186 how to play the game. :)
 187 If not: You can move your playing figure with the configured keys (which
 188 will normally and by default be the arrow keys) or with a joystick.
 189 To 'snap' a field near you without moving to it, you
 190 can use the left fire button on your joystick (hold it down, move the
 191 stick to 'snap' the field, release the button) or the key you have
 192 configured for this action (by default one of the left modifier keys like
 193 'Shift' or 'Control').
 194 To place a piece of dynamite, use the right fire button on your joystick or
 195 use the key you have configured for this (by default one of the right modifier
 196 keys, but you can change all this to what you like).
 197 After placing the dynamite, better see to move away from this field...).
 198
 199 Just try the levels from the 'tutorial' level serie to see what most
 200 of the elements do or have a look at the info screen!
 201
 202
 203 The Level Editor
 204 ================
 205 To create your own levels, it's a good idea to start with your personal
 206 level series, which has been created automatically the first time you
 207 started the game (together with some configuration files). These personal
 208 files are stored in '~/.rocksndiamonds' on Unix systems and in 'userdata'
 209 in the current playing directory (which normally is the game directory)
 210 on DOS/Windows systems.
 211
 212 The levels that come with the game are normally read-only, to avoid
 213 problems on multi user systems, but you can set them to 'writable' in
 214 the file 'levelinfo.conf' ('lvlinfo.cnf' on DOS systems) in each level
 215 directory.
 216
 217 To edit a level, you can use all three mouse buttons to draw in the
 218 level window. Click into the elements field with one of the three buttons
 219 to remap it to the new element. Use the arrow widgets to scroll around in
 220 the level. Use the 'flood fill' field to init exactly ony flood fill
 221 operation in the level field (you will be prompted). Click on 'control
 222 window' to switch to the control window.
 223
 224 In the control window you can modify different parameters like the size
 225 of the level playfield, the name of the level, the scores for different
 226 elements and something like that. The four 3x3 field on the upper left
 227 can be edited like the level field and indicate the 'contents' of smashed
 228 crunchers (just try it out with some crunchers in one of your own levels).
 229
 230 'Undo & Exit' leaves the level editor, throwing away all the changes you
 231 have done to the level.
 232 'Save & Exit' leveas the level editor and saves the new level (the old one
 233 will be deleted).
 234
 235
 236 The Tape Recorder
 237 =================
 238 You can use the tape recorder to record games and play tapes of previously
 239 played games. Just use them like a normal video recorder.
 240
 241 Recording a game on tape:
 242 -------------------------
 243 If you have enabled "auto-record", every game will automatically be recorded,
 244 so you just have to press "start game". Pressing the 'record' button on the
 245 tape recorder will start game and record it in any case.
 246
 247 Saving a game tape:
 248 -------------------
 249 To save a tape to the tape file corresponding to the level (that means
 250 that you can only save one tape file for each level), just press the
 251 'eject' button (the very left button). Then you will be prompted if
 252 you really want to replace the old tape (if an old tape exists).
 253
 254 Playing a tape:
 255 ---------------
 256 Just press 'play' and then either 'play' or 'pause'.
 257
 258 While recording or playing, you can press 'pause' to stop the recording
 259 or the playing of the tape and continue by pressing 'pause' again.
 260 You can use either the tape recorder buttons or the game control buttons
 261 for this purpose.
 262
 263 If you want to continue a previously recorded game, press 'pause' while
 264 playing, then 'record' to switch from 'paused playing' to 'paused recording'
 265 and then continue the game by pressing 'record' or 'pause'. If you want
 266 to fast-forward the tape to get faster to the point where you want to
 267 continue playing, press 'play' again while already playing, therefore
 268 activating 'fast forward' playing mode. Press again the 'play' button
 269 to enter a special playing mode: 'pause before end' will stop a few seconds
 270 before the end of the tape (which will in most cases stop a few seconds
 271 before you get killed in the previous playing recorded on that tape) --
 272 after the automatic stop (which enters the 'pause' mode) you can continue
 273 the game as described above.
 274
 275
 276 And Now Have Fun!
 277 =================
 278 Have fun playing the game, building new levels and breaking all high
 279 scores! :-)
 280
 281 If you have designed new levels, mail them to me to include them in the
 282 next version (which will be released much earlier than again after three
 283 years like this version... ;-)
 284
 285 If you have any comments, problems, suggestions, donations, flames,
 286 send them to
 287
 288         aeglos@valinor.owl.de
 289
 290 or Snail Mail to
 291
 292         Holger Schemel
 293         Oststrasse 11a
 294         33604 Bielefeld
 295         GERMANY
 296
 297 Have fun,
 298                 Holger