~neon/kdegames/trunk

« back to all changes in this revision

Viewing changes to doc/kbounce/index.docbook

  • Committer: aacid
  • Date: 2012-08-18 14:19:55 UTC
  • Revision ID: svn-v4:283d02a7-25f6-0310-bc7c-ecb5cbfe19da:trunk/KDE/kdegames:1311445
move the doc folders inside of each of the apps, will ease git migration

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<?xml version="1.0" ?>
2
 
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
3
 
  <!ENTITY kappname "&kbounce;">
4
 
  <!ENTITY kappversion "0.11"><!--Applicaion version. Use this variable everywhere it's needed.-->
5
 
  <!ENTITY package "kdegames">
6
 
  <!ENTITY % English "INCLUDE" > 
7
 
  <!ENTITY % addindex "IGNORE">
8
 
]>
9
 
 
10
 
<book lang="&language;">
11
 
<bookinfo>
12
 
<title>The &kbounce; Handbook</title>
13
 
 
14
 
<authorgroup>
15
 
<author>
16
 
<firstname>Tomasz</firstname><surname>Boczkowski</surname>
17
 
<affiliation><address><email>tboczkowski@onet.pl</email></address></affiliation>
18
 
</author>
19
 
<othercredit role="reviewer">
20
 
<firstname>Eugene</firstname><surname>Trounev</surname>
21
 
<contrib>Reviewer</contrib>
22
 
<affiliation><address>eugene.trounev@gmail.com</address></affiliation>
23
 
</othercredit>
24
 
<!-- TRANS:ROLES_OF_TRANSLATORS -->
25
 
</authorgroup>
26
 
 
27
 
<copyright>
28
 
<year>2002</year>
29
 
<holder>&Aaron.J.Seigo;</holder>
30
 
</copyright>
31
 
 
32
 
<copyright>
33
 
<year>2007</year>
34
 
<holder>Tomasz Boczkowski</holder>
35
 
</copyright>
36
 
 
37
 
<legalnotice>&FDLNotice;</legalnotice>
38
 
 
39
 
 
40
 
<date>2012-08-06</date><!-- Date of (re)writing, or update.-->
41
 
<releaseinfo>&kappversion; (&kde; 4.9)</releaseinfo><!-- Application version number. Use the variable definitions within header to change this value.-->
42
 
 
43
 
<abstract>
44
 
        <para>This documentation describes the game of &kbounce; version &kappversion;</para>
45
 
</abstract>
46
 
 
47
 
 
48
 
<keywordset>
49
 
        <keyword>KDE</keyword> <!-- do not change this! -->
50
 
        <keyword>kdegames</keyword> <!-- do not change this! -->
51
 
        <keyword>game</keyword> <!-- do not change this! -->
52
 
<!-- Game genre. Use as many as necessary. Available game types are: Arcade, Board, Card, Dice, Toys, Logic, Strategy.-->
53
 
        <keyword>arcade</keyword>
54
 
        <keyword>puzzle</keyword>
55
 
        <keyword>balls</keyword>
56
 
        <keyword>jezzball</keyword>
57
 
        <keyword>KBounce</keyword>
58
 
</keywordset>
59
 
 
60
 
</bookinfo>
61
 
 
62
 
<chapter id="introduction">
63
 
<title>Introduction</title>
64
 
<note><title>Gametype:</title><para>Puzzle, Arcade</para></note><!-- Game genre. Use as many as necessary. Available game types are: Arcade, Board, Card, Dice, Toys, Logic, Strategy.-->
65
 
        <note><title>Number of possible players:</title><para>One</para></note><!--Number of possible players. It can be: One, Two,..., Multiplayer-->
66
 
<para>
67
 
&kbounce; is a single player arcade game with the elements of puzzle.
68
 
</para>
69
 
 
70
 
<para>
71
 
It is played on a field, surrounded by walls, with two or more balls that move about in the field bouncing off of walls. The player can build new walls, decreasing the size of the active field.
72
 
</para>
73
 
 
74
 
<para>
75
 
The goal of the game is to fill at least 75&percnt; of the field and advance to the next level.
76
 
</para>
77
 
</chapter>
78
 
 
79
 
<chapter id="how-to-play">
80
 
<title>How To Play</title>
81
 
 
82
 
<para>
83
 
The player is presented a rectangular tiled field surrounded by walls. Two or more balls move about in the field and bounce off of the walls. The object of the game is to limit the size of room for the balls.
84
 
</para>
85
 
 
86
 
<para>
87
 
The size of the active area of the field is decreased by making new walls that enclose areas without balls in them.  To complete a level, the player must decrease the size of the active field by at least 75&percnt; within the time allowed.
88
 
</para>
89
 
 
90
 
<para>
91
 
New walls are built by clicking the &LMB; in an active area of the field, at which point two walls will begin to grow in opposite directions from the square the mouse was clicked in.  Only one wall in each direction may be growing on the screen at any given time.
92
 
</para>
93
 
 
94
 
<para>
95
 
When the mouse is on the field, the cursor is shown as a pair of arrows pointing in opposite directions, either horizontally or vertically.  The arrows point in the direction the walls will grow when the &LMB; is clicked.  This direction can be changed by clicking the &RMB;.
96
 
</para>
97
 
 
98
 
<para>
99
 
A new wall has a <quote>head</quote> which moves away from the point where the mouse was clicked.  A wall is not permanent until this <quote>head</quote> runs into another wall.  If a ball collides with any part of the wall except the head, before the head has run into another wall, the new wall will disappear completely and one life will be lost.  If a ball collides with the head in the direction of the wall's growth, the wall will stop growing there, and become permanent, with no loss of life.  If a ball collides with the head from any other side, the ball will bounce off and the wall will continue to grow normally.
100
 
</para>
101
 
</chapter>
102
 
 
103
 
<chapter id="rules_and_tips"><title>Game Rules, Strategies and Tips</title> <!-- do not change this! -->
104
 
<sect1 id="rules">
105
 
<title>Game Rules</title>
106
 
 
107
 
<para>
108
 
The game starts with level 1 in which two balls move around in the
109
 
field. The player has two lifes and 90 seconds to successfully complete
110
 
the level.
111
 
</para>
112
 
 
113
 
<para>
114
 
In n-th level there are n + 1 balls. The player is given n + 1 lives. They
115
 
have 30 * ( n + 2 ) seconds to complete it.
116
 
</para>
117
 
 
118
 
<para>
119
 
When a ball collides with a growing wall the player looses one life.
120
 
An exception is the collision with wall's <quote>head</quote> when
121
 
no life is lost.
122
 
</para>
123
 
 
124
 
<para>
125
 
The goal of each level is to cover at least 75&percnt; of the field
126
 
with wall.  
127
 
</para>
128
 
 
129
 
<para>
130
 
The loss of all lives and exceeding the time allowed result in the
131
 
end of the game.
132
 
</para>
133
 
 
134
 
<para>
135
 
If a player completes a level he receives 15 points for each life left,
136
 
 and a bonus depending on the number of balls and the number of tiles filled
137
 
above 75&percnt;. They also advance to the next level.
138
 
</para>
139
 
 
140
 
</sect1>
141
 
 
142
 
<sect1 id="strategy">
143
 
<title>Strategies and Tips</title>
144
 
<itemizedlist>
145
 
 
146
 
<listitem>
147
 
<para>
148
 
Many players find the game becomes quite difficult by only the
149
 
third or fourth level, given the number of balls on the field at
150
 
once.
151
 
</para>
152
 
</listitem>
153
 
 
154
 
<listitem>
155
 
<para>
156
 
The trick playing &kbounce; successfully is to build
157
 
<quote>corridors</quote>.  To build a corridor, start a pair of walls
158
 
growing close to another wall, and time it so that one of the walls
159
 
will be hit by a ball and one of the walls will not, and thus become
160
 
permanent.
161
 
</para>
162
 
 
163
 
<screenshot>
164
 
<screeninfo>Building a corridor</screeninfo>
165
 
<mediaobject>
166
 
<imageobject>
167
 
<imagedata fileref="kbounce_corridor1.png" format="PNG"/>
168
 
</imageobject>
169
 
<textobject>
170
 
<phrase>Building a corridor</phrase>
171
 
</textobject>
172
 
</mediaobject>
173
 
</screenshot>
174
 
 
175
 
<para>
176
 
This will leave a narrow corridor only a few squares high on the
177
 
field, surrounded on three sides by walls.  Wait for the balls to
178
 
bounce into the open end of the corridor, and close the corridor
179
 
behind the ball with a new wall.  Although you will most likely lose a
180
 
life for each corridor created, you can trap several balls in a single
181
 
corridor.
182
 
</para>
183
 
 
184
 
<screenshot>
185
 
<screeninfo>Capturing balls in a corridor</screeninfo>
186
 
<mediaobject>
187
 
<imageobject>
188
 
<imagedata fileref="kbounce_corridor2.png" format="PNG"/>
189
 
</imageobject>
190
 
<textobject>
191
 
<phrase>Capturing balls in a corridor</phrase>
192
 
</textobject>
193
 
</mediaobject>
194
 
</screenshot>
195
 
</listitem>
196
 
 
197
 
<listitem>
198
 
<para>
199
 
A final tip &mdash; take your time!  There is plenty of time, as
200
 
shown in the <guilabel>Time</guilabel> display at the bottom 
201
 
of the screen.  Rushing will just get you in trouble!
202
 
</para>
203
 
</listitem>
204
 
</itemizedlist>
205
 
</sect1>
206
 
</chapter>
207
 
 
208
 
<chapter id="interface-overview">
209
 
<title>Interface Overview</title>
210
 
 
211
 
<sect1 id="the-tool-bar">
212
 
<title>The Tool Bar</title>
213
 
 
214
 
<mediaobject>
215
 
<imageobject>
216
 
<imagedata format="PNG" fileref="toolbar.png"/>
217
 
</imageobject>
218
 
<textobject><phrase>Toolbar</phrase></textobject>
219
 
</mediaobject>
220
 
 
221
 
<para>
222
 
The toolbar provides buttons for the commonly used functions.
223
 
</para>
224
 
 
225
 
<table>
226
 
<title>Toolbar Buttons</title>
227
 
<tgroup cols="4">
228
 
 
229
 
<thead>
230
 
<row>
231
 
<entry>Button</entry>
232
 
<entry>Name</entry>
233
 
<entry>Menu Equivalent</entry>
234
 
<entry>Action</entry>
235
 
</row>
236
 
</thead>
237
 
 
238
 
<tbody>
239
 
<row>
240
 
<entry>
241
 
<inlinemediaobject>
242
 
<imageobject>
243
 
<imagedata format="PNG" fileref="button-new.png"/>
244
 
</imageobject>
245
 
<textobject><phrase>New Game Button</phrase></textobject>
246
 
</inlinemediaobject>
247
 
</entry>
248
 
 
249
 
<entry>
250
 
<guiicon>New</guiicon>
251
 
</entry>
252
 
 
253
 
<entry>
254
 
<link linkend="game-new">
255
 
<menuchoice>
256
 
<guimenu>Game</guimenu> <guimenuitem>New</guimenuitem>
257
 
</menuchoice>
258
 
</link>
259
 
</entry>
260
 
 
261
 
<entry>
262
 
Starts a new game. If a game is currently played clears the field
263
 
and sets the level to 1.
264
 
</entry>
265
 
</row>
266
 
 
267
 
<row>
268
 
<entry>
269
 
<inlinemediaobject>
270
 
<imageobject>
271
 
<imagedata format="PNG" fileref="button-pause.png"/>
272
 
</imageobject>
273
 
<textobject>
274
 
<phrase>Pause Button</phrase></textobject>
275
 
</inlinemediaobject>
276
 
</entry>
277
 
 
278
 
<entry>
279
 
<guiicon>Pause</guiicon>
280
 
</entry>
281
 
 
282
 
<entry>
283
 
<link linkend="game-pause">
284
 
<menuchoice>
285
 
<guimenu>Game</guimenu> <guimenuitem>Pause</guimenuitem></menuchoice>
286
 
</link>
287
 
</entry>
288
 
 
289
 
<entry>
290
 
Pauses or resumes the current game.
291
 
</entry>
292
 
</row>
293
 
</tbody>
294
 
</tgroup>
295
 
</table>
296
 
</sect1>
297
 
 
298
 
<sect1 id="the-menu-items">
299
 
<title>The Menu Items</title>
300
 
 
301
 
<sect2>
302
 
<title>The <guimenu>Game</guimenu> Menu</title>
303
 
 
304
 
<mediaobject>
305
 
<imageobject>
306
 
<imagedata format="PNG" fileref="menu-game.png"/>
307
 
</imageobject>
308
 
<textobject>
309
 
<phrase><guimenu>Game</guimenu> Menu</phrase></textobject>
310
 
</mediaobject>
311
 
 
312
 
<variablelist>
313
 
<varlistentry id="game-new">
314
 
<term>
315
 
<menuchoice><shortcut>
316
 
<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>
317
 
</shortcut>
318
 
<guimenu>Game</guimenu>
319
 
<guimenuitem>New</guimenuitem>
320
 
</menuchoice></term>
321
 
<listitem>
322
 
<para><action>Starts a new game.</action></para>
323
 
</listitem>
324
 
</varlistentry>
325
 
 
326
 
<varlistentry id="game-end">
327
 
<term>
328
 
<menuchoice><shortcut>
329
 
<keycombo action="simul">&Ctrl;<keycap>End</keycap>
330
 
</keycombo>
331
 
</shortcut>
332
 
<guimenu>Game</guimenu>
333
 
<guimenuitem>End Game</guimenuitem>
334
 
</menuchoice></term>
335
 
<listitem>
336
 
<para><action>Ends the current game.</action></para>
337
 
</listitem>
338
 
</varlistentry>
339
 
 
340
 
<varlistentry id="game-pause">
341
 
<term>
342
 
<menuchoice><shortcut>
343
 
<keycap>P</keycap></shortcut>
344
 
<guimenu>Game</guimenu>
345
 
<guimenuitem>Pause</guimenuitem>
346
 
</menuchoice></term>
347
 
<listitem>
348
 
<para><action>Pauses or resumes the game.</action></para>
349
 
</listitem>
350
 
</varlistentry>
351
 
 
352
 
<varlistentry id="game-highscores">
353
 
<term>
354
 
<menuchoice><shortcut>
355
 
<keycombo action="simul">&Ctrl;<keycap>H</keycap></keycombo>
356
 
</shortcut>
357
 
<guimenu>Game</guimenu>
358
 
<guimenuitem>Show High Scores</guimenuitem>
359
 
</menuchoice></term>
360
 
<listitem>
361
 
<para>
362
 
Opens a dialog that displays different high score tables. 
363
 
</para>
364
 
</listitem>
365
 
</varlistentry>
366
 
 
367
 
<varlistentry id="game-quit">
368
 
<term><menuchoice><shortcut>
369
 
<keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
370
 
</shortcut>
371
 
<guimenu>Game</guimenu>
372
 
<guimenuitem>Quit</guimenuitem>
373
 
</menuchoice></term>
374
 
<listitem>
375
 
<para><action>Quit</action> and close &kbounce;.
376
 
If a game is currently played, it's status is lost</para>
377
 
</listitem>
378
 
</varlistentry>
379
 
</variablelist>
380
 
</sect2>
381
 
 
382
 
<sect2 id="settings-menu">
383
 
<title>The <guimenu>Settings</guimenu> Menu</title>
384
 
 
385
 
<mediaobject>
386
 
<imageobject>
387
 
<imagedata format="PNG" fileref="menu-settings.png"/>
388
 
</imageobject>
389
 
<textobject>
390
 
<phrase>Settings Menu</phrase></textobject>
391
 
</mediaobject>
392
 
 
393
 
<variablelist>
394
 
 
395
 
<varlistentry id="settings-toolbar">
396
 
<term><menuchoice>
397
 
<guimenu>Settings</guimenu>
398
 
<guimenuitem>Show Toolbar</guimenuitem>
399
 
</menuchoice></term>
400
 
<listitem>
401
 
<para><action>Shows/hides the &kbounce; toolbar.</action></para>
402
 
</listitem>
403
 
</varlistentry>
404
 
 
405
 
<varlistentry id="settings-statusbar">
406
 
<term><menuchoice>
407
 
<guimenu>Settings</guimenu>
408
 
<guimenuitem>Show Statusbar</guimenuitem>
409
 
</menuchoice></term>
410
 
<listitem>
411
 
<para><action>Shows/hides the &kbounce; statusbar.</action></para>
412
 
</listitem>
413
 
</varlistentry>
414
 
 
415
 
<varlistentry id="settings-sounds">
416
 
<term><menuchoice>
417
 
<guimenu>Settings</guimenu>
418
 
<guimenuitem>Play Sounds</guimenuitem>
419
 
</menuchoice></term>
420
 
<listitem>
421
 
<para><action>If checked, &kbounce; game sounds are played.</action></para>
422
 
</listitem>
423
 
</varlistentry>
424
 
 
425
 
<varlistentry>
426
 
<term><menuchoice>
427
 
<guimenu>Settings</guimenu>
428
 
<guimenuitem>Configure Shortcuts...</guimenuitem>
429
 
</menuchoice></term>
430
 
<listitem>
431
 
<para><action>Opens a standard &kde; shortcut configuration dialog, in which
432
 
you can change the keyboard shortcuts used by &kbounce;.</action></para>
433
 
</listitem>
434
 
</varlistentry>
435
 
 
436
 
<varlistentry>
437
 
<term><menuchoice>
438
 
<guimenu>Settings</guimenu>
439
 
<guimenuitem>Configure Toolbars...</guimenuitem>
440
 
</menuchoice></term>
441
 
<listitem>
442
 
<para><action>Opens the standard &kde; toolbar configuration dialog to customize the &kbounce; toolbar.</action></para>
443
 
</listitem>
444
 
</varlistentry>
445
 
 
446
 
<varlistentry>
447
 
<term><menuchoice>
448
 
<guimenu>Settings</guimenu>
449
 
<guimenuitem>Configure &kbounce;...</guimenuitem>
450
 
</menuchoice></term>
451
 
<listitem>
452
 
<para><action>Opens a dialog to customize the game. It allows to
453
 
select themes.</action></para>
454
 
</listitem>
455
 
</varlistentry>
456
 
 
457
 
</variablelist>
458
 
</sect2>
459
 
 
460
 
 
461
 
<sect2 id="help-menu">
462
 
<title>The <guimenu>Help</guimenu> Menu</title>
463
 
<mediaobject>
464
 
<imageobject>
465
 
<imagedata format="PNG" fileref="menu-help.png"/>
466
 
</imageobject>
467
 
<textobject>
468
 
<phrase>Help Menu</phrase></textobject>
469
 
</mediaobject>
470
 
 
471
 
&help.menu.documentation;
472
 
 
473
 
</sect2>
474
 
</sect1>
475
 
</chapter>
476
 
 
477
 
<chapter id="faq"><title>Frequently asked questions</title> <!-- do not change this! -->
478
 
<!--This chapter is for frequently asked questions. Please use <qandaset> <qandaentry> only!-->
479
 
<qandaset>
480
 
<!--Following is a standard list of FAQ questions.-->
481
 
<qandaentry>
482
 
 <question><para>I want to change the way this game looks. Can I? </para></question>
483
 
 <answer><para>Yes. To change &kbounce; visual theme you can use <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure &kbounce;...</guimenuitem></menuchoice> option on the menubar.</para></answer>
484
 
</qandaentry>
485
 
<qandaentry>
486
 
 <question><para>I have made a mistake. Can I undo? </para></question>
487
 
 <answer><para>&kbounce; does not have an <quote>Undo</quote> feature.</para></answer>
488
 
</qandaentry>
489
 
<qandaentry>
490
 
 <question><para>Can I use the keyboard to play this game?</para></question>
491
 
 <answer><para>No. &kbounce; cannot be played using keyboard.</para></answer>
492
 
</qandaentry>
493
 
<qandaentry>
494
 
 <question><para>I have to quit the game now, but I am not finished yet. Can I save my progress?</para></question>
495
 
  <answer><para>&kbounce; does not have a <quote>Save</quote> feature at the moment.</para></answer>
496
 
</qandaentry>
497
 
</qandaset>
498
 
</chapter>
499
 
 
500
 
<chapter id="configuration"><title>Game Configuration</title> <!-- do not change this! -->
501
 
  <para>The &kbounce; configuration dialog allows you to select visual themes for &kbounce;.</para>
502
 
                <para>
503
 
                        To select a new theme simply choose the theme from
504
 
                        the selection list. Each item in the list shows a small
505
 
                        preview left to the theme name. A selection is immediately applied.
506
 
                </para>
507
 
                <para>
508
 
                        Once you are satisfied with the theme you have selected you
509
 
                        can click the <guibutton>Close</guibutton>
510
 
                        button, located at the bottom part of this dialog.
511
 
                </para>
512
 
</chapter>
513
 
 
514
 
<chapter id="credits-and-licenses">
515
 
<title>Credits and Licenses</title>
516
 
 
517
 
 
518
 
<para>&kbounce;</para>
519
 
 
520
 
<itemizedlist>
521
 
<listitem>
522
 
<para>Stefan Schimanski <email>schimmi@kde.org</email> -
523
 
Original Author</para>
524
 
</listitem>
525
 
<listitem>
526
 
<para>Sandro Sigala <email>ssigala@globalnet.it</email> -
527
 
Highscore</para>
528
 
</listitem>
529
 
<listitem>
530
 
<para>Benjamin Meyer <email>ben+kbounce@meyerhome.net</email> - 
531
 
Contributions</para>
532
 
</listitem>
533
 
<listitem>
534
 
<para>Dmitry Suzdalev <email>dimsuz@gmail.com</email></para>
535
 
</listitem>
536
 
<listitem>
537
 
<para>Tomasz Boczkowski <email>tboczkowski@onet.pl</email> - 
538
 
Port to KDE4 and KGameCavas</para>
539
 
</listitem>
540
 
</itemizedlist>
541
 
 
542
 
<para>Documentation copyright 2002, &Aaron.J.Seigo;
543
 
&Aaron.J.Seigo.mail;</para>
544
 
<para>Documentation copyright 2007, Tomasz Boczkowski
545
 
<email>tboczkowski@onet.pl</email></para>
546
 
 
547
 
<para>This handbook is dedicated to Dennis E. Powell.</para>
548
 
 
549
 
<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
550
 
 
551
 
&underFDL;
552
 
 
553
 
&underGPL;
554
 
 
555
 
</chapter>
556
 
 
557
 
<appendix id="installation">
558
 
<title>Installation</title>
559
 
 
560
 
&install.intro.documentation;
561
 
 
562
 
&install.compile.documentation;
563
 
 
564
 
</appendix>
565
 
 
566
 
&documentation.index; 
567
 
</book>
568
 
<!--
569
 
Local Variables:
570
 
mode: sgml
571
 
sgml-minimize-attributes: nil
572
 
sgml-general-insert-case: lower
573
 
End:
574
 
-->
575