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