index.docbook 17.3 KB
Newer Older
Hui Ni's avatar
Hui Ni committed
1 2
<?xml version="1.0" ?>
<!--IMPORTANT: please note that'do not change this!' notice does not apply to translators -->
Laurent Montel's avatar
Laurent Montel committed
3
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
Hui Ni's avatar
Hui Ni committed
4 5 6 7
  <!ENTITY % addindex "IGNORE"><!-- do not change this! -->
  <!ENTITY % English "INCLUDE"><!-- change language only here -->
]>

Luigi Toscano's avatar
Luigi Toscano committed
8
<book id="klickety" lang="&language;"><!-- do not change this! -->
Hui Ni's avatar
Hui Ni committed
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40
<bookinfo>
<title>The &klickety; Handbook</title><!-- This is the title of the docbook. Leave as is unless change is necessary.-->
<!-- List of immediate authors begins here. -->
<authorgroup>
<author>
<personname>
<firstname>Thomas</firstname>
<surname>Davey</surname>
</personname>
<email>thomas.davey@gmail.com</email>
</author>
<author>
<personname>
<firstname>Hui</firstname>
<surname>Ni</surname>
</personname>
<email>shuizhuyuanluo@126.com</email>
</author>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>

<copyright>
<year>2005</year>
<holder>Thomas Davey</holder>
</copyright>
<copyright>
<year>2010</year>
<holder>Ni Hui</holder>
</copyright>

<legalnotice>&FDLNotice;</legalnotice>

41 42
<date>2016-05-09</date>
<releaseinfo>2.1+ (Applications 16.04)</releaseinfo>
Hui Ni's avatar
Hui Ni committed
43 44

<abstract>
45
<para>&klickety; is a strategy game by &kde;, an adaption of the <application>Clickomania</application> game.</para>
Hui Ni's avatar
Hui Ni committed
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141
</abstract>

<!--List of relevan keywords-->
<keywordset>
<keyword>KDE</keyword><!-- do not change this! -->
<keyword>kdegames</keyword><!-- do not change this! -->
<keyword>game</keyword><!-- do not change this! -->
<keyword>Klickety</keyword><!--Application name goes here-->
<!-- Game genre. Use as many as necessary. Available game types are: Arcade, Board, Card, Dice, Toys, Logic, Strategy.-->
<keyword>board</keyword>
<keyword>logic</keyword>
<keyword>strategy</keyword>
<!--Number of possible players. It can be: One, Two,..., Multiplayer-->
<keyword>one player</keyword>
<!--All other relevant keywords-->
</keywordset>

</bookinfo>
<!--Content begins here: -->
<chapter id="introduction">
<title>Introduction</title><!-- do not change this! -->
<note><title>Gametype:</title><para>Board</para></note>
<note><title>Number of possible players:</title><para>One</para></note>
<para>
&klickety; is an adaptation of the Clickomania game. The rules are similar to
those of the Same game: your goal is to clear the board by clicking on groups
to destroy them. The overall aim is to get the lowest score
possible. It will provide entertainment for all abilities, but a
challenge in logical thought if you want to get a really low score.
</para>
</chapter>

<chapter id="how-to-play">
<title>How to Play</title><!-- do not change this! -->
<note><title>Objective:</title><para>Clear the game board of all the colored blocks in the least possible time.</para></note>
<!--How to play description. Don't be to specific on rules as they have a separate section in this document-->
<para>
When you start the program you will get a screen that looks
something like the screenshot in the previous section. The idea of the
game is to remove blocks, which you do by clicking on them.
</para>
<para>
However, you can only remove a block if it is adjacent to one or
more other blocks of the same color on one or more of its
sides. Diagonal connections do not count. You get a random board every
time you start a new game.
</para>
<para>
If you click on a block which is connected as described, it will
disappear. Any adjacent blocks of the same color will also disappear,
along with all of the same color adjacent to <emphasis>them</emphasis>, and so
on. Any blocks above them drop down to fill the gaps left by the
disappeared pieces. If you clear an entire column, all the columns to
the right move across to fill the gap.
</para>
<para>
The game ends when there are no blocks adjacent to other blocks
of the same colour.
</para>

<sect1 id="game-screen">
<title>The Game Screen</title>
<para>
<screenshot>
<screeninfo>A screenshot of &klickety;</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="gamescreen.png" format="PNG"/></imageobject>
<textobject><phrase>Screenshot</phrase></textobject>
</mediaobject>
</screenshot>
A quick explanation of the parts of the game screen.
</para>
<variablelist>
<varlistentry>
<term>Game Screen</term>
<listitem><para>
The Game screen is in the center of the screen and is the largest section of the window.
</para></listitem>
</varlistentry>
<varlistentry>
<term>Statusbar</term>
<listitem><para>
The Status bar is located at the bottom of the screen.
It displays how many pieces are left currently and
the game timer, which keeps track of the elapsed time from
the start of the game until the game is finished.
</para></listitem>
</varlistentry>
</variablelist>
</sect1>

</chapter>

<chapter id="ksame_mode">
<title>The KSame Mode</title><!-- do not change this! -->
<para>
Yuri Chornoivan's avatar
Yuri Chornoivan committed
142
&klickety; provides a &ksame; scoring mode.
Hui Ni's avatar
Hui Ni committed
143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
</para>
<para>The score is calculated as follows:</para>
<para>Subtract 2 from the number of marbles erased, and square the result.
</para>
<para>As an example, if you erase 7 balls, then you get 25 points
(7 minus 2 = 5. 5 squared is 25 points).If you erase 8
balls, then you get 36 points (8 minus 2 = 6. 6 squared is 36 points.
</para>
<para>
Get as many of the same pieces as you can, and then erase them
in one click. That way you will get a higher score. The game is
over when there are no pieces that can be erased.
</para>
<para>
The score will then be decreased according to the number of remaining
pieces. If you erase all pieces 1,000 bonus points will be added to the final
score.
</para>
<screenshot>
<screeninfo>A screenshot of &klickety; in KSame mode</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="ksamemode.png" format="PNG"/></imageobject>
<textobject><phrase>Screenshot</phrase></textobject>
</mediaobject>
</screenshot>
</chapter>

<chapter id="interface">
<title>Interface Overview</title><!-- do not change this! -->
<!-- This section has to do with menubar. Describe every single entry in order. Use <variablelist> and <varlistentry>. Split the chapter into sections using <sect1(2,3)> for better viewing.-->
<sect1 id="default-keybindings">
<title id="keybindings-title">Default Keybindings</title>
<para>Default shortcuts are:</para>

<table>
<title>Shortcuts</title>
<tgroup cols="2">
<tbody>
<row>
182 183 184 185
<entry>New</entry>
<entry><keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo></entry>
</row>
<row>
Hui Ni's avatar
Hui Ni committed
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201
<entry>Load</entry>
<entry><keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo></entry>
</row>
<row>
<entry>Restart Game</entry>
<entry><keycap>F5</keycap></entry>
</row>
<row>
<entry>Save</entry>
<entry><keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo></entry>
</row>
<row>
<entry>Pause</entry>
<entry><keycap>P</keycap></entry>
</row>
<row>
202 203 204 205
<entry>Show High Scores</entry>
<entry><keycombo action="simul">&Ctrl;<keycap>H</keycap></keycombo></entry>
</row>
<row>
Hui Ni's avatar
Hui Ni committed
206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
<entry>Quit</entry>
<entry><keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo></entry>
</row>
<row>
<entry>Undo</entry>
<entry><keycombo action="simul">&Ctrl;<keycap>Z</keycap></keycombo></entry>
</row>
<row>
<entry>Redo</entry>
<entry><keycombo action="simul">&Ctrl;&Shift;<keycap>Z</keycap></keycombo></entry>
</row>
<row>
<entry>Help</entry>
<entry><keycap>F1</keycap></entry>
</row>
<row>
<entry>What's this?</entry>
<entry><keycombo action="simul">&Shift;<keycap>F1</keycap></keycombo></entry>
</row>
</tbody>
</tgroup>
</table>
</sect1>

230 231 232
<sect1 id="menu">
<title>Menu Items</title>

Hui Ni's avatar
Hui Ni committed
233 234
<variablelist>

235 236 237 238 239 240 241 242 243
<varlistentry>
<term><menuchoice>
<shortcut><keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo></shortcut>
<guimenu>Game</guimenu>
<guimenuitem>New</guimenuitem>
</menuchoice></term>
<listitem><para>Starts a new game.</para></listitem>
</varlistentry>

Hui Ni's avatar
Hui Ni committed
244 245 246 247 248
<varlistentry>
<term><menuchoice>
<shortcut><keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo></shortcut>
<guimenu>Game</guimenu>
<guimenuitem>Load...</guimenuitem>
249
</menuchoice> (not in KSameMode) </term>
Hui Ni's avatar
Hui Ni committed
250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282
<listitem><para>Loads a previously saved game.</para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<shortcut><keycap>F5</keycap></shortcut>
<guimenu>Game</guimenu>
<guimenuitem>Restart Game</guimenuitem>
</menuchoice></term>
<listitem><para>This will restart the current game.</para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<guimenu>Game</guimenu>
<guimenuitem>New Numbered Game...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Starts a specifically numbered game.</action>
    <screenshot>
    <screeninfo>Start a Numbered Game Dialog</screeninfo>
    <mediaobject>
    <imageobject><imagedata fileref="numbered.png" format="PNG"/></imageobject>
    <textobject><phrase>Start a Numbered Game Dialog</phrase></textobject>
    </mediaobject>
    </screenshot>
</para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<shortcut><keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo></shortcut>
<guimenu>Game</guimenu>
<guimenuitem>Save</guimenuitem>
283
</menuchoice> (not in KSameMode)</term>
Hui Ni's avatar
Hui Ni committed
284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381
<listitem><para>Saves the current state of the game to the disk.</para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<shortcut><keycap>P</keycap></shortcut>
<guimenu>Game</guimenu>
<guimenuitem>Pause</guimenuitem>
</menuchoice></term>
<listitem><para><action>Pauses or resumes the game. While the game is paused, all tiles are hidden.</action></para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<shortcut><keycombo action="simul">&Ctrl;<keycap>H</keycap></keycombo></shortcut>
<guimenu>Game</guimenu>
<guimenuitem>Show High Scores</guimenuitem>
</menuchoice></term>
<listitem><para><action>Shows the high score list.</action>
    <screenshot>
    <screeninfo>Show High scores</screeninfo>
    <mediaobject>
    <imageobject><imagedata fileref="highscore.png" format="PNG"/></imageobject>
    <textobject><phrase>Show High scores</phrase></textobject>
    </mediaobject>
    </screenshot>
</para>
<para>
When your game scores exceed the top ten scores listed, you are prompted to enter your name.
</para> </listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<shortcut><keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo></shortcut>
<guimenu>Game</guimenu>
<guimenuitem>Quit</guimenuitem>
</menuchoice></term>
<listitem><para>Selecting this item will end your current game, and exit &klickety;.</para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<shortcut><keycombo action="simul">&Ctrl;<keycap>Z</keycap></keycombo></shortcut>
<guimenu>Move</guimenu>
<guimenuitem>Undo</guimenuitem>
</menuchoice></term>
<listitem><para><action>Undo the last move you made.</action></para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>Z</keycap></keycombo></shortcut>
<guimenu>Move</guimenu>
<guimenuitem>Redo</guimenuitem>
</menuchoice></term>
<listitem><para><action>If you have previously undone a move, you can redo it here.</action></para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<guimenu>Move</guimenu>
<guimenuitem>Undo All</guimenuitem>
</menuchoice></term>
<listitem><para><action>Undo</action> all moves you made.</para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<guimenu>Move</guimenu>
<guimenuitem>Redo All</guimenuitem>
</menuchoice></term>
<listitem><para><action>Redo</action> all undone moves.</para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<guimenu>Settings</guimenu>
<guisubmenu>Difficulty</guisubmenu>
</menuchoice></term>
<listitem>
<para>Lets you set the difficulty level from a sub-menu.</para>
<para>There are four levels of difficulty:
<itemizedlist>
<listitem><para><guimenuitem>Very easy</guimenuitem>: 16 rows, 10 columns, 3 types of pieces.</para></listitem>
<listitem><para><guimenuitem>Easy</guimenuitem>: 16 rows, 10 columns, 4 types of pieces.</para></listitem>
<listitem><para><guimenuitem>Medium</guimenuitem>: 16 rows, 10 columns, 5 types of pieces.</para></listitem>
<listitem><para><guimenuitem>Hard</guimenuitem>: 16 rows, 10 columns, 6 types of pieces.</para></listitem>
</itemizedlist>
</para>
<para>There is also a <guimenuitem>Custom</guimenuitem> level settings.</para>
<para>If you select <guimenuitem>Custom</guimenuitem>, then the
settings you have configured in the <guimenuitem>Configure &klickety;</guimenuitem> dialog will be used.</para>
</listitem>
</varlistentry>

</variablelist>

382
<para>
383
Additionally &klickety; has the common &kde; <guimenu>Settings</guimenu> and <guimenu>Help</guimenu>
384 385
menu items, for more information read the sections about the <ulink url="help:/fundamentals/menus.html#menus-settings"
>Settings Menu</ulink> and <ulink url="help:/fundamentals/menus.html#menus-help">Help Menu</ulink>
386 387
of the &kde; Fundamentals.
</para>
Hui Ni's avatar
Hui Ni committed
388 389 390 391 392 393 394 395 396 397 398 399 400

</sect1>

</chapter>

<chapter id="faq">
<title>Frequently asked questions</title> <!-- do not change this! -->
<!--This chapter is for frequently asked questions. Please use <qandaset> <qandaentry> only!-->
<qandaset>

<!--Following is a standard list of FAQ questions.-->
<qandaentry>
<question><para>I want to change the way this game looks. Can I? </para></question>
401
<answer><para>Yes. To change the way &klickety; looks use the menubar to open the <link linkend="configuration">configuration utility</link>.</para></answer>
Hui Ni's avatar
Hui Ni committed
402 403 404 405 406 407 408
</qandaentry>
<qandaentry>
<question><para>Can I use the keyboard to play the game?</para></question>
<answer><para>No. This game does not feature a keyboard play mode yet.</para></answer>
</qandaentry>
<qandaentry>
<question><para>How to start the game in KSame mode?</para></question>
Yuri Chornoivan's avatar
Yuri Chornoivan committed
409
<answer><para>You can launch &klickety; with command <userinput>klickety --KSameMode</userinput> or &ksame; menu entry in K menu.</para></answer>
Hui Ni's avatar
Hui Ni committed
410 411 412 413 414 415 416 417 418 419 420 421 422
</qandaentry>

</qandaset>
</chapter>

<chapter id="configuration">
<title>Game Configuration</title><!-- do not change this! -->
<!--This section describes configuration &GUI;. If your game is configured using menubar exclusively, please remove this section.-->
<para>
<menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure &klickety;...</guimenuitem></menuchoice> opens
the <guilabel>Configure - &klickety;</guilabel> dialog.</para>

<sect1 id="general-options">
423
<title>General options</title>
Hui Ni's avatar
Hui Ni committed
424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453
<variablelist>
<varlistentry>
<term><guilabel>Show bound lines</guilabel></term>
<listitem><para>
This option will show bound lines between pieces with different color.
</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Enable animation</guilabel></term>
<listitem><para>
This option will enable the falling and merging animation when pieces are removed.
</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Enable highlight</guilabel></term>
<listitem><para>
This option will enable highlighting on pieces hovered if they can be removed.
</para></listitem>
</varlistentry>
</variablelist>
<screenshot>
<screeninfo>General options</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="config-general.png" format="PNG"/></imageobject>
<textobject><phrase>General options</phrase></textobject>
</mediaobject>
</screenshot>
</sect1>

<sect1 id="theme-options">
454
<title>Theme options</title>
Hui Ni's avatar
Hui Ni committed
455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470
<variablelist>
<varlistentry>
<term><guilabel>Theme</guilabel> selector</term>
<listitem><para>Use the <guilabel>Theme</guilabel> selector to set a theme for the game.</para></listitem>
</varlistentry>
</variablelist>
<screenshot>
<screeninfo>Theme options</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="config-theme.png" format="PNG"/></imageobject>
<textobject><phrase>Theme options</phrase></textobject>
</mediaobject>
</screenshot>
</sect1>

<sect1 id="background-options">
471
<title>Background options</title>
Hui Ni's avatar
Hui Ni committed
472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498
<para>
You can choose a background graphic for the game. There are three kinds of background type you can use.
<variablelist>
<varlistentry>
<term><guilabel>Theme</guilabel></term>
<listitem><para>Use the background shipped with the current theme.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Color</guilabel></term>
<listitem><para>Use a custom solid color for the background.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Image</guilabel></term>
<listitem><para>Use an image for the background graphic.</para></listitem>
</varlistentry>
</variablelist>
</para>
<screenshot>
<screeninfo>Background options</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="config-background.png" format="PNG"/></imageobject>
<textobject><phrase>Background options</phrase></textobject>
</mediaobject>
</screenshot>
</sect1>

<sect1 id="customgame-options">
499
<title>Custom Game options</title>
Hui Ni's avatar
Hui Ni committed
500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518
<para>
You can set the <guilabel>Height</guilabel> and <guilabel>Width</guilabel> of the board
and the <guilabel>Color count</guilabel> used in your custom level.
</para>
<screenshot>
<screeninfo>Custom game options</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="config-customgame.png" format="PNG"/></imageobject>
<textobject><phrase>Custom game options</phrase></textobject>
</mediaobject>
</screenshot>
</sect1>

</chapter>

<chapter id="credits">
<title>Credits and License</title>
<para>&klickety;</para>
<para>Program Copyright &copy; 1995, Eirik Eng</para>
André Marcelo Alvarenga's avatar
André Marcelo Alvarenga committed
519
<para>Program Copyright &copy; 1996&ndash;2004, &Nicolas.Hadacek; &Nicolas.Hadacek.mail;</para>
Hui Ni's avatar
Hui Ni committed
520 521 522 523 524 525 526 527 528 529
<para>Program Copyright &copy; 2010, Ni Hui <email>shuizhuyuanluo@126.com</email></para>
<para>Documentation Copyright &copy; 2005, Thomas Davey</para>
<para>Documentation Copyright &copy; 2010, Ni Hui <email>shuizhuyuanluo@126.com</email></para>
<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
&underFDL;
&underGPL;
</chapter>

&documentation.index;
</book>