Warning, /games/kajongg/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   <!ENTITY s1 "s1">
0007   <!ENTITY s9 "s9">
0008   <!ENTITY b1 "b1">
0009   <!ENTITY b9 "b9">
0010   <!ENTITY c1 "c1">
0011   <!ENTITY c9 "c9">
0012   <!ENTITY we "we">
0013   <!ENTITY ws "ws">
0014   <!ENTITY ww "ww">
0015   <!ENTITY wn "wn">
0016   <!ENTITY db "db">
0017   <!ENTITY dr "dr">
0018   <!ENTITY dg "dg">
0019   <!ENTITY chow "chow">
0020   <!ENTITY pung "pung">
0021   <!ENTITY kong "kong">
0022   <!ENTITY mahjongg "mahjongg">
0023   <!ENTITY originalcall "originalcall">
0024   <!ENTITY violatesoriginalcall "violatesoriginalcall">
0025   <!ENTITY dangerousgame "dangerousgame">
0026   <!ENTITY nochoice "nochoice">
0027 ]>
0028 
0029 <!-- TODO: describe the window with the list of tables -->
0030 
0031 <book id="kajongg" lang="&language;"> <!-- do not change this! -->
0032 <bookinfo>
0033         <title>The &kajongg; Handbook</title> <!-- This is the title of this docbook. -->
0034 <!-- List of immidiate authors begins here. -->
0035 <!--INPORTANT! - All other contributors: [to be determined] -->
0036 <authorgroup>
0037 <author>
0038         &Wolfgang.Rohdewald; &Wolfgang.Rohdewald.mail;
0039 </author>
0040 <!-- TRANS:ROLES_OF_TRANSLATORS -->
0041 </authorgroup>
0042 <legalnotice>&FDLNotice;</legalnotice>
0043 
0044 <date>2021-05-30</date><!-- Date of (re)writing, or update.-->
0045 <releaseinfo>KDE Gear 21.04</releaseinfo>
0046 
0047 <!--Short description of this document. Do not change unless necessary!-->
0048 <abstract>
0049         <para>This documentation describes the game of &kajongg;</para>
0050 </abstract>
0051 
0052 <!--List of relevant keywords-->
0053 <keywordset>
0054         <keyword>KDE</keyword> <!-- do not change this! -->
0055         <keyword>kdegames</keyword> <!-- do not change this! -->
0056         <keyword>game</keyword> <!-- do not change this! -->
0057         <keyword>kajongg</keyword><!--Application name goes here-->
0058 <!-- Game genre. Use as many as necessary. Available game types are: Arcade, Board, Card, Dice, Toys, Logic, Strategy.-->
0059         <keyword>board</keyword>
0060         <keyword>arcade</keyword>
0061         <keyword>tile game</keyword>
0062         <keyword>tiles</keyword>
0063 <!--Number of possible players. It can be: One, Two,..., Multiplayer-->
0064         <keyword>four players</keyword>
0065 <!--All other relevant keywords-->
0066 </keywordset>
0067 </bookinfo>
0068 <!--Content begins here: -->
0069 <chapter id="introduction"><title>Introduction</title> <!-- do not change this! -->
0070         <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.-->
0071         <note><title>Number of possible players:</title><para>Four</para></note><!--Number of possible players. It can be: One, Two,..., Multiplayer-->
0072         <para>
0073                 &kajongg; is a board game created after the famous oriental game of Mah Jong (from Chinese <foreignphrase lang="zh">麻將</foreignphrase>). It is played by four players. Worldwide many different rulesets are in use. Right now &kajongg; supports the Classical Chinese rules as played in Germany, eventually other main rulesets will follow. It is possible to customize or add new rulesets. Please do so and send them to the program author for integration!
0074         </para>
0075         <para>
0076                 &kajongg; can be used in two different ways: Scoring a manual game where you play as always without the help of a computer and use &kajongg; for the computation of scores and for bookkeeping. Or you can use &kajongg; to play against any combination of other human players or computer players.
0077 
0078         </para>
0079 </chapter>
0080 
0081 <chapter id="screen_layout"><title>The Screen Layout</title>
0082                 <para>
0083                         <screenshot>
0084                                 <screeninfo>A screenshot of &kajongg;</screeninfo>
0085                                 <mediaobject>
0086                                         <imageobject>
0087                                                 <imagedata fileref="gamescreen.png" format="PNG"/>
0088                                         </imageobject>
0089                                         <textobject><phrase>Screenshot</phrase></textobject>
0090                                 </mediaobject>
0091                         </screenshot>
0092                 </para>
0093                 <para>
0094                         A quick explanation of the parts of the game screen.
0095                 </para>
0096         <variablelist>
0097                 <varlistentry>
0098                         <term>Toolbar</term>
0099                         <listitem><para>
0100                                 The Toolbar is located beneath the menubar and contains buttons for the most often used actions. The content of the Toolbar can be edited. You can also make it invisible, giving more room to the Board.
0101                               </para><para>
0102                                 Depending on the size of your screen you may want to make the toolbar invisible or to move it to the left side of the window. You can do that by click with the &RMB; on the toolbar.
0103                               </para></listitem>
0104                 </varlistentry>
0105                 <varlistentry>
0106                         <term>Board</term>
0107                         <listitem><para>
0108                                 The Board is the largest section of the window. You see the four walls with a length of 18 tiles (the exact number depends on the rules like using bonus tiles or not).
0109                                 The names of the players are written on the walls, together with the current value of the hand (as far as known) and their wind tiles. The prevailing wind has a coloured background, east in the screenshot above.
0110                         </para><para>
0111                                 When <link linkend="play">playing</link>, the interior of the walls holds the tiles discarded by the players. They are randomly placed. The last discarded tile has a blue focus frame.
0112                         </para><para>
0113                                 When <link linkend="scoreGame">scoring manual games</link>, the interior of the walls has a selection of all available tiles, the central selector. You can assign them to the players using the mouse or the keyboard.
0114                         </para>
0115                         </listitem>
0116                 </varlistentry>
0117                 <varlistentry>
0118                         <term>Player Region</term>
0119                         <listitem><para>
0120                                 Every player has a screen range for her tiles. The upper row contains exposed tiles, the lower row concealed tiles.
0121                                 When <link linkend="scoreGame">scoring manual games</link>, concealed tiles are shown with a shadow over the entire tile.
0122                                 Bonus tiles go to the right end.
0123                         </para></listitem>
0124                 </varlistentry>
0125                 <varlistentry>
0126                         <term>Dialog</term>
0127                         <listitem><para>
0128                                 The dialog presents choices the player has. Most often it has a timeout with a progress bar showing the remaining time.
0129                         </para></listitem>
0130                 </varlistentry>
0131                 <varlistentry>
0132                         <term>Status bar</term>
0133                         <listitem><para>
0134                                 The Status bar is located at the bottom of the screen and contains the current totals for the players.
0135                         </para></listitem>
0136                 </varlistentry>
0137         </variablelist>
0138 </chapter>
0139 
0140 <chapter id="scoreGame"><title>Scoring a Manual Game</title> <!-- do not change this! -->
0141         <para>
0142                 In this mode, &kajongg; is only used to do the scoring. You play as usual with real people on a real table and at the end of a game you can tell &kajongg; the tiles a player has in her hand and everything else &kajongg; needs to know for calculating the scores - which is what the program will do. Alternatively you can calculate the hand scores manually and enter them. &kajongg; will then make the payments amongst the players and write the results into a data base. It is possible to suspend a game, start another game with other players and resume old games. All rules will be saved together with the games, so different games can be played with different rules.
0143         </para>
0144         <itemizedlist>
0145             <listitem><para>
0146                     From the menu, select <menuchoice><guimenu>Game</guimenu> <guimenuitem>Score Manual Game</guimenuitem></menuchoice> or press <keycombo action="simul">&Ctrl;<keycap>C</keycap></keycombo>.
0147             </para></listitem>
0148             <listitem><para>
0149                     Now you can either select an existing unfinished game or start a new game. If you start a new game, you will be asked for the players and the ruleset. &kajongg; will propose the same values used for the previous game. If there was no previous game, it will propose the first four defined players. Please note that you cannot change the ruleset or any of its rules after this selection. You can do that beforehand in <link linkend="ruleset-options">the ruleset editor</link>.
0150             </para></listitem>
0151             <listitem><para>
0152                 Now you get a new window titled <guilabel>Scoring for this Hand</guilabel>. Read <link linkend="enterhand-tiles">Have &kajongg; compute the score</link> for a detailed description.
0153             </para></listitem>
0154             <listitem><para>
0155                 After saving hand results, continue with the next hand.
0156             </para></listitem>
0157         </itemizedlist>
0158       <sect1 id="enterhand"><title>Entering hand results</title>
0159         <sect2 id="enterhand-scores">
0160         <title>Scores</title>
0161         <screenshot>
0162                 <screeninfo>A screenshot of &kajongg;</screeninfo>
0163                 <mediaobject>
0164                         <imageobject>
0165                                 <imagedata fileref="enterhand.png" format="PNG"/>
0166                         </imageobject>                          <textobject><phrase>Screenshot</phrase></textobject>
0167                 </mediaobject>
0168         </screenshot>
0169         <para>
0170                 This is the window for entering hand results. It automatically shows itself when &kajongg; thinks you might need it. You can always show or hide it by pressing  <keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo> or by selecting the corresponding menu entry.
0171         </para>
0172         <para>
0173                 As always the prevailing wind has its background colored.
0174         </para>
0175         <para>
0176                 Here you can manually enter scores for all players. Alternatively you can exactly define which tiles a player had in her hand. If you choose to do that, the corresponding field for the manual score value will be grayed out. &kajongg; will automatically compute the score.
0177         </para>
0178         <para>
0179                 After having entered all relevant data for a hand, press the button <guibutton>Save Hand</guibutton>. The hand values will be entered in the data base, and they are also shown in the score table. You might be prompted to change the seating positions of the players but you can choose not to change seats. The proposed changes are currently not customizable - if a ruleset needs something different, we will change that.
0180         </para>
0181         <para>
0182                 If the player might have won, the check box in the column <guilabel>Winner</guilabel> will be enabled - click this for the winner.
0183         </para>
0184         <para>
0185                 The status bar will now show the updated balances for the players, and you can continue with the next hand.
0186         </para>
0187         <sect3 id="enterhand-manually">
0188         <title>Enter the score manually</title>
0189         <para>
0190                 A good player will probably prefer to compute her score himself. In that case you can directly enter it. This is only possible when no tiles are selected for this player.
0191         </para>
0192         <para>
0193                 If you enter a manual score, it must already contain everything except penalties, you will have no optional rules to choose from. There is one exception: <quote>Dangerous Game</quote>. This does not influence any scores, it is no offense either. It only means the payment between players is different: The offender pays all for all to the winner. The other two players do not exchange payments. This is currently not customizable.
0194         </para>
0195         </sect3>
0196         <sect3 id="enterhand-tiles">
0197         <title>Have &kajongg; compute the score</title>
0198         <para>
0199                 If you explicitly tell &kajongg; what tiles a player holds, entering scores will be grayed out for that player in this window. While associating tiles with a player you will see how her score will grow - but as soon as you add the 14th tile the score goes to zero. That might surprise you but unless you declare this as the winner hand, it is recognized as a long hand which always has zero points. This behaviour is defined by the Classical Chinese ruleset, it might be different if you change the rules or use a different ruleset.
0200         </para>
0201         <para>
0202                 You can associate tiles and melds with a player using either the mouse or the keyboard or both. With the mouse simply move tiles by dragging/dropping them to the player region. When dropping the tile, you will be asked what you want to move: Single, Pair, Pung, Kong, Claimed Kong or Chow. The upper row is for exposed tiles, the lower row for concealed tiles. The bonus tiles will appear to the far right. You can also move tiles and melds between rows, between players and back to the central selector.
0203         </para>
0204         <para>
0205                 If you prefer using the keyboard, you can use &Tab; to move between the central selector and the player regions. The keys <keycap>eswnESWN</keycap> move a tile to the players East, South, West and North.
0206                 The keys <keycap>xX</keycap> move it back to the central selector. <keycap>ESWN</keycap> moves to the concealed row, <keycap>eswn</keycap> moves to the exposed row.
0207                 You can move the cursor between tiles or melds using the arrow keys, the currently selected tile or meld has a blue frame. Since the key arrows are far away from letters on the keyboard,
0208                 you can also use the letters <keycap>hjkl</keycap> or <keycap>HJKL</keycap> for moving the cursor. <keycap>hH</keycap> move left, <keycap>jJ</keycap> move down, <keycap>kK</keycap> move up,
0209                 <keycap>lL</keycap> move right. This is how the unix editor <command>vi</command> does it. The &kde; browser &konqueror; and even this help program also support those keys in the same way. Those keys may differ if you use a language other than English but it is currently not possible to configure them.
0210         </para>
0211         <para>
0212                 The options <guilabel>Last Tile:</guilabel> and <guilabel>Last Meld:</guilabel> are needed by some rules like <guilabel>Last tile completes pair</guilabel>. They can only be used for the winner hand.
0213         </para>
0214         <para>
0215                 In the right part of the window you can manually apply some rules. What rules appear in this list depends on the current ruleset and on the tiles. In the example of the above screen shot, the losing players might have an option <quote>dangerous game</quote> - again depending on the ruleset and on their tiles. It is the aim of the developers to keep this list of manually selectable rules as short as possible. Optimally &kajongg; should always be able to automatically determine whether a rule applies, but sometimes &kajongg; does not have enough information or knowledge to decide.
0216         </para>
0217         </sect3>
0218         </sect2>
0219         <sect2 id="enterhand-penalties">
0220         <title>Penalties</title>
0221                         <screenshot>
0222                                 <screeninfo>A screenshot of &kajongg;</screeninfo>
0223                                 <mediaobject>
0224                                         <imageobject>
0225                                                 <imagedata fileref="penalty.png" format="PNG"/>
0226                                         </imageobject>
0227                                         <textobject><phrase>Screenshot</phrase></textobject>
0228                                 </mediaobject>
0229                         </screenshot>
0230         <para>
0231         In the <link linkend="enterhand">window for entering hand results</link>, the <guibutton>Penalties</guibutton> button will bring up this window where you can enter penalties. This can be done at any point in time independent of the normal scoring mechanism.</para>
0232         <para>The <guilabel>Offense:</guilabel> selection shows all offenses that might be applicable to the hands the players hold. Choose among them.</para>
0233         <para>Now you can adapt the <guilabel>Total Penalty</guilabel>. This is the total sum that is moved from payers to payees. It will be evenly split between them.</para>
0234         <para>Depending on the type of offense, the number of payers and payees varies. The right number of players is displayed. If you select a player, &kajongg; ensures that this player only occurs once by adapting the other players.
0235         </para>
0236         </sect2>
0237         </sect1>
0238 </chapter>
0239 
0240 <chapter  id="play"><title>Playing</title>
0241         <para>At any time, you can enable or disable the Demo Mode. In Demo Mode, the computer will play for you. If no game is currently
0242           played, a new game will be started with the last used ruleset.
0243         </para>
0244         <sect1 id="robotplay">
0245         <title>Play against the computer</title>
0246          <para>
0247             First you will get a login dialog. Enter the game server you want to connect to and your user name. If you choose the special entry <guilabel>Local Game</guilabel>,
0248             you only need to enter your name (or accept the proposed name) and the wanted ruleset. This will immediately start a local game where you play
0249             against 3 robot players. However if suspended games exist, they will be displayed in a list. You can then select the game you want to continue with
0250             or start a new game.
0251         </para>
0252         </sect1>
0253         <sect1 id="humanplay">
0254         <title>Play with friends</title>
0255         <para>
0256            If you want to play against other real people, you need a game server to which all players, including yourself, need to connect. Do that by
0257             selecting any other host or by manually entering a new host name and by specifying your password for that host. The last used password will be
0258             proposed.
0259         </para><para>
0260             The easiest way is to use the game server at <literal>kajongg.org</literal>. &kajongg; will show this one in the list of possible game servers.
0261             Please note that this server only offers a game server but no web page or any other services.
0262         </para><para>
0263           If you do not have an account on the game server with the name you entered, you will be asked if you want to open an account. If you say yes, you will get a
0264           new dialog where you can enter the wanted password twice. Your account will be created automatically.
0265         </para><para>
0266             After a successful login onto the game server, you will get a list of tables with available seats on that game server. Join a table or allocate a new table.
0267             If you allocate a new table, wait until more seats are taken by other players. You can start the game on a table you allocated at any time, the seats
0268             not taken will be filled by robot players.
0269         </para><para>
0270           The table list also shows the name of the ruleset played on that table. The ruleset and its name are sent to the game server by the player initiating the table.
0271           If you have an identical ruleset, the table shows your name for the ruleset - this might be helpful if the table initiator speaks another language and named
0272           the ruleset differently. Also, if the name of your local ruleset is displayed, it is displayed in black. If however you have no identical ruleset, the name
0273           appears in red, and you can use the button <guibutton>Compare</guibutton> to compare it with your own rulesets.
0274         </para><para>
0275            If you do not use <literal>kajongg.org</literal> or any other existing game server, you can start your own &kajongg;  game server in two different ways:
0276             <itemizedlist><listitem><para>
0277                  connect to the server <literal>localhost</literal>. This is your own computer. If you do this and no game server is running, it will be started automatically. And when
0278                  you stop playing, the server will be stopped too. This differs from selecting <guilabel>Local Game</guilabel>, the latter does not allow connections from other computers.
0279             </para></listitem><listitem><para>
0280                 manually start a server on any computer you want. All you need to do is go to a command line and start
0281             the program <command>kajonggserver</command>. Entering <command>kajonggserver --help</command>
0282             will show you all available options like changing the default port. This server will run until you kill it.
0283             </para></listitem></itemizedlist>
0284         </para><para>
0285             In both cases you need to tell the other players  how they can reach your game server. They need the &URL; or simply an IP address and the port your server is
0286             listening on. This might be something like <literal>mypc.dyndns.org:8301</literal> where <literal>8301</literal> is the port. Of course you need to configure your firewall such that the remote
0287             player can reach that port. The communication will be encrypted.
0288             </para><para>
0289             For the port number, please see <menuchoice><guimenu>Help</guimenu> <guimenuitem>About &kajongg;</guimenuitem></menuchoice>. The Protocol version is the port number. For &kajongg; 17.04 this is 8301.
0290             If the player enters no port for the wanted game server, the client computes the port in the same way.
0291             So if a computer runs several game servers with different protocol versions, you should normally reach the correct game server automatically.
0292             Anyway the game server and the client will make sure that their versions are compatible and warn you otherwise.
0293          </para><para>
0294             If you encounter possible bugs, you might want to use the option <command>kajongg --debug=traffic</command>. This will show you, on the console where the game server has been started,
0295             what messages are flowing between the game server and the clients. For more options, see <command>kajongg --help</command>
0296         </para>
0297         <sect2 id="playing-caveats">
0298         <title>Caveats</title>
0299             <itemizedlist><listitem><para>
0300                 If you want to make sure nobody can cheat none of the human players should have access to the computer  the game server is running on. Of course you can never avoid that two players help each other because you cannot know what they really are doing. Two players might even be one and the same person.
0301             </para></listitem></itemizedlist>
0302         </sect2>
0303         </sect1>
0304 <sect1  id="gamerules"><title>Game rules</title>
0305 <para>Worldwide, many different game variants exist. Currently, &kajongg; supports two variants of Classical Chinese, one as played in Germany and one as played in Great Britain.</para><para>
0306   This description does not go into details and as such matches both variants.</para><para>
0307   However most of the basic rules are the same in most variants.</para>
0308   <para>Since the program &kajongg; knows how to play, this description only contains things that might not be obvious.</para>
0309   <para>If you want to learn Mah Jong in more detail, please consult the <link linkend="bibliography">bibliography</link>.</para>
0310 <sect2 id="gamerules-aim">
0311   <title>The aim of the game</title>
0312   <para>Each player tries to collect tiles such that she has a winning hand. On achieving this, she calls <quote>Mah Jong</quote>. In a winning hand, the tiles are normally grouped into five melds: Four
0313     melds with three or four tiles each and a fifth meld consisting of two equal tiles. A normal meld has three or four identical tiles (called Pung
0314     and Kong respectively) or three successive tiles like Bamboo 3, Bamboo 4, Bamboo 5 (called Chow).</para>
0315   </sect2>
0316   <sect2>
0317     <title>The course of the game</title>
0318     <para>
0319       Initially, the player with the East wind (as indicated on the wall) has one more tile than the other players. East begins by discarding an unwanted tile.
0320       </para>
0321     <para>
0322       Whenever a tile has been discarded, other players can claim it by saying what they can complete with that tile (Chow, Pung, Kong, Mah Jong).
0323       Only the next player can claim a Chow - the other claims are possible for all players. A meld completed by a claim will be exposed - made visible
0324       to all players.
0325     </para><para>
0326       If nobody claims the discarded tile, the next player, South (and then West and North) gets a tile from the wall and discards an unwanted tile.</para>
0327       <para>There are several rules about when a Pung can be extended to a Kong (by claiming the forth tile or by getting it from the wall) - these rules
0328         are not explained here. But &kajongg; of course knows them and makes sure they are respected. If a Kong is declared, the player automatically gets
0329         a replacement tile from the wall - otherwise it would not be possible to build the five melds as mentioned above.
0330       </para>
0331     </sect2>
0332     <sect2>
0333       <title>Year, Round and Hand</title><para>
0334       When a player claims Mah Jong or we end up in a draw, a hand is completed. Now, except for draws, the winds rotate among the players.
0335       This is repeated until every player once had every wind. This entire unit is called a round. An entire game, also called year, consists of four such rounds:
0336       East wind round, South wind round, West wind round, North wind round. The wind of a round is also called prevailing wind, it can result in
0337         higher scores.</para>
0338         <para>So a full game (a year) consists of at least 16 hands. Since the winds do not rotate for draws or when the East player says Mah Jong, a higher
0339           number of hands is normally needed for a full game.
0340     </para></sect2><sect2><title>Bonus tiles</title>
0341     <para>A game can contain eight bonus tiles (unless the rules exclude them). They are exposed separately on the right side of the player region
0342       as they are never used for building melds. They do however generate bonus points.</para>
0343       <para>If a player gets a bonus tile, she will automatically also get a replacement tile from the wall. And a bell rings.</para></sect2>
0344       <sect2><title>Scoring</title><para>
0345         At the end of a hand, the score for each player is computed. First, basis points are counted like 2 points for a simple exposed pung or 20 points
0346         for winning. Next, another set of rules is applied - those rules can double the points like one double for a meld of dragons. When the score for
0347         each hand is known, differences are paid between players - while the winner gets its full score paid from all other players. East always gets and
0348           pays twice her score.</para>
0349           <para>Of course &kajongg; knows about all applicable rules but a good player knows what combinations get what score so she can optimize.
0350             While learning it is recommended to activate the window <guimenuitem>Explain Scores</guimenuitem>.</para>
0351           <para>The exact scoring rules often vary - in &kajongg; you are free to change them with the <link linkend="ruleset-options">the ruleset editor</link>.</para>
0352           <para>The ruleset editor also shows you all available rules and their meaning. Place the mouse over them and for the
0353             more exotic rules help text will appear.</para>
0354         </sect2>
0355 </sect1>
0356 <sect1 id="playing-play">
0357         <title>How to play with &kajongg;</title>
0358         <para>
0359             You will be prompted for what you want to do. This is a little dialog which appears either on the right or at the bottom depending on the size of the window. If
0360             you make it broader than  high, the dialog appears on the right. Sometimes the dialog will have a timeout - when it is over, the first possible answer is automatically selected for you.
0361             This timeout is configurable in the Ruleset Editor, under <guilabel>Options</guilabel>, <guilabel>Claim Timeout</guilabel>.
0362             All players should have the same timeout, that is why this is part of the ruleset.
0363           </para><para>
0364             If you need to select a tile from your hand, you can move between tiles using the &Right; and &Left; arrow keys or the letters <keycap>h</keycap> and <keycap>l</keycap> on your keyboard. Of course you can use the mouse too.
0365           </para><para>
0366             You can discard a tile by using the keyboard the same way as for all actions. Alternatively, you can use the mouse and move the tile from your hand into the
0367             discard area (the interior of the walls). The placement of the tile in the discard area will still be done by the computer - because the placement should be the same for
0368             players.
0369           </para><para>
0370           Often, the dialogs will offer choices which are not really applicable like calling Pung when you do not have the needed tiles. This is intended - just like in a real game.
0371           But you can configure impossible choices away: Disable <guilabel>Show only possible actions</guilabel> on the <guilabel>Play</guilabel> page of the settings dialog.
0372           </para><para>
0373             Discarded tiles are placed randomly between the walls. Some game variants define where the tiles should be placed, this is not yet configurable however. When it becomes configurable, it will be part of the ruleset.
0374         </para>
0375         </sect1>
0376 </chapter>
0377 
0378 <chapter id="interface"><title>Interface Overview</title> <!-- do not change this! -->
0379 <!-- 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.-->
0380 
0381 <sect1 id="menu">
0382 <title>Menu Items</title>
0383 
0384                 <variablelist>
0385                         <varlistentry id="game-menu-scoreGame">
0386                                 <term><menuchoice>
0387                                         <shortcut><keycombo action="simul">&Ctrl;<keycap>C</keycap></keycombo></shortcut>
0388                                         <guimenu>Game</guimenu>
0389                                         <guimenuitem>Score Manual Game</guimenuitem>
0390                                 </menuchoice></term>
0391                                 <listitem><para><action>Only score a manually played game.</action></para><para>You can load an old game or start a new game. By default only pending (&ie; unfinished) games are shown in the selection list. You can optionally show all games including finished games. Here you can also delete games.</para></listitem>
0392                         </varlistentry>
0393                         <varlistentry  id="game-menu-play">
0394                                 <term><menuchoice>
0395                                         <shortcut><keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo></shortcut>
0396                                         <guimenu>Game</guimenu>
0397                                         <guimenuitem>Play</guimenuitem>
0398                                 </menuchoice></term>
0399                                 <listitem><para><action>Play with others (people and computers)</action>.</para></listitem>
0400                         </varlistentry>
0401                         <varlistentry  id="game-menu-abort">
0402                                 <term><menuchoice>
0403                                         <shortcut><keycombo action="simul">&Ctrl;<keycap>W</keycap></keycombo></shortcut>
0404                                         <guimenu>Game</guimenu>
0405                                         <guimenuitem>Abort Game</guimenuitem>
0406                                 </menuchoice></term>
0407                                 <listitem><para><action>Abort the current game. If it was a manual game with scoring only, you can resume it later. If you played using &kajongg;, the game is not yet resumable.</action></para></listitem>
0408                         </varlistentry>
0409                         <varlistentry>
0410                                 <term><menuchoice>
0411                                         <shortcut><keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo></shortcut>
0412                                         <guimenu>Game</guimenu>
0413                                         <guimenuitem>Quit &kajongg;</guimenuitem>
0414                                 </menuchoice></term>
0415                                 <listitem><para><action>Quits</action> &kajongg;.</para></listitem>
0416                         </varlistentry>
0417                         <varlistentry id="view-chat">
0418                                 <term><menuchoice>
0419                                         <shortcut><keycombo action="simul">&Ctrl;<keycap>H</keycap></keycombo></shortcut>
0420                                         <guimenu>View</guimenu>
0421                                         <guimenuitem>Chat</guimenuitem>
0422                                 </menuchoice></term>
0423                                 <listitem><para><action>Chat</action></para>
0424                                 <screenshot>
0425                                         <screeninfo>Chat Window</screeninfo>
0426                                         <mediaobject>
0427                                                 <imageobject>
0428                                                 <imagedata fileref="chat.png" format="PNG"/>
0429                                                 </imageobject>
0430                                                 <textobject>
0431                                                 <phrase>Chat Window</phrase>
0432                                                 </textobject>
0433                                         </mediaobject>
0434                                 </screenshot>
0435                                 <para>
0436                                 Lets you chat with the other players.
0437                                 </para></listitem>
0438                         </varlistentry>
0439                         <varlistentry id="view-scoretable">
0440                                 <term><menuchoice>
0441                                         <shortcut><keycombo action="simul">&Ctrl;<keycap>T</keycap></keycombo></shortcut>
0442                                         <guimenu>View</guimenu>
0443                                         <guimenuitem>Score Table</guimenuitem>
0444                                 </menuchoice></term>
0445                                 <listitem><para><action>Score Table</action></para>
0446                                 <screenshot>
0447                                         <screeninfo>Score Table</screeninfo>
0448                                         <mediaobject>
0449                                                 <imageobject>
0450                                                 <imagedata fileref="scoretable.png" format="PNG"/>
0451                                                 </imageobject>
0452                                                 <textobject>
0453                                                 <phrase>Screenshot</phrase>
0454                                                 </textobject>
0455                                         </mediaobject>
0456                                 </screenshot>
0457     <para>
0458         Show the score table. Round/Hand are the current round (East, South, West, North) followed by a count of the hands played in that round.
0459         The winner has a green background for her values.
0460         The Payments show how much the player paid to or received from all other players with this hand.
0461         The Balance shows the current balance for all players.
0462         The Chart shows the development of the balance values.
0463         The hints give you more details: They show all rules that have been applied to this hand. Just move the mouse over the value you are interested in.</para><para>
0464         The lower part shows the used ruleset. Between the score table and the used ruleset you can find a splitter letting you change the relative sizes of both parts.
0465                         </para></listitem>
0466                         </varlistentry>
0467                         <varlistentry id="view-explain-scores">
0468                                 <term><menuchoice>
0469                                         <shortcut><keycombo action="simul">&Ctrl;<keycap>E</keycap></keycombo></shortcut>
0470                                         <guimenu>View</guimenu>
0471                                         <guimenuitem>Explain Scores</guimenuitem>
0472                                 </menuchoice></term>
0473                                 <listitem><para><action>Explain Scores</action></para>
0474                                 <screenshot>
0475                                         <screeninfo>Score Table</screeninfo>
0476                                         <mediaobject>
0477                                                 <imageobject>
0478                                                 <imagedata fileref="explain.png" format="PNG"/>
0479                                                 </imageobject>
0480                                                 <textobject>
0481                                                 <phrase>Score Table</phrase>
0482                                                 </textobject>
0483                                         </mediaobject>
0484                                 </screenshot>
0485                                 <para>
0486                                 Explains how the score for the current hand was computed.
0487                                 </para></listitem>
0488                         </varlistentry>
0489                         <varlistentry>
0490                                 <term><menuchoice>
0491                                         <shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>F</keycap></keycombo></shortcut>
0492                                         <guimenu>View</guimenu>
0493                                         <guimenuitem>Full Screen Mode</guimenuitem>
0494                                 </menuchoice></term>
0495                                 <listitem><para><action>Switches between full screen mode and normal mode.</action></para></listitem>
0496                         </varlistentry>
0497 
0498                         <varlistentry>
0499                                 <term><menuchoice>
0500                                         <guimenu>Settings</guimenu>
0501                                         <guimenuitem>Players</guimenuitem>
0502                                 </menuchoice></term>
0503                                 <listitem><para><action>Add, modify and delete players.</action></para>
0504                                 <para>The passwords in this table are those used by default when logging onto
0505                                   a game server. Changing the password you initially chose
0506                                   for a game server is not yet really helpful because there is no way yet for you to also change
0507                                   your password on the game server. You would have to ask the administrator of the game
0508                                   server to do that for you directly in the data base.</para></listitem>
0509                         </varlistentry>
0510                         <varlistentry>
0511                                 <term><menuchoice>
0512                                         <guimenu>Settings</guimenu>
0513                                         <guimenuitem>Rulesets</guimenuitem>
0514                                 </menuchoice></term>
0515                                 <listitem><para><action>Customize rulesets.</action></para>
0516                                 <para>Use the Ruleset Editor to customize rulesets. For details see <link linkend="ruleset-options">here</link>.</para></listitem>
0517                         </varlistentry>
0518                         <varlistentry>
0519                                 <term><menuchoice>
0520                                         <shortcut><keycombo action="simul">&Ctrl;<keycap>G</keycap></keycombo></shortcut>
0521                                         <guimenu>Settings</guimenu>
0522                                         <guimenuitem>Change Visual Angle</guimenuitem>
0523                                 </menuchoice></term>
0524                                 <listitem><para><action>Changes the viewing angle of the tiles counterclockwise.</action></para></listitem>
0525                         </varlistentry>
0526                         <varlistentry>
0527                                 <term><menuchoice>
0528                                         <shortcut><keycombo action="simul">&Ctrl;<keycap>D</keycap></keycombo></shortcut>
0529                                         <guimenu>Settings</guimenu>
0530                                         <guimenuitem>Demo Mode</guimenuitem>
0531                                 </menuchoice></term>
0532                                 <listitem><para><action>Enables or disables the Demo Mode. See <link linkend="play">here</link> for details.</action></para></listitem>
0533                         </varlistentry>
0534                 </variablelist>
0535 
0536 <para>
0537 Additionally &kajongg; has the common &kde; <guimenu>Settings</guimenu> and <guimenu>Help</guimenu>
0538 menu items, for more information read the sections about the <ulink url="help:/fundamentals/menus.html#menus-settings"
0539 >Settings Menu</ulink> and <ulink url="help:/fundamentals/menus.html#menus-help">Help Menu</ulink>
0540 of the &kde; Fundamentals.
0541 </para>
0542 
0543 </sect1>
0544 </chapter>
0545 
0546 <chapter id="configuration"><title>Game Configuration</title> <!-- do not change this! -->
0547 <!--This section describes configuration &GUI;. If your game is configured using menubar exclusively, please remove this section.-->
0548 <screenshot>
0549 <screeninfo>Configure Dialog</screeninfo>
0550         <mediaobject>
0551           <imageobject>
0552             <imagedata fileref="config_play.png" format="PNG"/>
0553           </imageobject>
0554           <textobject>
0555             <phrase>Configure Dialog</phrase>
0556           </textobject>
0557         </mediaobject>
0558 </screenshot>
0559 
0560 <para>The menu entry <menuchoice><guimenu>Settings</guimenu> <guimenuitem>Configure &kajongg;...</guimenuitem></menuchoice> opens the <guilabel>Configure - &kajongg;</guilabel> dialog.</para>
0561 <para>If you press the <guibutton>Cancel</guibutton> button  here, all of your configuration changes will be reverted, including everything you did with the ruleset editor.</para>
0562 <para>
0563   You can also select the different tabs with the keyboard: <keycombo action="simul">&Ctrl;<keycap>1</keycap></keycombo> selects
0564   the first tab <guilabel>Play</guilabel> options, <keycombo action="simul">&Ctrl;<keycap>2</keycap></keycombo> selects
0565   the second tab, and so on.
0566 </para>
0567 
0568 <sect1 id="play-options"><title>Play options</title>
0569                 <variablelist>
0570                         <varlistentry>
0571                                 <term>
0572                                         <guilabel>Show tile shadows</guilabel>
0573                                 </term>
0574                                 <listitem><para>
0575                                 This shows tiles with borders and shadows. Also there is some space between tile rows, and the wall tiles are shown such that you can see
0576                                 that the wall  is two or three tiles high. So if you disable this option, you have a simpler display with slightly larger tiles. This may be helpful
0577                                 for small screens.
0578 </para></listitem>
0579                         </varlistentry>
0580                         <varlistentry>
0581                                 <term>
0582                                         <guilabel>Rearrange undisclosed tiles to melds</guilabel>
0583                                 </term>
0584                                 <listitem><para>
0585                                 This groups melds in the hand.
0586                                  Sometimes the grouping might not be like you want it, so you might prefer to have no grouping at all, just like in a real world game.
0587 </para></listitem>
0588                         </varlistentry>
0589                         <varlistentry>
0590                                 <term>
0591                                         <guilabel>Show only possible actions</guilabel>
0592                                 </term>
0593                                 <listitem><para>
0594                                 When playing, show only possible actions like <quote>No claim</quote> or <quote>Pung</quote>.
0595 </para></listitem>
0596                         </varlistentry>
0597                         <varlistentry>
0598                                 <term>
0599                                         <guilabel>Propose what to do</guilabel>
0600                                 </term>
0601                                 <listitem><para>
0602                                 Whenever you have a choice of actions like claiming a tile or not or like choosing which tile to discard, &kajongg; can help you by making a proposal.
0603 </para></listitem>
0604                         </varlistentry>
0605                         <varlistentry>
0606                                 <term>
0607                                         <guilabel>Use sounds if available</guilabel>
0608                                 </term>
0609                                 <listitem><para>
0610                 This lets you hear discards and claims. If other players recorded sound files with their own voice, you can hear them.
0611 </para></listitem>
0612                         </varlistentry>
0613                         <varlistentry>
0614                                 <term>
0615                                         <guilabel>Let others hear my voice</guilabel>
0616                                 </term>
0617                                 <listitem><para>
0618                 If you recorded sound files with your voice this option will let the other players
0619                 hear your discards and claims with your voice.
0620 </para></listitem>
0621                         </varlistentry>
0622                         <varlistentry>
0623                                 <term>
0624                                         <guilabel>Animation speed:</guilabel>
0625                                 </term>
0626                                 <listitem><para>
0627                 Define how fast the tiles should move around. If you move the slider to the rightmost position, tile movement is not animated:
0628                 the tiles will simply change place.
0629 </para></listitem>
0630                         </varlistentry>
0631                 </variablelist>
0632 
0633         <sect2><title>Sound</title>
0634         <para>
0635                 Playing gives you a much nicer experience if you hear players claim tiles and announce discards. It also makes playing
0636                 easier because you can concentrate on your own tiles, you do not have to watch what others discard.
0637         </para>
0638         <para>
0639                 &kajongg; comes with voices for different players. It automatically assigns voices to players. For every language there should be
0640                 four voices, preferably two male and two female. &kajongg; tries to use voices in the same language &kajongg; runs in. If it
0641                 finds no voices in that language, &kajongg; will fallback to other languages, using the same fallback languages you defined for
0642                 &kajongg; (see <menuchoice><guimenu>Help</guimenu> <guimenuitem>Switch Application Language</guimenuitem></menuchoice>). If no
0643                 voice files exist yet for your language, you are invited to record and contribute them to &kajongg;.
0644         </para>
0645         <para>
0646                 </para><itemizedlist><listitem><para>
0647                 This is how you can generate voices yourself. There is a separate folder for every voice. Please note that those folders may
0648                 be somewhere else on your system, they depend on how &kde; was installed. Only the part starting with <filename class="directory">kajongg</filename>
0649                 is always the same. There are two groups of voices
0650                 with different places in the file system:
0651                 <itemizedlist><listitem><para>
0652                         Predefined voices for every language. They live in a folder like <filename class="directory">/usr/share/kajongg/voices/LANG</filename> where
0653                         LANG is the code for your language. The voice directories directly under <filename class="directory">.../kajongg/voices/</filename> are the US-english
0654                         versions. Predefined voices are randomly assigned to players. Those voices have names like <quote><literal>male1 male2 female1 female2</literal></quote> but those names do not matter, the user will never see them.
0655                 </para></listitem><listitem><para>
0656                         User voices can be defined for a specific user.
0657                         If &kajongg; makes use of such a voice, it can automatically be transferred to other players
0658                         over the internet.
0659                         Those voices live in a folder like <filename class="directory">~/.local/share/apps/kajongg/voices/</filename>.
0660                         So if your login name is joe, this might be <filename class="directory">/home/joe/.local/share/apps/kajongg/voices/joe/</filename>.
0661                         The folder <filename class="directory">voices/</filename> might not yet exist - if so, create it.
0662                 </para></listitem></itemizedlist>
0663                 </para></listitem><listitem><para>
0664                 Now that you know where to place your new voice, generate a new folder for it.
0665                 </para></listitem><listitem><para>
0666                         In that subfolder, you can place the sound files. They have to be encoded with the <ulink url="https://xiph.org/vorbis/">Ogg Vorbis</ulink> audio compressor, the file names need to
0667                         have the extension <filename class="extension">.ogg</filename>.
0668                         A single file has a name like <filename>s3.ogg</filename> - this is Stone 3. You should define such files for all tiles and
0669                         for all claims and announcements. But if a sound file is missing, nothing bad happens - you just will not hear that sound. Fallback
0670                         to other voices or languages only works for entire voices, not for single sound files.
0671                 </para></listitem><listitem><para>
0672                 After having defined all sound files for a predefined voice, please make sure that the &kajongg; process has write permission in
0673                 the new voice folder. Start &kajongg; and test the voice. After everything is OK, you can revoke write permission (and you should
0674                 do so for predefined voices). &kajongg; will automatically generate a file named <filename>md5sum</filename> containing a checksum
0675                 over all sound files. Whenever you change, add or delete a sound file for a voice, &kajongg; will try to rewrite that file.
0676         </para></listitem></itemizedlist>
0677         <para>
0678                 Please make the length of the sound short but speak clearly - this game can be played very fast when you get used to it. It is easier
0679                 if you first write down a list with everything that should be spoken. Do not read it as a sequence of items, try to pronounce each
0680                 item as if it were the only one and as you would when playing. Leave room between the items. Reading this needs a little practicing.</para>
0681         <para>
0682                 This is just one possibility to create the sound files:
0683         </para><para><itemizedlist><listitem><para>
0684                 Record a sound file with the program <command>qarecord</command>, save it in the <acronym>WAV</acronym> format.
0685                 In this single sound file, speak all of the sounds.
0686         </para></listitem><listitem><para>
0687                 Edit that file with the sound editor <command>audacity</command>. In that editor, use the mouse to mark a range of the sound waves.
0688                 The editor will play that part. Repeat until you have the correct part selected.
0689                 This may be easier if you <menuchoice><guimenu>View</guimenu> <guimenuitem>Zoom In</guimenuitem></menuchoice>.
0690                 Use the menu command <menuchoice><guimenu>File</guimenu> <guimenuitem>Export Selection</guimenuitem></menuchoice> and save in the <filename class="extension">.ogg</filename> format.
0691                 Under <guilabel>Options</guilabel>, choose low quality - this is sufficient and even
0692                 wanted because this reduces the time to transfer the sounds to the other players.
0693         </para></listitem></itemizedlist></para>
0694         <para>The following are the names of the files that you should generate. Always append <filename class="extension">.ogg</filename> to them:</para>
0695 
0696 <table>
0697 <title>Sound file names</title>
0698 <tgroup cols="2">
0699 <tbody>
0700 <row>
0701 <entry>&s1; .. &s9;</entry><entry>Stone 1 to Stone 9</entry>
0702 </row>
0703 <row>
0704 <entry>&b1; .. &b9;</entry>
0705 <entry>Bamboo 1 to Bamboo 9</entry>
0706 </row>
0707 <row>
0708 <entry>&c1; .. &c9;</entry>
0709 <entry>Character 1 to Character 9</entry>
0710 </row>
0711 <row>
0712 <entry>&we; &ws; &ww; &wn;</entry>
0713 <entry>The winds East, South, West, North</entry>
0714 </row>
0715 <row>
0716 <entry>&db; &dr; &dg;</entry>
0717 <entry>The dragons blue/white, red, green</entry>
0718 </row>
0719 <row>
0720 <entry>&chow; &pung; &kong; &mahjongg;</entry>
0721 <entry>The major claims</entry>
0722 </row>
0723 <row>
0724 <entry>&originalcall; &violatesoriginalcall;</entry>
0725 <entry>Original Call and its violation</entry>
0726 </row>
0727 <row>
0728 <entry>&dangerousgame;</entry>
0729 <entry>A player lets off a cannon (dangerous game)</entry>
0730 </row>
0731 <row>
0732 <entry>&nochoice;</entry>
0733 <entry>A player declares he has no choice but to play dangerous game</entry>
0734 </row>
0735 </tbody>
0736 </tgroup>
0737 </table>
0738         </sect2>
0739 </sect1>
0740 
0741 <sect1 id="tiles-options"><title>Tiles options</title>
0742         <screenshot>
0743                 <screeninfo>Tileset selector</screeninfo>
0744                 <mediaobject>
0745                         <imageobject>
0746                                 <imagedata fileref="config_tiles.png" format="PNG"/>
0747                         </imageobject>
0748                         <textobject><phrase>Tileset selector</phrase></textobject>
0749                 </mediaobject>
0750         </screenshot>
0751         <para>
0752                 Use the <guilabel>Tiles</guilabel> selector to select graphics for the tiles.
0753         </para>
0754 </sect1>
0755 
0756 <sect1 id="background-options"><title>Background options</title>
0757         <screenshot>
0758                 <screeninfo>Background selector</screeninfo>
0759                 <mediaobject>
0760                         <imageobject>
0761                                 <imagedata fileref="config_background.png" format="PNG"/>
0762                         </imageobject>
0763                         <textobject><phrase>Background selector</phrase></textobject>
0764                 </mediaobject>
0765         </screenshot>
0766         <para>
0767                 Use the <guilabel>Background</guilabel> selector to select a background graphic for the game.
0768         </para><para>Some backgrounds like the Chinese Landscape need some time to load. If you feel that
0769                 the program should start faster or that resizing the main window takes too long, you might try some
0770                 other background.
0771         </para>
0772 </sect1>
0773 
0774 <sect1 id="ruleset-options"><title>Ruleset Editor</title>
0775                         <screenshot>
0776                                 <screeninfo>Ruleset Editor</screeninfo>
0777                                 <mediaobject>
0778                                         <imageobject>
0779                                                 <imagedata fileref="ruleseteditor.png" format="PNG"/>
0780                                         </imageobject>
0781                                         <textobject><phrase>Ruleset Editor</phrase></textobject>
0782                                 </mediaobject>
0783                         </screenshot>
0784                         <para>
0785                                 Use the Ruleset Editor to customize rulesets. Predefined rulesets are shown in an italic font, customized rulesets have a normal font. Predefined rulesets cannot be changed by the user in any way, however an update of &kajongg; might. Customized rulesets will never be affected by an update.
0786                         </para><para>
0787                                 When starting a new game, you will be able to select a ruleset for that game. All rulesets defined in the ruleset editor can be used. The ruleset is saved together with the game, so you can always change rulesets here - your changes will only affect future games.
0788                         </para>
0789                         <sect2><title>Rule, Points, x2, Limits</title><para>
0790                                 Simply double click on whatever you want to change.
0791                                 If all values are cleared, this rule  will have no influence on the game.
0792                                 Rules cannot be deleted.</para>
0793                         </sect2>
0794                         <sect2><title>Copy and Remove</title><para>
0795                                 You can copy and remove entire rulesets.
0796                         </para><para>
0797                                  Again this can even be done if existing games use this ruleset since every game has its own ruleset copy. You can view rulesets for old games: <link linkend="game-menu-scoreGame">Load</link> the old game and <link linkend="view-explain-scores">show its score table</link>.
0798                         </para>
0799                         </sect2>
0800                         <sect2><title>Compare</title><para>
0801                         <screenshot>
0802                                 <screeninfo>Ruleset Comparator</screeninfo>
0803                                 <mediaobject>
0804                                         <imageobject>
0805                                                 <imagedata fileref="differ.png" format="PNG"/>
0806                                         </imageobject>
0807                                         <textobject><phrase>Ruleset Comparator</phrase></textobject>
0808                                 </mediaobject>
0809                         </screenshot>
0810                                 You can select this command when an entire ruleset is selected. It lets you compare the selected ruleset against any other ruleset.
0811                         </para></sect2>
0812 </sect1>
0813 
0814 <sect1 id="default-keybindings">
0815 <title>Default Keybindings</title>
0816 
0817 <!-- TODO: not yet implemented
0818 <para>The menu entry <menuchoice><guimenu>Settings</guimenu> <guimenuitem>Configure ...</guimenuitem></menuchoice> allows you to change the default keyboard bindings.</para> -->
0819 
0820 <para>
0821 The default shortcuts are as follows:
0822 </para>
0823 
0824 <para>
0825 <variablelist>
0826 
0827 <varlistentry>
0828 <term><keycap>F1</keycap></term>
0829 <listitem>
0830 <para>
0831 Displays this handbook.
0832 </para>
0833 </listitem>
0834 </varlistentry>
0835 
0836 <varlistentry>
0837 <term><keycombo action="simul">&Ctrl;<keycap>C</keycap></keycombo></term>
0838 <listitem>
0839 <para>
0840 Score a manual game.
0841 </para>
0842 </listitem>
0843 </varlistentry>
0844 
0845 <varlistentry>
0846 <term><keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo></term>
0847 <listitem>
0848 <para>
0849 Play a game with friends or computer players.
0850 </para>
0851 </listitem>
0852 </varlistentry>
0853 
0854 <varlistentry>
0855 <term><keycombo action="simul">&Ctrl;<keycap>W</keycap></keycombo></term>
0856 <listitem>
0857 <para>
0858 Abort the current game.
0859 </para>
0860 </listitem>
0861 </varlistentry>
0862 
0863 <varlistentry>
0864 <term><keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo></term>
0865 <listitem>
0866 <para>
0867 Quit the program.
0868 </para>
0869 </listitem>
0870 </varlistentry>
0871 
0872 <varlistentry>
0873 <term><keycombo action="simul">&Ctrl;<keycap>T</keycap></keycombo></term>
0874 <listitem>
0875 <para>
0876 Show the score table.
0877 </para>
0878 </listitem>
0879 </varlistentry>
0880 
0881 <varlistentry>
0882 <term><keycombo action="simul">&Ctrl;<keycap>H</keycap></keycombo></term>
0883 <listitem>
0884 <para>
0885 Show a chat window.
0886 </para>
0887 </listitem>
0888 </varlistentry>
0889 
0890 <varlistentry>
0891 <term><keycombo action="simul">&Ctrl;<keycap>G</keycap></keycombo></term>
0892 <listitem>
0893 <para>
0894 Change the viewing angle.
0895 </para>
0896 </listitem>
0897 </varlistentry>
0898 
0899 <varlistentry>
0900 <term><keycombo action="simul">&Ctrl;<keycap>D</keycap></keycombo></term>
0901 <listitem>
0902 <para>
0903 Enables or disables the Demo Mode.
0904 </para>
0905 </listitem>
0906 </varlistentry>
0907 
0908 <varlistentry>
0909 <term><keycombo action="simul">&Shift;<keycap>F1</keycap></keycombo></term>
0910 <listitem>
0911 <para>
0912 What's this? help.
0913 </para>
0914 </listitem>
0915 </varlistentry>
0916 
0917 <varlistentry>
0918 <term><keycombo action="simul">&Ctrl;&Shift;<keycap>F</keycap></keycombo></term>
0919 <listitem>
0920 <para>
0921 Full Screen Mode.
0922 </para>
0923 </listitem>
0924 </varlistentry>
0925 
0926 </variablelist>
0927 </para>
0928 
0929 </sect1>
0930 </chapter>
0931 
0932 <appendix id="problems"><title>Known problems</title>
0933         <itemizedlist>
0934                 <listitem><para>In playing mode, penalties are not yet possible.</para></listitem>
0935                 <listitem><para>The computer players are still rather stupid.</para></listitem>
0936         </itemizedlist>
0937 </appendix>
0938 
0939 <appendix id="future"><title>Possible future features</title>
0940         <itemizedlist>
0941                 <listitem><para>Add more rulesets. This should optionally be done by people using those rulesets regularly.</para></listitem>
0942         </itemizedlist>
0943 </appendix>
0944 
0945  <appendix id="faq"><title>Frequently asked questions</title> <!-- do not change this! -->
0946 <!--This chapter is for frequently asked questions. Please use <qandaset> <qandaentry> only!-->
0947 <qandaset>
0948 <!--Following is a standard list of FAQ questions.-->
0949         <qandaentry>
0950                  <question><para>I want to change the way this game looks. Can I? </para></question>
0951                  <answer><para>Yes. To change the way &kajongg; looks use the menubar to open the <link linkend="configuration">configuration utility</link>.</para></answer>
0952         </qandaentry>
0953         <qandaentry>
0954                  <question><para>Can I use the keyboard to assign tiles to players?</para></question>
0955                  <answer><para>Yes. See  <link linkend="enterhand-tiles">Have &kajongg; compute the score</link>.</para></answer>
0956         </qandaentry>
0957 <!--Please add more Q&As if needed-->
0958 
0959 </qandaset>
0960 </appendix>
0961 
0962 <appendix id="credits"><title>Credits and License</title> <!-- do not change this! -->
0963 <!--This chapter is for credits and licenses.-->
0964         <para>
0965                 &kajongg; for &kde;
0966         </para>
0967 
0968         <para>
0969                 Program Copyright &copy; 2009-2017 &Wolfgang.Rohdewald; &Wolfgang.Rohdewald.mail;
0970         </para>
0971         <para>
0972                 Documentation Copyright &copy; 2009-2017 &Wolfgang.Rohdewald; &Wolfgang.Rohdewald.mail;
0973         </para>
0974 
0975 <!-- !!!do not change ANYTHING after this line!!!! -->
0976 <!-- TRANS:CREDIT_FOR_TRANSLATORS -->
0977 &underFDL;
0978 &underGPL;
0979 
0980 </appendix>
0981 
0982 <appendix id="bibliography">
0983 <title>Bibliography</title>
0984         <itemizedlist>
0985                 <listitem><para>Das Chinesische Mah-Jongg-Spiel by Uwe Martens 2005, Books on Demand GmbH, Norderstedt. This book is an excellent German reference containing everything you
0986                   want to know about the rules used in Germany and many other aspects of the game.</para></listitem>
0987                 <listitem><para>The Complete Book of Mah-Jongg by A. D. Millington, 1977 (with several paperback editions up to 2003), Weidenfeld &amp; Nicolson, London.
0988                   This is the ultimate reference for Classical Chinese Mah Jong as played in the Western world. It can give you valuable hints about game strategies.</para></listitem>
0989                 <listitem><para>Mah-Jong by Gwyn Headley and Yvonne Seeley, 3rd edition, 2008, A &amp; C Black Publishers Ltd., London. This book is a very easy to use reference, concentrating
0990                   on the rules as used in Great Britain, defined by the BMJA (The British Mah Jong Association).</para></listitem>
0991                 <listitem><para><ulink url="https://en.wikipedia.org/wiki/Mahjong"></ulink></para></listitem>
0992                 <listitem><para><ulink url="https://de.wikipedia.org/wiki/Mah-Jongg"></ulink></para></listitem>
0993         </itemizedlist>
0994 </appendix>
0995 
0996 <appendix id="installation">
0997 <title>Installation</title>
0998 <para>
0999 For Linux: Your distribution should have it packaged for you.
1000 </para>
1001 <para>
1002 For Windows: Please see <ulink url="https://www.linux-apps.com/p/1109453/"></ulink> for a Windows installer.
1003 </para>
1004 <para>
1005 If you want to download the source and install manually:
1006 <itemizedlist>
1007 <listitem><para> <literal>git clone https://invent.kde.org/games/kajongg.git</literal> </para></listitem>
1008 <listitem><para> For Linux: <literal>cd kajongg ; mkdir build ; cd build; cmake .. &amp;&amp; make &amp;&amp; make install</literal> </para></listitem>
1009 <listitem><para> For Windows: Please read <filename>README.windows</filename></para></listitem>
1010 </itemizedlist>
1011 </para>
1012 <para>
1013 Kajongg depends on those packages: (debian package names in parentheses)
1014 <itemizedlist>
1015         <listitem><para>Python 3.8 or higher (python3)</para></listitem>
1016         <listitem><para>Qt6.5 or higher (python3-pyqt6 and python3-pyqt6.qtsvg)</para></listitem>
1017         <listitem><para>the python bindings for Qt6 (python3-pyqt6)</para></listitem>
1018         <listitem><para>the python twisted library 16.6.0 or higher (python3-twisted)</para></listitem>
1019         <listitem><para>sqlite3 (libsqlite3-0)</para></listitem>
1020 </itemizedlist>
1021 </para>
1022 
1023 </appendix>
1024 
1025 &documentation.index;
1026 </book>
1027 <!--
1028 Local Variables:
1029 mode: sgml
1030 sgml-minimize-attributes:nil
1031 sgml-general-insert-case:lower
1032 sgml-omittag:t
1033 sgml-shorttag:t
1034 sgml-namecase-general:t
1035 sgml-always-quote-attributes:t
1036 sgml-indent-step:0
1037 sgml-indent-data:nil
1038 sgml-parent-document:nil
1039 sgml-exposed-tags:nil
1040 sgml-local-catalogs:nil
1041 sgml-local-ecat-files:nil
1042 End:
1043 -->