path: root/doc/ksmiletris/index.docbook

<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
  <!-- Define an entity for your application if it is not part of KDE
       CVS -->
  <!ENTITY ksmiletris "<application>KSmiletris</application>">
  <!ENTITY kappname "&ksmiletris;">
  <!ENTITY package "kdegames">
  <!ENTITY % addindex "IGNORE">
  <!ENTITY % English "INCLUDE"> <!-- change the language here -->
	<!ENTITY John.Hayes '<personname><firstname>John</firstname><surname>Hayes</surname></personname>'>
	<!ENTITY John.Hayes.mail '<email>[email protected]</email>'>
	<!ENTITY Sandro.Sigala '<personname><firstname>Sandro</firstname><surname>Sigala</surname></personname>'>
	<!ENTITY Sandro.Sigala.mail '<email>[email protected]</email>'>
  <!ENTITY Tetris "<trademark><application>Tetris</application></trademark>">
]>

<book lang="&language;">

<bookinfo>
<title>The &ksmiletris; Handbook</title>

<authorgroup>
<author>
&John.Hayes; &John.Hayes.mail;
</author>

<othercredit role="developer">
&Sandro.Sigala; &Sandro.Sigala.mail;
</othercredit>

<othercredit role="reviewer">
&Frerich.Raabe; &Frerich.Raabe.mail;
</othercredit>

<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>

<copyright>
<year>2005</year>
<holder>&John.Hayes;</holder>
</copyright>

<date>2005-12-14</date>
<releaseinfo>3.5.0</releaseinfo>

<legalnotice>&FDLNotice;</legalnotice>

<!-- Abstract about this handbook -->

<abstract>
<para>
&ksmiletris; is a &Tetris; like game.
</para>
</abstract>

<keywordset>
<keyword>KDE</keyword>
<keyword>kdegames</keyword>
<keyword>KSmileTris</keyword>
<keyword>Tetris</keyword>
</keywordset>

</bookinfo>

<chapter id="introduction">
<title>Introduction</title>

<para>&ksmiletris; is a game similar to the &Tetris; game. If you have ever played &Tetris;, you will find &ksmiletris; easy to learn and play.
</para>

</chapter>

<chapter id="gameplay">
<title>Game Play</title>

<sect1 id="starting-a-new-game">
<title>Starting a New Game</title>

<para>When you start &ksmiletris;, the game shows a blank game area. To start playing either select <guimenuitem>New</guimenuitem> from the <guimenu>Game</guimenu> menu or press the key combination <keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>.</para>

</sect1>

<sect1 id="aim-of-the-game">
<title>Aim of the Game</title>

<para>The aim of the game is to complete each level and get the highest score possible. You score by stacking or moving the similar tiles together as they fall, and then disappear. As the tiles disappear, your score increases.</para>

</sect1>

<sect1 id="playing-the-game">
<title>Playing the Game</title>

<para>By default, you can use the <keysym>Left Arrow</keysym> and <keysym>Right Arrow</keysym> keys to position the falling tiles where you want them to stack, and the <keysym>Up Arrow</keysym> or <keysym>Down Arrow</keysym> keys to rotate the tiles left or right respectively. The <keysym>Spacebar</keysym> drops the tile all the way to the bottom - use it as a way to save time.</para>

<para>All of the shortcuts can be customized by selecting <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure Shortcuts</guimenuitem></menuchoice> from the menu.</para>

<para>Four of more of the same type of connected tiles will change to a broken or shattered look. When four or more of the connected tiles are shattered, they will disappear and all pieces above them will settle down to the rows below them.</para>

<para>Every time a piece shatters, you get 10 points for each tile, you get 20 more points for each tile when it disappears. There are 1000 points per level. As the level increases, more types of tiles will be introduced which makes it more challenging to find fits and the speed at which the tiles fall increases as well.</para>

<para>The game ends when the center column fills to the top with tiles, and no more can fall.</para>

</sect1>

<sect1 id="game-screen">
<title>The Game Screen</title>

<para>
<screenshot>
        <mediaobject>
           <imageobject>
            <imagedata fileref="gamescreen.png" format="PNG"/>
          </imageobject>
          <textobject>
            <phrase>&ksmiletris; in Action</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 at the top left and is the largest section of the window.</para></listitem>
</varlistentry>

<varlistentry>
<term>Preview Screen</term>
<listitem><para>The Preview screen at the top right, gives you a preview of the block that will drop out next.</para></listitem>
</varlistentry>

<varlistentry>
<term>Alignment Screen</term>
<listitem><para>The Alignment screen is located just below the game screen. As the tiles are falling, the two tiles that will be on the bottom are shown in the alignment screen in the columns that they are located in. This screen helps you see where the tiles will be located when they get to the bottom.</para></listitem>
</varlistentry>

<varlistentry>
<term>Statusbar</term>
<listitem><para>The status bar is located at the very bottom of the screen, and shows the current level you are on and your score. Display of the Statusbar can be toggled on or off by the menu <menuchoice><guimenu>Settings</guimenu><guimenuitem>Hide Statusbar</guimenuitem></menuchoice>.</para></listitem>
</varlistentry>

</variablelist>

</sect1>

</chapter>

<chapter id="preferences">
<title>&ksmiletris; Configuration and Default Shortcuts</title>

<sect1 id="game-configuration">
<title>Configuring Gameplay</title>

<para>The configuration options are as follows:</para>

<sect2 id="statusbar">
<title>Hide/Show Statusbar</title>

<variablelist>

<varlistentry>
<term><menuchoice><guimenu>Settings</guimenu><guimenuitem>Hide Statusbar</guimenuitem></menuchoice></term>
<listitem>
<para>Hides the Statusbar.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><menuchoice><guimenu>Settings</guimenu><guimenuitem>Show Statusbar</guimenuitem></menuchoice></term>
<listitem>
<para>Shows the Statusbar.</para>
</listitem>
</varlistentry>

</variablelist>

</sect2>

<sect2 id="appearance-config">
<title>Appearance Configuration</title>

<para>The game appearance configuration can be set from <menuchoice><guimenu>Settings</guimenu><guimenuitem>Pieces</guimenuitem></menuchoice>. Your options are:</para>

<variablelist>

<varlistentry>
<term><menuchoice><guimenu>Settings</guimenu><guimenuitem>Pieces</guimenuitem><guimenuitem>Smiles</guimenuitem></menuchoice></term>
<listitem><para>Sets the tile appearance to Smileys.
<screenshot>
<mediaobject>
<imageobject>
<imagedata fileref="smiley.png" format="PNG"/>
</imageobject>
</mediaobject>
</screenshot>
</para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice><guimenu>Settings</guimenu><guimenuitem>Pieces</guimenuitem><guimenuitem>Symbols</guimenuitem></menuchoice></term>
<listitem><para>Sets the tile appearance to Symbols.
<screenshot>
<mediaobject>
<imageobject>
<imagedata fileref="symbol.png" format="PNG"/>
</imageobject>
</mediaobject>
</screenshot>
</para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice><guimenu>Settings</guimenu><guimenuitem>Pieces</guimenuitem><guimenuitem>Icons</guimenuitem></menuchoice></term>
<listitem><para>Sets the tile appearance to Icons.
<screenshot>
<mediaobject>
<imageobject>
<imagedata fileref="icon.png" format="PNG"/>
</imageobject>
</mediaobject>
</screenshot>
</para></listitem>
</varlistentry>

</variablelist>

</sect2>

<sect2 id="sound-config">
<title>Sound Configuration</title>

<variablelist>

<varlistentry>
<term><menuchoice><guimenu>Settings</guimenu><guimenuitem>Sounds</guimenuitem></menuchoice></term>
<listitem><para>Toggles sound effects on or off.</para></listitem>
</varlistentry>

</variablelist>

</sect2>
</sect1>

<sect1 id="default-keybindings">
<title>Default Shortcuts</title>

<para><menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure Shortcuts</guimenuitem></menuchoice> 
allows you to change the default keyboard shortcuts. The default shortcuts are as follows:</para>

<variablelist>

<varlistentry>
<term><keysym>Spacebar</keysym></term>
<listitem><para>Drops the tile to the bottom fast.</para></listitem>
</varlistentry>

<varlistentry>
<term><keysym>Up Arrow</keysym></term>
<listitem><para>Rotate tile to the left.</para></listitem>
</varlistentry>

<varlistentry>
<term><keysym>Down Arrow</keysym></term>
<listitem><para>Rotate tile to the right.</para></listitem>
</varlistentry>

<varlistentry>
<term><keysym>Left Arrow</keysym></term>
<listitem><para>Move tile to the left.</para></listitem>
</varlistentry>

<varlistentry>
<term><keysym>Right Arrow</keysym></term>
<listitem><para>Move tile to the right.</para></listitem>
</varlistentry>

<varlistentry>
<term><keysym>P</keysym></term>
<listitem><para>Pause or resume the game.</para></listitem>
</varlistentry>

<varlistentry>
<term><keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo></term>
<listitem><para>Start a new game.</para></listitem>
</varlistentry>

<varlistentry>
<term><keycombo action="simul">&Ctrl;<keycap>End</keycap></keycombo></term>
<listitem><para>End the game.</para></listitem>
</varlistentry>

<varlistentry>
<term><keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo></term>
<listitem><para>Quit the game.</para></listitem>
</varlistentry>

<varlistentry>
<term><keycombo action="simul">&Ctrl;<keycap>H</keycap></keycombo></term>
<listitem><para>Show the high scores.</para></listitem>
</varlistentry>

</variablelist>



</sect1>

</chapter>

<chapter id="memus">
<title>Menu Reference</title>

<sect1 id="ksmiletris-mainwindow">
<title>The Main &ksmiletris; Window</title>

<sect2>
<title>The <guimenu>Game</guimenu> Menu</title>

<variablelist>

<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>
</shortcut>
<guimenu>Game</guimenu>
<guimenuitem>New</guimenuitem>
</menuchoice></term>
<listitem><para><action>Starts a new game.</action></para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>End</keycap></keycombo>
</shortcut>
<guimenu>Game</guimenu>
<guimenuitem>End</guimenuitem>
</menuchoice></term>
<listitem><para><action>Ends the current game.</action></para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo><keycap>P</keycap></keycombo>
</shortcut>
<guimenu>Game</guimenu>
<guimenuitem>Pause</guimenuitem>
</menuchoice></term>
<listitem><para><action>Pauses or resumes the game</action></para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>H</keycap></keycombo>
</shortcut>
<guimenu>Game</guimenu>
<guimenuitem>Show Highscores</guimenuitem>
</menuchoice></term>
<listitem><para><action>Displays the high scores.</action></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><action>Quits</action> &ksmiletris;</para></listitem>
</varlistentry>

</variablelist>

</sect2>

<sect2>
<title>The <guimenu>Settings</guimenu> Menu</title>

<variablelist>

<varlistentry>
<term><menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Show/Hide Statusbar</guimenuitem>
</menuchoice></term>
<listitem><para><action>Shows or hides the statusbar.</action></para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Pieces</guimenuitem>
</menuchoice></term>
<listitem><para><action>Lets you select from three different appearances for the tiles. Your options are Smileys, Symbols or Icons.</action></para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Sounds</guimenuitem>
</menuchoice></term>
<listitem><para><action>Toggle effects on or off.</action></para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Configure Shortcuts...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Allows you to change the default shortcuts.</action></para></listitem>
</varlistentry>

</variablelist>

</sect2>

<sect2 id="help">
<title>The <guimenuitem>Help</guimenuitem> Menu</title>

&help.menu.documentation;

</sect2>

</sect1>

</chapter>

<chapter id="credits">

<title>Credits and License</title>

<para>&ksmiletris;</para>

<para>Program Copyright (c) 1998 &Sandro.Sigala; &Sandro.Sigala.mail;.
</para>

<para>All rights reserved.</para>

<para>Documentation copyright 2005 &John.Hayes; &John.Hayes.mail;.</para>

<!-- TRANS:CREDIT_FOR_TRANSLATORS -->

&underFDL;

&underGPL;

</chapter>

</book>