Warning, /games/kmahjongg/doc/index.docbook is written in an unsupported language. File is not indexed.

0001 <?xml version="1.0" ?>
0002 <!--IMPORTANT: please note that 'Do not change this!' notice does not apply to translators -->
0003 <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
0004   <!ENTITY % English "INCLUDE" > <!-- change language only here -->
0005   <!ENTITY % addindex "IGNORE"> <!-- do not change this! -->
0006 ]>
0007 
0008 <book id="kmahjongg" lang="&language;"> <!-- do not change this! -->
0009 <bookinfo>
0010         <title>The &kmahjongg; Handbook</title> <!-- This is the title of this docbook. -->
0011 <!-- List of immidiate authors begins here. -->
0012 <!--INPORTANT! - All other contributors: [to be determined] -->
0013 <authorgroup>
0014 <author>
0015         <personname>
0016                 <firstname>John</firstname>
0017                 <surname>Hayes</surname>
0018         </personname>
0019                 <email>justlinux@bellsouth.net</email>
0020 </author>
0021 <author>
0022 <firstname>Eugene</firstname><surname>Trounev</surname>
0023 <affiliation><address><email>eugene.trounev@gmail.com</email></address></affiliation>
0024 </author>
0025 <!-- TRANS:ROLES_OF_TRANSLATORS -->
0026 </authorgroup>
0027 
0028 <legalnotice>&FDLNotice;</legalnotice>
0029 
0030 <date>2021-06-16</date><!-- Date of (re)writing, or update.-->
0031 <releaseinfo>0.9 (KDE Gear 21.04)</releaseinfo><!-- Application version number. Use the variable definitions within header to change this value.-->
0032 
0033 <!--Short description of this document. Do not change unless necessary!-->
0034 <abstract>
0035         <para>This documentation describes the game of &kmahjongg; version 0.9</para>
0036 </abstract>
0037 
0038 <!--List of relevan keywords-->
0039 <keywordset>
0040         <keyword>KDE</keyword> <!-- do not change this! -->
0041         <keyword>kdegames</keyword> <!-- do not change this! -->
0042         <keyword>game</keyword> <!-- do not change this! -->
0043         <keyword>KMahjongg</keyword><!--Application name goes here-->
0044 <!-- Game genre. Use as many as necessary. Available game types are: Arcade, Board, Card, Dice, Toys, Logic, Strategy.-->
0045         <keyword>board</keyword>
0046         <keyword>arcade</keyword>
0047         <keyword>tile game</keyword>
0048         <keyword>tiles</keyword>
0049 <!--Number of possible players. It can be: One, Two,..., Multiplayer-->
0050         <keyword>one player</keyword>
0051 <!--All other relevant keywords-->
0052 </keywordset>
0053 </bookinfo>
0054 <!--Content begins here: -->
0055 <chapter id="introduction"><title>Introduction</title> <!-- do not change this! -->
0056         <note><title>Gametype:</title><para>Board, Arcade</para></note><!-- Game genre. Use as many as necessary. Available game types are: Arcade, Board, Card, Dice, Toys, Logic, Strategy.-->
0057         <note><title>Number of possible players:</title><para>One</para></note><!--Number of possible players. It can be: One, Two,..., Multiplayer-->
0058         <para>
0059                 &kmahjongg; is a fun board game created after the famous oriental game of Mahjong (from Chinese <foreignphrase lang="zh">麻將</foreignphrase>). Unlike the original however, &kmahjongg; is a tile matching game for one player, a variation usually known as Mahjong Solitaire.
0060         </para>
0061         <para>
0062                 In &kmahjongg; the tiles are scrambled and stacked on top of each other to resemble a certain shape. The player is then expected to remove all the tiles off the game board by locating each tile's matching pair.
0063         </para>
0064 </chapter>
0065 
0066 <chapter id="howto"><title>How to play</title> <!-- do not change this! -->
0067 <!--IMPORTANT: If the game has no defined objective, please remove the below line.-->
0068         <note><title>Objective:</title><para>Remove all tiles from the game board by locating each tile's matching pair as fast as possible.</para></note><!--Describe the objective of the game.-->
0069 <!--How to play description. Don't be to specific on rules as they have a separate section in this document-->
0070         <para>
0071                 &kmahjongg; will load a default layout automatically once you start the game and you can start playing right away.
0072         </para>
0073         <note><title>Note:</title><para>The game timer will start immediately if the game is started.</para></note>
0074         <para>
0075                 You should carefully study the stack of tiles laid out on the game board and find two tiles matching exactly. When you have found such a pair use your mouse to select these.
0076         </para>
0077         <note><title>Note:</title>
0078                 <para>Bear in mind that you can only select the tiles which are <quote>Open</quote>.
0079                         Tiles are considered <quote>Blocked</quote> when they
0080                         are positioned behind other tiles, or when both the
0081                         right and left sides of the tile are filled by others.
0082                         If at least one of the lateral sides is empty then the
0083                         tile is considered <quote>Open</quote>, and can be removed.
0084         </para></note>
0085         <para>
0086                 Once you have selected the right pair of tiles they will vanish off the game board, thus revealing the tiles previously located underneath, and opening the tiles adjacent to them.
0087         </para>
0088         <para>
0089                 Find as many matches as possible to remove all the tiles from the game board.
0090         </para>
0091 </chapter>
0092 
0093 <chapter id="rules_and_tips"><title>Game Rules, Strategies and Tips</title> <!-- do not change this! -->
0094         <!--This section has to do with game rules. Please give a detailed description of those using lists or paragraphs.-->
0095         <sect1 id="game-screen">
0096                 <title>The Game Screen</title>
0097                 <para>
0098                         <screenshot>
0099                                 <screeninfo>A screenshot of &kmahjongg;</screeninfo>
0100                                 <mediaobject>
0101                                         <imageobject>
0102                                                 <imagedata fileref="gamescreen.png" format="PNG"/>
0103                                         </imageobject>
0104                                         <textobject><phrase>Screenshot</phrase></textobject>
0105                                 </mediaobject>
0106                         </screenshot>
0107                         A quick explanation of the parts of the game screen.
0108                 </para>
0109         <variablelist>
0110                 <varlistentry>
0111                         <term>Game Screen</term>
0112                         <listitem><para>
0113                                 The Game screen is in the center of the screen and is the largest section of the window. The background is populated with the game tiles.
0114                         </para></listitem>
0115                 </varlistentry>
0116                 <varlistentry>
0117                         <term>Statusbar</term>
0118                         <listitem><para>
0119                                 The status bar is located at the bottom of the screen, and contains four panes. The first pane displays the game timer, which keeps track of the elapsed time from the start of the game until the game is finished. The second pane lists the removed/total tiles and the number of matching tiles that have free sides. The third pane gives the sequence number of the game you are playing and the last pane lets the player know when the game is ready.
0120                         </para></listitem>
0121                 </varlistentry>
0122         </variablelist>
0123         </sect1>
0124         <sect1 id="rules">
0125                 <title>Rules</title>
0126                 <para>
0127                         Standard Mahjong set of tiles includes:
0128                         <informaltable>
0129                                 <tgroup cols="3">
0130                                 <tbody>
0131                                         <row><entry>Group name</entry><entry>Tile name</entry><entry>Quantity in a set</entry></row>
0132                                         <row><entry>Dots</entry><entry></entry><entry></entry></row>
0133                                         <row><entry></entry><entry>1 of Dots</entry><entry>4</entry></row>
0134                                         <row><entry></entry><entry>2 of Dots</entry><entry>4</entry></row>
0135                                         <row><entry></entry><entry>3 of Dots</entry><entry>4</entry></row>
0136                                         <row><entry></entry><entry>4 of Dots</entry><entry>4</entry></row>
0137                                         <row><entry></entry><entry>5 of Dots</entry><entry>4</entry></row>
0138                                         <row><entry></entry><entry>6 of Dots</entry><entry>4</entry></row>
0139                                         <row><entry></entry><entry>7 of Dots</entry><entry>4</entry></row>
0140                                         <row><entry></entry><entry>8 of Dots</entry><entry>4</entry></row>
0141                                         <row><entry></entry><entry>9 of Dots</entry><entry>4</entry></row>
0142                                         <row><entry>Bamboos</entry><entry></entry><entry></entry></row>
0143                                         <row><entry></entry><entry>1 of Bamboos</entry><entry>4</entry></row>
0144                                         <row><entry></entry><entry>2 of Bamboos</entry><entry>4</entry></row>
0145                                         <row><entry></entry><entry>3 of Bamboos</entry><entry>4</entry></row>
0146                                         <row><entry></entry><entry>4 of Bamboos</entry><entry>4</entry></row>
0147                                         <row><entry></entry><entry>5 of Bamboos</entry><entry>4</entry></row>
0148                                         <row><entry></entry><entry>6 of Bamboos</entry><entry>4</entry></row>
0149                                         <row><entry></entry><entry>7 of Bamboos</entry><entry>4</entry></row>
0150                                         <row><entry></entry><entry>8 of Bamboos</entry><entry>4</entry></row>
0151                                         <row><entry></entry><entry>9 of Bamboos</entry><entry>4</entry></row>
0152                                         <row><entry>Characters</entry><entry></entry><entry></entry></row>
0153                                         <row><entry></entry><entry>1 of Characters</entry><entry>4</entry></row>
0154                                         <row><entry></entry><entry>2 of Characters</entry><entry>4</entry></row>
0155                                         <row><entry></entry><entry>3 of Characters</entry><entry>4</entry></row>
0156                                         <row><entry></entry><entry>4 of Characters</entry><entry>4</entry></row>
0157                                         <row><entry></entry><entry>5 of Characters</entry><entry>4</entry></row>
0158                                         <row><entry></entry><entry>6 of Characters</entry><entry>4</entry></row>
0159                                         <row><entry></entry><entry>7 of Characters</entry><entry>4</entry></row>
0160                                         <row><entry></entry><entry>8 of Characters</entry><entry>4</entry></row>
0161                                         <row><entry></entry><entry>9 of Characters</entry><entry>4</entry></row>
0162                                         <row><entry>Winds</entry><entry></entry><entry></entry></row>
0163                                         <row><entry></entry><entry>East Wind</entry><entry>4</entry></row>
0164                                         <row><entry></entry><entry>South Wind</entry><entry>4</entry></row>
0165                                         <row><entry></entry><entry>West Wind</entry><entry>4</entry></row>
0166                                         <row><entry></entry><entry>North Wind</entry><entry>4</entry></row>
0167                                         <row><entry>Dragons</entry><entry></entry><entry></entry></row>
0168                                         <row><entry></entry><entry>Red Dragon</entry><entry>4</entry></row>
0169                                         <row><entry></entry><entry>Green Dragon</entry><entry>4</entry></row>
0170                                         <row><entry></entry><entry>White Dragon</entry><entry>4</entry></row>
0171                                         <row><entry>Flowers</entry><entry></entry><entry></entry></row>
0172                                         <row><entry></entry><entry>Plum (1)</entry><entry>1</entry></row>
0173                                         <row><entry></entry><entry>Lily (2)</entry><entry>1</entry></row>
0174                                         <row><entry></entry><entry>Chrysanthemum (3)</entry><entry>1</entry></row>
0175                                         <row><entry></entry><entry>Bamboo (4)</entry><entry>1</entry></row>
0176                                         <row><entry>Seasons</entry><entry></entry><entry></entry></row>
0177                                         <row><entry></entry><entry>Spring (1)</entry><entry>1</entry></row>
0178                                         <row><entry></entry><entry>Summer (2)</entry><entry>1</entry></row>
0179                                         <row><entry></entry><entry>Autumn (3)</entry><entry>1</entry></row>
0180                                         <row><entry></entry><entry>Winter (4)</entry><entry>1</entry></row>
0181                                 </tbody>
0182                                 </tgroup>
0183                         </informaltable>
0184                 </para>
0185                 <itemizedlist>
0186                         <listitem><para>The number of tiles on a &kmahjongg; board layout can differ from the number of tiles in the standard Mahjong tile set. That means that the number of occurrences of tiles of the same type can also differ from the number stated in the table above.</para></listitem>
0187                         <listitem><para>Only the <quote>open</quote> tiles can be selected.</para></listitem>
0188                         <listitem><para><quote>Open</quote> tile is the tile which has one of the tile's lateral sides open, meaning that no other tiles are located immediately next to it.</para></listitem>
0189                         <listitem><para>Only when matching, open tiles can be removed from the game board.</para></listitem>
0190                         <listitem><para>Matching tiles are those where the face pictograms match.</para></listitem>
0191                 </itemizedlist>
0192                 <note><title>Note:</title><para>There are exceptions to this rule! In the traditional game of Mahjong each tile has a matching one except for the <quote>Flowers</quote> and <quote>Seasons</quote> tiles.</para></note>
0193                 <itemizedlist>
0194                         <listitem><para>The <quote>Flowers</quote> tiles have no doubles in the set and can be matched directly to each other.</para></listitem>
0195                         <listitem><para>The <quote>Seasons</quote> tiles have no doubles in the set and can be matched directly to each other.</para></listitem>
0196                         <listitem><para>Not every &kmahjongg; game can be finished. Sometimes the tiles are mixed in such a way that it may not be possible to find all the matches. This problem can be avoided. Please refer to <link linkend="general-options">this section</link> of the configuration dialog.</para></listitem>
0197                         <listitem><para>To be eligible for a place amongst the high scores the player has to complete a game instance within the shortest period of time possible.</para></listitem>
0198                 </itemizedlist>
0199                 <note><title>Note:</title><para>If the player uses the <quote>Hint</quote> feature the record will not be considered as a high score.</para></note>
0200 
0201         </sect1>
0202 </chapter>
0203 
0204 
0205 <chapter id="interface"><title>Interface Overview</title> <!-- do not change this! -->
0206 <!-- 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.-->
0207 
0208 <sect1 id="menu">
0209 <title>Menu Items</title>
0210 
0211                 <variablelist>
0212                         <varlistentry id="game-menu-new">
0213                                 <term><menuchoice>
0214                                         <shortcut><keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo></shortcut>
0215                                         <guimenu>Game</guimenu>
0216                                         <guimenuitem>New</guimenuitem>
0217                                 </menuchoice></term>
0218                                 <listitem><para><action>Starts a new game.</action></para></listitem>
0219                         </varlistentry>
0220                         <varlistentry  id="game-menu-load">
0221                                 <term><menuchoice>
0222                                         <shortcut><keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo></shortcut>
0223                                         <guimenu>Game</guimenu>
0224                                         <guimenuitem>Load...</guimenuitem>
0225                                 </menuchoice></term>
0226                                 <listitem><para><action>Loads a saved game.</action></para></listitem>
0227                         </varlistentry>
0228                         <varlistentry id="game-menu-restart">
0229                                 <term><menuchoice>
0230                                         <shortcut><keycap>F5</keycap></shortcut>
0231                                         <guimenu>Game</guimenu>
0232                                         <guimenuitem>Restart Game</guimenuitem>
0233                                 </menuchoice></term>
0234                                 <listitem><para><action>Restarts the current game.</action></para></listitem>
0235                         </varlistentry>
0236                         <varlistentry>
0237                                 <term><menuchoice>
0238                                         <guimenu>Game</guimenu>
0239                                         <guimenuitem>New Numbered Game...</guimenuitem>
0240                                 </menuchoice></term>
0241                                 <listitem><para><action>Starts a specifically numbered game.</action>
0242                                 <screenshot>
0243                                         <screeninfo>Start a Numbered Game Dialog</screeninfo>
0244                                         <mediaobject>
0245                                                 <imageobject><imagedata fileref="numbered.png" format="PNG"/></imageobject>
0246                                                 <textobject><phrase>Start a Numbered Game Dialog</phrase></textobject>
0247                                         </mediaobject>
0248                                 </screenshot>
0249                                 </para></listitem>
0250                         </varlistentry>
0251                         <varlistentry id="game-menu-save">
0252                                 <term><menuchoice>
0253                                         <shortcut><keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo></shortcut>
0254                                         <guimenu>Game</guimenu>
0255                                         <guimenuitem>Save</guimenuitem>
0256                                 </menuchoice></term>
0257                                 <listitem><para><action>Saves</action> the current game.</para></listitem>
0258                         </varlistentry>
0259                         <varlistentry id="game-menu-pause">
0260                                 <term><menuchoice>
0261                                         <shortcut><keycap>P</keycap></shortcut>
0262                                         <guimenu>Game</guimenu>
0263                                         <guimenuitem>Pause</guimenuitem>
0264                                 </menuchoice></term>
0265                                 <listitem><para><action>Pauses or resumes the game. While the game is paused, all tiles are hidden.</action></para></listitem>
0266                         </varlistentry>
0267                         <varlistentry id="game-menu-highscores">
0268                                 <term><menuchoice>
0269                                         <shortcut><keycombo action="simul">&Ctrl;<keycap>H</keycap></keycombo></shortcut>
0270                                         <guimenu>Game</guimenu>
0271                                         <guimenuitem>Show High Scores</guimenuitem>
0272                                 </menuchoice></term>
0273                                 <listitem><para><action>Shows the high score list.</action>
0274                                 <screenshot>
0275                                         <screeninfo>Show High scores</screeninfo>
0276                                         <mediaobject>
0277                                                 <imageobject><imagedata fileref="highscore.png" format="PNG"/></imageobject>
0278                                                 <textobject><phrase>Show High scores</phrase></textobject>
0279                                         </mediaobject>
0280                                 </screenshot>
0281                                 </para>
0282                                 <para>
0283                                         When your game scores exceed the top ten scores listed, you are prompted to enter your name.
0284                                 </para> </listitem>
0285                         </varlistentry>
0286                         <varlistentry id="game-menu-boardeditor">
0287                                 <term><menuchoice>
0288                                 <guimenu>Game</guimenu>
0289                                 <guimenuitem>Board Editor</guimenuitem>
0290                                 </menuchoice></term>
0291                                 <listitem><para><action>Shows the board editor.</action>
0292                                 <screenshot>
0293                                         <screeninfo>The board editor</screeninfo>
0294                                         <mediaobject>
0295                                                 <imageobject><imagedata fileref="boardeditor.png" format="PNG"/></imageobject>
0296                                                 <textobject><phrase>The board editor</phrase></textobject>
0297                                         </mediaobject>
0298                                 </screenshot>
0299                                 </para>
0300                                         <para>
0301                                                 Procedure to edit layout:
0302                                                 <orderedlist>
0303                                                         <listitem><para>Use the board editor toolbar to create a new layout or to load and edit an existing one.</para></listitem>
0304                                                         <listitem><para>Save the layout in your user's local home folder in <filename>$<envar>XDG_DATA_HOME</envar>/kmahjongg/layouts</filename></para></listitem>
0305                                                         <listitem><para>Create the <filename><replaceable>name_of_your_layout</replaceable>.desktop</filename> file in the same folder.</para></listitem>
0306                                                         <listitem><para>Put the following lines in this file using your favorite text editor:
0307                                                                         <programlisting>
0308 [KMahjonggLayout]
0309 Name=<replaceable>name_of_your_layout</replaceable>
0310 Description=<replaceable>description_of_your_layout</replaceable>
0311 VersionFormat=1
0312 Author=<replaceable>your_name</replaceable>
0313 AuthorEmail=<replaceable>your_email</replaceable>
0314 FileName=<replaceable>name_of_your_layout</replaceable>.layout
0315 </programlisting></para></listitem>
0316                                                         <listitem><para>Reload &kmahjongg; to use your new layout.</para></listitem>
0317                                                 </orderedlist>
0318 </para>
0319                                 </listitem>
0320                         </varlistentry>
0321                         <varlistentry>
0322                                 <term><menuchoice>
0323                                         <shortcut><keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo></shortcut>
0324                                         <guimenu>Game</guimenu>
0325                                         <guimenuitem>Quit</guimenuitem>
0326                                 </menuchoice></term>
0327                                 <listitem><para><action>Quits</action> &kmahjongg;.</para></listitem>
0328                         </varlistentry>
0329 
0330                         <varlistentry id="move-menu-undo">
0331                                 <term><menuchoice>
0332                                         <shortcut><keycombo action="simul">&Ctrl;<keycap>Z</keycap></keycombo></shortcut>
0333                                         <guimenu>Move</guimenu>
0334                                         <guimenuitem>Undo</guimenuitem>
0335                                 </menuchoice></term>
0336                                 <listitem><para><action>Undo</action> your last move.</para></listitem>
0337                         </varlistentry>
0338                         <varlistentry id="move-menu-redo">
0339                                 <term><menuchoice>
0340                                         <shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>Z</keycap></keycombo></shortcut>
0341                                         <guimenu>Move</guimenu>
0342                                         <guimenuitem>Redo</guimenuitem>
0343                                 </menuchoice></term>
0344                                 <listitem><para><action>Redo</action> a move that was undone.</para></listitem>
0345                         </varlistentry>
0346                         <varlistentry id="move-menu-hint">
0347                                 <term><menuchoice>
0348                                         <shortcut><keycap>H</keycap></shortcut>
0349                                         <guimenu>Move</guimenu>
0350                                         <guimenuitem>Hint</guimenuitem>
0351                                 </menuchoice></term>
0352                                 <listitem><para><action>Gives a Hint</action> by flashing a matching pair of tiles.</para></listitem>
0353                         </varlistentry>
0354                         <varlistentry id="move-menu-demo">
0355                                 <term><menuchoice>
0356                                         <shortcut><keycap>D</keycap></shortcut>
0357                                         <guimenu>Move</guimenu>
0358                                         <guimenuitem>Demo</guimenuitem>
0359                                 </menuchoice></term>
0360                                 <listitem><para><action>Starts the game Demo</action> mode.</para></listitem>
0361                         </varlistentry>
0362                         <varlistentry id="move-menu-shuffle">
0363                                 <term><menuchoice>
0364                                         <guimenu>Move</guimenu>
0365                                         <guimenuitem>Shuffle</guimenuitem>
0366                                 </menuchoice></term>
0367                                 <listitem><para><action>Shuffles the tiles</action> on the board.</para></listitem>
0368                         </varlistentry>
0369 
0370                         <varlistentry id="view-menu-rotate-c">
0371                                 <term><menuchoice>
0372                                         <shortcut><keycap>G</keycap></shortcut>
0373                                         <guimenu>View</guimenu>
0374                                         <guimenuitem>Rotate View Clockwise</guimenuitem>
0375                                 </menuchoice></term>
0376                                 <listitem><para><action>Rotates</action> the tile viewing angle clockwise.</para></listitem>
0377                         </varlistentry>
0378                         <varlistentry id="view-menu-rotate-cc">
0379                                 <term><menuchoice>
0380                                         <shortcut><keycap>F</keycap></shortcut>
0381                                         <guimenu>View</guimenu>
0382                                         <guimenuitem>Rotate View Counterclockwise</guimenuitem>
0383                                 </menuchoice></term>
0384                                 <listitem><para><action>Rotates</action> the tile viewing angle counter clockwise.</para></listitem>
0385                         </varlistentry>
0386                 </variablelist>
0387 <para>
0388 Additionally &kmahjongg; has the common &kde; <guimenu>Settings</guimenu> and <guimenu>Help</guimenu>
0389 menu items, for more information read the sections about the <ulink url="help:/fundamentals/menus.html#menus-settings"
0390 >Settings Menu</ulink> and <ulink url="help:/fundamentals/menus.html#menus-help">Help Menu</ulink>
0391 of the &kde; Fundamentals.
0392 </para>
0393 
0394 </sect1>
0395 </chapter>
0396 
0397 
0398 <chapter id="faq"><title>Frequently asked questions</title> <!-- do not change this! -->
0399 <!--This chapter is for frequently asked questions. Please use <qandaset> <qandaentry> only!-->
0400 <qandaset>
0401 <!--Following is a standard list of FAQ questions.-->
0402         <qandaentry>
0403                  <question><para>I want to change the way this game looks. Can I? </para></question>
0404                  <answer><para>Yes. To change the way &kmahjongg; looks use the <link linkend="menu">menubar</link> to open the <link linkend="configuration">configuration utility</link>.</para></answer>
0405         </qandaentry>
0406         <qandaentry>
0407                  <question><para>Can I use the keyboard to play the game?</para></question>
0408                  <answer><para>No. This game does not feature a keyboard play mode yet.</para></answer>
0409         </qandaentry>
0410 <!--Please add more Q&As if needed-->
0411 
0412 </qandaset>
0413 </chapter>
0414 
0415 <chapter id="configuration"><title>Game Configuration</title> <!-- do not change this! -->
0416 <!--This section describes configuration &GUI;. If your game is configured using menubar exclusively, please remove this section.-->
0417 <screenshot>
0418 <screeninfo>Configure Dialog</screeninfo>
0419         <mediaobject>
0420           <imageobject>
0421             <imagedata fileref="config.png" format="PNG"/>
0422           </imageobject>
0423           <textobject>
0424             <phrase>Configure Dialog</phrase>
0425           </textobject>
0426         </mediaobject>
0427 </screenshot>
0428 
0429 <para><menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure &kmahjongg;...</guimenuitem></menuchoice> opens the <guilabel>Configure - &kmahjongg;</guilabel> dialog.</para>
0430 
0431 <sect1 id="general-options"><title>General options</title>
0432         <variablelist>
0433                 <varlistentry>
0434                         <term><guilabel>Blink matching tiles when first one is selected</guilabel></term>
0435                         <listitem><para>
0436                                 This setting will make the game highlight the selected tile on mouse click, and flash any matching tiles that have a free side at each move. No additional tiles will be highlighted if there are no matching tiles with a free side.
0437                         </para></listitem>
0438                 </varlistentry>
0439                 <varlistentry>
0440                         <term><guilabel>Generate solvable games</guilabel></term>
0441                         <listitem><para>
0442                                 Selects only games that can be solved when you start a new game.
0443                         </para></listitem>
0444                 </varlistentry>
0445                 <varlistentry>
0446                         <term><guilabel>Show removed tiles</guilabel></term>
0447                         <listitem><para>
0448                                 If checked, this setting allows &kmahjongg; to show the removed tiles on the board.
0449                         </para></listitem>
0450                 </varlistentry>
0451         </variablelist>
0452 </sect1>
0453 
0454 <sect1 id="layout-options"><title>Board layout options</title>
0455         <variablelist>
0456                 <varlistentry>
0457                         <term><guilabel>Random Layout</guilabel></term>
0458                         <listitem><para>Every new game will have a random layout of the existing one in the list.
0459                         </para></listitem>
0460                 </varlistentry>
0461                 <varlistentry>
0462                         <term><guilabel>Board Layout</guilabel> selector</term>
0463                         <listitem><para>
0464                                 Use the <guilabel>Board Layout</guilabel> selector to pick a gameboard to play. Different boards provide variable difficulty, depending on the number of tiles and their position.
0465                         </para>
0466                         <screenshot>
0467                                 <screeninfo>Board Layout selector</screeninfo>
0468                                 <mediaobject>
0469                                         <imageobject>
0470                                                 <imagedata fileref="config_layout.png" format="PNG"/>
0471                                         </imageobject>
0472                                         <textobject><phrase>Board Layout selector</phrase></textobject>
0473                                 </mediaobject>
0474                         </screenshot>
0475                         </listitem>
0476                 </varlistentry>
0477         </variablelist>
0478 </sect1>
0479 
0480 <sect1 id="tiles-options"><title>Tiles options</title>
0481         <variablelist>
0482                 <varlistentry>
0483                         <term><guilabel>Tiles</guilabel> selector</term>
0484                         <listitem><para>
0485                                 Use the <guilabel>Tiles</guilabel> selector to choose graphics for the tiles.
0486                         </para>
0487                         <screenshot>
0488                                 <screeninfo>Tile selector</screeninfo>
0489                                 <mediaobject>
0490                                         <imageobject>
0491                                                 <imagedata fileref="config_tiles.png" format="PNG"/>
0492                                         </imageobject>
0493                                         <textobject><phrase>Tiles selector</phrase></textobject>
0494                                 </mediaobject>
0495                         </screenshot>
0496                         </listitem>
0497                 </varlistentry>
0498         </variablelist>
0499 </sect1>
0500 
0501 <sect1 id="background-options"><title>Background options</title>
0502         <variablelist>
0503                 <varlistentry>
0504                         <term><guilabel>Background</guilabel> selector</term>
0505                         <listitem><para>
0506                                 Use the <guilabel>Background</guilabel> selector to choose a background graphic for the game.
0507                         </para>
0508                         <screenshot>
0509                                 <screeninfo>Background selector</screeninfo>
0510                                 <mediaobject>
0511                                         <imageobject>
0512                                                 <imagedata fileref="config_background.png" format="PNG"/>
0513                                         </imageobject>
0514                                         <textobject><phrase>Background selector</phrase></textobject>
0515                                 </mediaobject>
0516                         </screenshot>
0517                         </listitem>
0518                 </varlistentry>
0519         </variablelist>
0520 </sect1>
0521 
0522 <sect1 id="default-keybindings">
0523 <title>Default Keybindings</title>
0524 
0525 <para><menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure Shortcuts...</guimenuitem></menuchoice> allows you to change the default keyboard bindings.</para>
0526 
0527 <para>
0528 The default kebindings are as follows:
0529 </para>
0530 
0531 <table>
0532 <title>Keyboard Shortcuts</title>
0533 <tgroup cols="2">
0534 <thead><row><entry>Key Combo</entry><entry>Action</entry></row></thead>
0535 <tbody>
0536 <row><entry><keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo></entry><entry>Starts a new game</entry></row>
0537 <row><entry><keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo></entry><entry>Loads a previously saved game</entry></row>
0538 <row><entry><keycap>F5</keycap></entry><entry>Restart the game</entry></row>
0539 <row><entry><keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo></entry><entry>Saves the game</entry></row>
0540 <row><entry><keycap>P</keycap></entry><entry>Pauses or resumes a game</entry></row>
0541 <row><entry><keycombo action="simul">&Ctrl;<keycap>H</keycap></keycombo></entry><entry>Show the highscores</entry></row>
0542 <row><entry><keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo></entry><entry>Quits the game</entry></row>
0543 <row><entry><keycombo action="simul">&Ctrl;<keycap>Z</keycap></keycombo></entry><entry>Move undo</entry></row>
0544 <row><entry><keycombo action="simul">&Ctrl;&Shift;<keycap>Z</keycap></keycombo></entry><entry>Move redo</entry></row>
0545 <row><entry><keycap>H</keycap></entry><entry>Gives you a hint by flashing two matching tiles</entry></row>
0546 <row><entry><keycap>D</keycap></entry><entry>Plays the game in Demo mode</entry></row>
0547 <row><entry><keycap>G</keycap></entry><entry>Rotate the view angle clockwise</entry></row>
0548 <row><entry><keycap>F</keycap></entry><entry>Rotate the view angle counter-clockwise</entry></row>
0549 <row><entry><keycap>F1</keycap></entry><entry>Displays this handbook</entry></row>
0550 <row><entry><keycombo action="simul">&Shift;<keycap>F1</keycap></keycombo></entry><entry>What's This Help</entry></row>
0551 
0552 </tbody>
0553 </tgroup>
0554 </table>
0555 
0556 </sect1>
0557 </chapter>
0558 
0559 <chapter id="credits"><title>Credits and License</title> <!-- do not change this! -->
0560 <!--This chapter is for credits and licenses.-->
0561         <para>
0562                 &kmahjongg; by &kde;
0563         </para>
0564 
0565         <para>
0566                 Program Copyright &copy; 1997 <personname><firstname>Mathias</firstname><surname>Mueller</surname></personname> <email>in5y158@public.uni-hamburg.de</email>
0567         </para>
0568         <para>
0569                 Program Copyright &copy; 2007 &Mauricio.Piacentini; &Mauricio.Piacentini.mail;
0570         </para>
0571         <para>
0572                 Contributors:
0573                 <itemizedlist>
0574                         <listitem><para><personname><firstname>David</firstname><surname>Black</surname></personname> <email>david.black@lutris.com</email></para></listitem>
0575                         <listitem><para><personname><firstname>Michael</firstname><surname>Haertjens</surname></personname> <email>mhaertjens@modusoperandi.com</email></para></listitem>
0576                         <listitem><para><personname><firstname>Osvaldo</firstname><surname>Stark</surname></personname> <email>starko@dnet.it</email></para></listitem>
0577                         <listitem><para><personname><firstname>Benjamin</firstname><surname>Meyer</surname></personname> <email>ben+kmahjongg@meyerhome.net</email></para></listitem>
0578                         <listitem><para>&Albert.Astals.Cid; &Albert.Astals.Cid.mail;</para></listitem>
0579                         <listitem><para><personname><firstname>Raquel</firstname><surname>Ravanini</surname></personname> <email>raquel@tabuleiro.com</email></para></listitem>
0580                 </itemizedlist>
0581         </para>
0582         <para>
0583                 Documentation Copyright &copy; 2005 <personname><firstname>John</firstname><surname>Hayes</surname></personname> <email>justlinux@bellsouth.net</email>
0584         </para>
0585 
0586 <!-- !!!do not change ANYTHING after this line!!!! -->
0587 <!-- TRANS:CREDIT_FOR_TRANSLATORS -->
0588 &underFDL;
0589 &underGPL;
0590 
0591 </chapter>
0592 
0593 &documentation.index;
0594 </book>
0595 <!--
0596 Local Variables:
0597 mode: sgml
0598 sgml-minimize-attributes:nil
0599 sgml-general-insert-case:lower
0600 sgml-omittag:t
0601 sgml-shorttag:t
0602 sgml-namecase-general:t
0603 sgml-always-quote-attributes:t
0604 sgml-indent-step:0
0605 sgml-indent-data:nil
0606 sgml-parent-document:nil
0607 sgml-exposed-tags:nil
0608 sgml-local-catalogs:nil
0609 sgml-local-ecat-files:nil
0610 End:
0611 -->