Debian Codegraph @

doc/index.docbook

raw
1 <?xml version="1.0" ?>
2 <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
3 <!ENTITY % English "INCLUDE">
4 <!ENTITY % addindex "IGNORE">
5 ]>
6
7 <book id="kbreakout" lang="&language;">
8 <bookinfo>
9 <title>The &kbreakout; Handbook</title>
10
11 <authorgroup>
12 <author>
13 <firstname>Fela</firstname>
14 <surname>Winkelmolen</surname>
15 <affiliation>
16 <address><email>[email protected]</email></address></affiliation>
17 </author>
18
19 <author>
20 <firstname>Stephanie</firstname>
21 <surname>Whiting</surname>
22 <affiliation>
23 <address><email>[email protected]</email></address></affiliation>
24 </author>
25 <!-- TRANS:ROLES_OF_TRANSLATORS -->
26 </authorgroup>
27
28 <copyright>
29 <year>2008</year>
30 <holder>Fela Winkelmolen</holder>
31 </copyright>
32
33 <legalnotice>&FDLNotice;</legalnotice>
34
35 <date>2021-06-25</date>
36 <releaseinfo>KDE Gear 21.04</releaseinfo>
37
38 <abstract>
39 <para>
40 &kbreakout;, a Breakout-like game.</para>
41 </abstract>
42
43 <keywordset>
44 <keyword>KDE</keyword>
45 <keyword>kdegames</keyword>
46 <keyword>game</keyword>
47 <keyword>KBreakOut</keyword>
48 <keyword>Breakout</keyword>
49 <keyword>brick</keyword>
50 <keyword>bricks</keyword>
51 <keyword>ball</keyword>
52 </keywordset>
53 </bookinfo>
54
55 <chapter id="introduction">
56 <title>Introduction</title>
57
58 <para>
59 &kbreakout; is a Breakout-like game.
60 </para>
61
62 <screenshot>
63 <mediaobject>
64 <imageobject>
65 <imagedata fileref="gameboard.png" format="PNG"/>
66 </imageobject>
67 <textobject>
68 <phrase>&kbreakout; gameboard</phrase>
69 </textobject>
70 </mediaobject>
71 </screenshot>
72
73 <para>
74 The object of the game is to destroy as many bricks as possible without losing the ball.
75 </para>
76 </chapter>
77
78 <chapter id="how-to-play">
79 <title>How to Play</title>
80
81 <para>
82 The player is presented with a game field containing a number of bricks. A ball travels across the screen, bouncing off the top and side walls. When a brick is hit, the ball bounces away and the brick is destroyed. The player loses a life when the ball touches the bottom of the field. To prevent this from happening, the player has to use a movable bar to bounce the ball upward, situated at the bottom of the window. The purpose of the game is to progress through the levels destroying all bricks present in each, and trying to get a highscore.
83 </para>
84
85 <para>
86 Some bricks have a special behavior, or may let a gift fall down when hit. The gifts can be caught with the bar, their behavior can be either positive or negative. For further information on the different types of bricks and gifts see the next chapter.
87 </para>
88
89 <para>
90 To fire the ball press the spacebar, to move the bar use the mouse or the arrow keys. The ball will bounce in the direction of the side of the bar it bounced on hit, the more it bounces near the left end of the bar the more it will bounce toward the left, the same applies for the right side; if it bounces in the middle of the bar it will bounce straight toward the top.
91 </para>
92
93 <para>
94 If you enable the option <guilabel>Fire on mouse click</guilabel> in the settings dialog, you can click with the &LMB; to fire.
95 Enabling the option will make the game steal the mouse cursor, pause the game to get the cursor back.
96 </para>
97
98 </chapter>
99
100 <chapter id="rules-strategies-tips">
101 <title>Game Rules, Strategies and Tips</title>
102
103 <sect1 id="rules">
104 <title>Rules</title>
105 <itemizedlist>
106 <listitem><para>Passing a level awards 300 points to the player. A level is passed when all breakable and visible bricks are destroyed, or alternatively if the next level gift is caught. In the latter case an additional score for each remaining brick is awarded.</para></listitem>
107 <listitem><para>A score is awarded for every brick destroyed, the smaller the interval between one hit and the following the higher this score.</para></listitem>
108 <listitem><para>The gifts hidden in a given level are fixed, their position however is random.</para></listitem>
109 <listitem><para>30 points are awarded for every gift caught.</para></listitem>
110 <listitem><para>The player loses a life when the ball touches the bottom of the field and there are no other balls left in the game, or when the player catches a lose life gift. When losing a life, 1000 points are detracted from his score.</para></listitem>
111 <listitem><para>Additional lives can be gained by catching the add life gifts.</para></listitem>
112 <listitem><para>The game ends when the player loses the ball while not having any additional lives left, or when all levels have been won.</para></listitem>
113 </itemizedlist>
114 </sect1>
115
116 <sect1 id="brick-types">
117 <title>Brick Types</title>
118 <note>
119 <para>
120 Pictures for the bricks below are for the default theme of &kbreakout;.
121 </para>
122 </note>
123 <variablelist>
124 <varlistentry>
125 <term>
126 <inlinemediaobject>
127 <imageobject>
128 <imagedata fileref="PlainBrick1.png" format="PNG" />
129 </imageobject>
130 <textobject>
131 <phrase>
132 Plain Brick
133 </phrase>
134 </textobject>
135 </inlinemediaobject>
136 Plain Bricks
137 </term>
138 <listitem>
139 <para>
140 Simple bricks, while their appearance may vary they all behave the same way, they get destroyed when hit by the ball and may contain a gift.
141 </para>
142 </listitem>
143 </varlistentry>
144 <varlistentry>
145 <term>
146 <inlinemediaobject>
147 <imageobject>
148 <imagedata fileref="UnbreakableBrick.png" format="PNG" />
149 </imageobject>
150 <textobject>
151 <phrase>
152 Unbreakable Brick
153 </phrase>
154 </textobject>
155 </inlinemediaobject>
156 Unbreakable Brick
157 </term>
158 <listitem>
159 <para>
160 Never gets destroyed unless hit by a burning or unstoppable ball, or an exploding brick next to it gets hit. These bricks do not need to be destroyed to win the level.
161 </para>
162 </listitem>
163 </varlistentry>
164 <varlistentry>
165 <term>
166 <inlinemediaobject>
167 <imageobject>
168 <imagedata fileref="BreakableBrick.png" format="PNG" />
169 </imageobject>
170 <textobject>
171 <phrase>
172 Breakable Brick
173 </phrase>
174 </textobject>
175 </inlinemediaobject>
176 Breakable Brick
177 </term>
178 <listitem>
179 <para>
180 Unbreakable bricks can be turned into breakable bricks using <link linkend="gift-magic-wand">Magic Wand gift</link>.
181 </para>
182 </listitem>
183 </varlistentry>
184 <varlistentry>
185 <term>
186 <inlinemediaobject>
187 <imageobject>
188 <imagedata fileref="HiddenBrick.png" format="PNG" />
189 </imageobject>
190 <textobject>
191 <phrase>
192 Hidden Brick
193 </phrase>
194 </textobject>
195 </inlinemediaobject>
196 Hidden Brick
197 </term>
198 <listitem>
199 <para>
200 This brick is not initially shown to the player. When hit for the first time it becomes visible, and becomes a plain brick. If hit by a burning ball, or an exploding brick next to it gets hit it gets destroyed as soon as it appears. As long as it remains hidden it does not need to be destroyed to get to the next level.
201 </para>
202 </listitem>
203 </varlistentry>
204 <varlistentry>
205 <term>
206 <inlinemediaobject>
207 <imageobject>
208 <imagedata fileref="MultipleBrick3.png" format="PNG" />
209 </imageobject>
210 <textobject>
211 <phrase>
212 Multiple Brick
213 </phrase>
214 </textobject>
215 </inlinemediaobject>
216 Multiple Brick
217 </term>
218 <listitem>
219 <para>
220 Needs to be hit three times before getting destroyed, unless hit by a burning or unstoppable ball, or an exploding brick next to it gets destroyed.
221 </para>
222 </listitem>
223 </varlistentry>
224 <varlistentry>
225 <term>
226 <inlinemediaobject>
227 <imageobject>
228 <imagedata fileref="ExplodingBrick.png" format="PNG" />
229 </imageobject>
230 <textobject>
231 <phrase>
232 Exploding Brick
233 </phrase>
234 </textobject>
235 </inlinemediaobject>
236 Exploding Brick
237 </term>
238 <listitem>
239 <para>
240 When this brick gets hit also the bricks to the top, bottom, left and right of it will get destroyed, regardless of their type.
241 </para>
242 </listitem>
243 </varlistentry>
244 </variablelist>
245 </sect1>
246
247 <sect1 id="gifts">
248 <title>Gifts</title>
249 <note>
250 <para>
251 Pictures for the gifts below are for the default theme of &kbreakout;.
252 </para>
253 </note>
254 <variablelist>
255 <varlistentry>
256 <term>
257 <inlinemediaobject>
258 <imageobject>
259 <imagedata fileref="Gift1000Points.png" format="PNG" />
260 </imageobject>
261 <textobject>
262 <phrase>
263 Gift 1000 Points
264 </phrase>
265 </textobject>
266 </inlinemediaobject>
267 Score Gifts
268 </term>
269 <listitem>
270 <para>
271 If caught they award the player the number of points written on the gift.
272 </para>
273 </listitem>
274 </varlistentry>
275 <varlistentry>
276 <term>
277 <inlinemediaobject>
278 <imageobject>
279 <imagedata fileref="GiftAddLife.png" format="PNG" />
280 </imageobject>
281 <textobject>
282 <phrase>
283 Add Life Gift
284 </phrase>
285 </textobject>
286 </inlinemediaobject>
287 Add Life Gift
288 </term>
289 <listitem>
290 <para>
291 Gives the player an additional life.
292 </para>
293 </listitem>
294 </varlistentry>
295 <varlistentry>
296 <term>
297 <inlinemediaobject>
298 <imageobject>
299 <imagedata fileref="GiftLoseLife.png" format="PNG" />
300 </imageobject>
301 <textobject>
302 <phrase>
303 Lose Life Gift
304 </phrase>
305 </textobject>
306 </inlinemediaobject>
307 Lose Life Gift
308 </term>
309 <listitem>
310 <para>
311 Makes the player lose all balls and resets the bar.
312 </para>
313 </listitem>
314 </varlistentry>
315 <varlistentry>
316 <term>
317 <inlinemediaobject>
318 <imageobject>
319 <imagedata fileref="GiftEnlargeBar.png" format="PNG" />
320 </imageobject>
321 <textobject>
322 <phrase>
323 Enlarge Bar Gift
324 </phrase>
325 </textobject>
326 </inlinemediaobject>
327 Enlarge Bar Gift
328 </term>
329 <listitem>
330 <para>
331 Enlarges the bar.
332 </para>
333 </listitem>
334 </varlistentry>
335 <varlistentry>
336 <term>
337 <inlinemediaobject>
338 <imageobject>
339 <imagedata fileref="GiftShrinkBar.png" format="PNG" />
340 </imageobject>
341 <textobject>
342 <phrase>
343 Shrink Bar Gift
344 </phrase>
345 </textobject>
346 </inlinemediaobject>
347 Shrink Bar Gift
348 </term>
349 <listitem>
350 <para>
351 Shrinks the bar.
352 </para>
353 </listitem>
354 </varlistentry>
355 <varlistentry>
356 <term>
357 <inlinemediaobject>
358 <imageobject>
359 <imagedata fileref="GiftSplitBall.png" format="PNG" />
360 </imageobject>
361 <textobject>
362 <phrase>
363 Split Balls Gift
364 </phrase>
365 </textobject>
366 </inlinemediaobject>
367 Split Balls Gift
368 </term>
369 <listitem>
370 <para>
371 Doubles the balls.
372 </para>
373 </listitem>
374 </varlistentry>
375 <varlistentry>
376 <term>
377 <inlinemediaobject>
378 <imageobject>
379 <imagedata fileref="GiftAddBall.png" format="PNG" />
380 </imageobject>
381 <textobject>
382 <phrase>
383 Add Balls Gift
384 </phrase>
385 </textobject>
386 </inlinemediaobject>
387 Add Balls Gift
388 </term>
389 <listitem>
390 <para>
391 Gives the player an extra ball attached to the bar, which can be fired whenever the player wants.
392 </para>
393 </listitem>
394 </varlistentry>
395 <varlistentry>
396 <term>
397 <inlinemediaobject>
398 <imageobject>
399 <imagedata fileref="GiftStickyBar.png" format="PNG" />
400 </imageobject>
401 <textobject>
402 <phrase>
403 Sticky Bar Gift
404 </phrase>
405 </textobject>
406 </inlinemediaobject>
407 Sticky Bar Gift
408 </term>
409 <listitem>
410 <para>
411 After catching this gift, every time a ball touches the bar it remains attached to it, allowing the player to fire again.
412 </para>
413 </listitem>
414 </varlistentry>
415 <varlistentry>
416 <term>
417 <inlinemediaobject>
418 <imageobject>
419 <imagedata fileref="GiftMoreExplosion.png" format="PNG" />
420 </imageobject>
421 <textobject>
422 <phrase>
423 More Exploding Bricks Gift
424 </phrase>
425 </textobject>
426 </inlinemediaobject>
427 More Exploding Bricks Gift
428 </term>
429 <listitem>
430 <para>
431 Makes all bricks to the top, bottom, right, and left of exploding bricks exploding bricks themselves. This also applies to hidden and unbreakable bricks.
432 </para>
433 </listitem>
434 </varlistentry>
435 <varlistentry>
436 <term>
437 <inlinemediaobject>
438 <imageobject>
439 <imagedata fileref="GiftBurningBall.png" format="PNG" />
440 </imageobject>
441 <textobject>
442 <phrase>
443 Burning Ball Gift
444 </phrase>
445 </textobject>
446 </inlinemediaobject>
447 Burning Ball Gift
448 </term>
449 <listitem>
450 <para>
451 Transforms all the balls into burning balls. When a burning ball hits a brick also the bricks to the top, bottom, left and right of it get destroyed. A burning ball destroys all types of bricks regardless of their types.
452 </para>
453 </listitem>
454 </varlistentry>
455 <varlistentry>
456 <term>
457 <inlinemediaobject>
458 <imageobject>
459 <imagedata fileref="GiftUnstoppableBall.png" format="PNG" />
460 </imageobject>
461 <textobject>
462 <phrase>
463 Unstoppable Ball Gift
464 </phrase>
465 </textobject>
466 </inlinemediaobject>
467 Unstoppable Ball Gift
468 </term>
469 <listitem>
470 <para>
471 Transforms all the balls into unstoppable balls. An unstoppable ball destroys all bricks it encounters on its path, regardless of their type, and never bounces against them.
472 </para>
473 </listitem>
474 </varlistentry>
475 <varlistentry>
476 <term>
477 <inlinemediaobject>
478 <imageobject>
479 <imagedata fileref="GiftMagicEye.png" format="PNG" />
480 </imageobject>
481 <textobject>
482 <phrase>
483 Magic Eye Gift
484 </phrase>
485 </textobject>
486 </inlinemediaobject>
487 Magic Eye Gift
488 </term>
489 <listitem>
490 <para>
491 Shows all hidden bricks.
492 </para>
493 </listitem>
494 </varlistentry>
495 <varlistentry>
496 <term id="gift-magic-wand">
497 <inlinemediaobject>
498 <imageobject>
499 <imagedata fileref="GiftMagicWand.png" format="PNG" />
500 </imageobject>
501 <textobject>
502 <phrase>
503 Magic Wand Gift
504 </phrase>
505 </textobject>
506 </inlinemediaobject>
507 Magic Wand Gift
508 </term>
509 <listitem>
510 <para>
511 Transforms all multiple and unbreakable bricks into simple bricks.
512 </para>
513 </listitem>
514 </varlistentry>
515 <varlistentry>
516 <term>
517 <inlinemediaobject>
518 <imageobject>
519 <imagedata fileref="GiftIncreaseSpeed.png" format="PNG" />
520 </imageobject>
521 <textobject>
522 <phrase>
523 Increase Speed Gift
524 </phrase>
525 </textobject>
526 </inlinemediaobject>
527 Increase Speed Gift
528 </term>
529 <listitem>
530 <para>
531 Increases the speed of the ball by 30% of the current speed.
532 </para>
533 </listitem>
534 </varlistentry>
535 <varlistentry>
536 <term>
537 <inlinemediaobject>
538 <imageobject>
539 <imagedata fileref="GiftDecreaseSpeed.png" format="PNG" />
540 </imageobject>
541 <textobject>
542 <phrase>
543 Decrease Speed Gift
544 </phrase>
545 </textobject>
546 </inlinemediaobject>
547 Decrease Speed Gift
548 </term>
549 <listitem>
550 <para>
551 Decreases the speed of the ball dividing the current speed by 1.3.
552 </para>
553 </listitem>
554 </varlistentry>
555 <varlistentry>
556 <term>
557 <inlinemediaobject>
558 <imageobject>
559 <imagedata fileref="GiftNextLevel.png" format="PNG" />
560 </imageobject>
561 <textobject>
562 <phrase>
563 Next Level Gift
564 </phrase>
565 </textobject>
566 </inlinemediaobject>
567 Next Level Gift
568 </term>
569 <listitem>
570 <para>
571 Opens the next level of the game immediately.
572 </para>
573 </listitem>
574 </varlistentry>
575 </variablelist>
576 </sect1>
577
578 <sect1 id="strategies-and-tips">
579 <title>Strategies and Tips</title>
580 <itemizedlist>
581 <listitem><para>If possible, it is usually a good idea to send the ball above the bricks, doing so you will have a smaller chance of losing the ball. Sometimes you need to first make a small hole in the layer of brick to accomplish this. The smaller the hole, the smaller the chance the balls comes back down.</para></listitem>
582 <listitem><para>When catching the add ball gift it is wise to not fire it right away but to keep in instead, in case the other balls are lost. It is also advisable to not catch a sticky bar gift in such a case, as doing so would force you to fire all balls.</para></listitem>
583 <listitem><para>When receiving a next level gift you may not want to catch it if you know that there are add life gifts in the level.</para></listitem>
584 <listitem><para>In levels where there are a lot of hidden bricks there may be a way to win the level without having to destroy most of them.</para></listitem>
585 </itemizedlist>
586 </sect1>
587
588 </chapter>
589
590 <chapter id="interface-overview">
591 <title>Interface Overview</title>
592
593 <sect1 id="menu">
594 <title>Menu Items</title>
595
596 <variablelist>
597 <varlistentry>
598 <term><menuchoice>
599 <shortcut>
600 <keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>
601 </shortcut>
602 <guimenu>Game</guimenu>
603 <guimenuitem>New</guimenuitem>
604 </menuchoice></term>
605 <listitem>
606 <para>
607 Starts a new game.
608 </para>
609 </listitem>
610 </varlistentry>
611
612 <varlistentry>
613 <term><menuchoice>
614 <shortcut>
615 <keycap>P</keycap>
616 </shortcut>
617 <guimenu>Game</guimenu>
618 <guimenuitem>Pause</guimenuitem>
619 </menuchoice></term>
620 <listitem>
621 <para>
622 Pause and resume the current game.
623 </para>
624 </listitem>
625 </varlistentry>
626
627 <varlistentry>
628 <term><menuchoice>
629 <shortcut>
630 <keycombo action="simul">&Ctrl;<keycap>H</keycap></keycombo>
631 </shortcut>
632 <guimenu>Game</guimenu>
633 <guimenuitem>Show High Scores</guimenuitem></menuchoice></term>
634 <listitem>
635 <para>
636 Shows a dialog containing the High Scores.
637 </para>
638 </listitem>
639 </varlistentry>
640
641 <varlistentry>
642 <term><menuchoice>
643 <shortcut>
644 <keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
645 </shortcut>
646 <guimenu>Game</guimenu>
647 <guimenuitem>Quit</guimenuitem>
648 </menuchoice></term>
649 <listitem>
650 <para>
651 Quits the program.
652 </para>
653 </listitem>
654 </varlistentry>
655
656 <varlistentry>
657 <term><menuchoice>
658 <shortcut>
659 <keycombo action="simul">&Ctrl;&Shift;<keycap>F</keycap></keycombo>
660 </shortcut>
661 <guimenu>View</guimenu>
662 <guimenuitem>Full Screen Mode</guimenuitem>
663 </menuchoice></term>
664 <listitem><para>
665 <action>Play the &kbreakout; game in full screen mode. Leaving this mode is only possible using the shortcut.</action>
666 </para></listitem>
667 </varlistentry>
668
669 </variablelist>
670
671 <para>
672 Additionally &kbreakout; has the common &kde; <guimenu>Settings</guimenu> and <guimenu>Help</guimenu>
673 menu items, for more information read the sections about the <ulink url="help:/fundamentals/menus.html#menus-settings"
674 >Settings Menu</ulink> and <ulink url="help:/fundamentals/menus.html#menus-help">Help Menu</ulink>
675 of the &kde; Fundamentals.
676 </para>
677
678 </sect1>
679
680 <sect1 id="keybindings">
681 <title id="keybindings-title">Shortcuts</title>
682
683 <para>The default shortcuts are:</para>
684
685 <table>
686 <title>Shortcuts</title>
687 <tgroup cols="2">
688 <tbody>
689 <row>
690 <entry>Fire</entry>
691 <entry>
692 &Space;
693 </entry>
694 </row>
695 <row>
696 <entry>Pause/Resume</entry>
697 <entry>
698 <keycap>P</keycap>
699 </entry>
700 </row>
701 <row>
702 <entry>Start a new game</entry>
703 <entry>
704 <keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>
705 </entry>
706 </row>
707 <row>
708 <entry>Show High Scores</entry>
709 <entry>
710 <keycombo action="simul">&Ctrl;<keycap>H</keycap></keycombo>
711 </entry>
712 </row>
713 <row>
714 <entry>Quit</entry>
715 <entry>
716 <keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
717 </entry>
718 </row>
719 <row>
720 <entry>Full Screen Mode</entry>
721 <entry><keycombo action="simul">&Ctrl;&Shift;<keycap>F</keycap></keycombo></entry>
722 </row>
723 <row>
724 <entry>Help</entry>
725 <entry><keycap>F1</keycap></entry>
726 </row>
727 <row>
728 <entry>What's this?</entry>
729 <entry>
730 <keycombo action="simul">&Shift;<keycap>F1</keycap></keycombo>
731 </entry>
732 </row>
733 </tbody>
734 </tgroup>
735 </table>
736
737 </sect1>
738 </chapter>
739
740
741 <chapter id="credits">
742 <title>Credits and License</title>
743
744 <para>
745 &kbreakout;
746 </para>
747 <para>
748 Program copyright 2008 by Fela Winkelmolen <email>[email protected]</email>
749 </para>
750 <para>
751 Documentation copyright 2008 by Fela Winkelmolen <email>[email protected]</email>
752 </para>
753
754 <!-- TRANS:CREDIT_FOR_TRANSLATORS -->
755
756 &underFDL;
757 &underGPL;
758
759 </chapter>
760
761 &documentation.index;
762 </book>
763 <!--
764 Local Variables:
765 mode: sgml
766 sgml-minimize-attributes:nil
767 sgml-general-insert-case:lower
768 sgml-always-quote-attributes:t
769 sgml-indent-step:0
770 sgml-indent-data:t
771 End:
772 -->
773