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

0001 <?xml version="1.0" ?>
0002 <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
0003   <!ENTITY i18n-ksirkskineditor '<application>KsirK Skin Editor</application>'>
0004   <!ENTITY % addindex "IGNORE">
0005   <!ENTITY % English "INCLUDE">
0006 ]>
0007 
0008 <book id="ksirk" lang="&language;">
0009 
0010 <bookinfo>
0011 <title>The &ksirk; Handbook</title>
0012 
0013 <authorgroup>
0014   <author>
0015     <firstname>Ga&euml;l</firstname> <othername>Kleag</othername> <surname>de Chalendar</surname>
0016     <affiliation><address><email>kleag@free.fr</email></address></affiliation>
0017   </author>
0018   <author>
0019     <firstname>Nemanja</firstname> <othername></othername> <surname>Hirsl</surname>
0020     <affiliation><address><email>nemhirsl@gmail.com</email></address></affiliation>
0021   </author>
0022   <!-- Translators: put here the copyright notice of the translation -->
0023   <!-- TRANS:ROLES_OF_TRANSLATORS -->
0024 </authorgroup>
0025 
0026 <copyright>
0027   <year>2002-2012</year>
0028   <holder>Ga&euml;l de Chalendar</holder>
0029 </copyright>
0030 <copyright>
0031   <year>2013</year>
0032   <holder>Nemanja Hirsl</holder>
0033 </copyright>
0034 <!-- Put here the FDL notice.  Read the explanation in fdl-notice.docbook
0035      and in the FDL itself on how to use it. -->
0036 <legalnotice>&FDLNotice;</legalnotice>
0037 
0038 <!-- Date and version information of the documentation
0039 Don't forget to include this last date and this last revision number, we
0040 need them for translation coordination !
0041 Please respect the format of the date (DD/MM/YYYY) and of the version
0042 (V.MM.LL), it could be used by automation scripts.
0043 Do NOT change these in the translation. -->
0044 <date>2021-10-14</date>
0045 <releaseinfo>KDE Gear 21.08</releaseinfo>
0046 
0047 <!-- Abstract about this handbook -->
0048 <abstract>
0049   <para>&ksirk; is a computerized version of a well known strategy game.</para>
0050 </abstract>
0051 
0052 <!-- This is a set of Keywords for indexing by search engines.
0053 Please at least include KDE, the KDE package it is in, the name
0054  of your application, and a few relevant keywords. -->
0055 <keywordset>
0056   <keyword>KDE</keyword>
0057   <keyword>AI</keyword>
0058   <keyword>free</keyword>
0059   <keyword>game</keyword>
0060   <keyword>GPL</keyword>
0061   <keyword>KsirK</keyword>
0062   <keyword>network</keyword>
0063   <keyword>risk</keyword>
0064   <keyword>strategy</keyword>
0065 </keywordset>
0066 </bookinfo>
0067 
0068 <!-- The contents of the documentation begin here.  Label
0069 each chapter so with the id attribute. This is necessary for two reasons: it
0070 allows you to easily reference the chapter from other chapters of your
0071 document, and if there is no ID, the name of the generated HTML files will vary
0072 from time to time making it hard to manage for maintainers and for the CVS
0073 system. Any chapter labeled (OPTIONAL) may be left out at the author's
0074 discretion. Other chapters should not be left out in order to maintain a
0075 consistent documentation style across all KDE apps. -->
0076 
0077 <chapter id="introduction">
0078 <title>Introduction</title>
0079 
0080 <!-- The introduction chapter contains a brief introduction for the
0081 application that explains what it does and where to report
0082 problems. Basically a long version of the abstract.  Don't include a
0083 revision history. (see installation appendix comment) -->
0084 <para>&ksirk; is a computerized version of a well known strategy game. Commercial
0085 and other Free Software versions exist but I (Gaƫl de Chalendar) created this game
0086 initially as a C++ learning exercise and so, I developed it up to this point (see <filename>README</filename> for details).</para>
0087 
0088 <screenshot>
0089   <screeninfo>Here's a screenshot of &ksirk;</screeninfo>
0090   <mediaobject>
0091     <imageobject><imagedata fileref="firing-screenshot.png" format="PNG"/></imageobject>
0092     <textobject><phrase>Screenshot</phrase></textobject>
0093   </mediaobject>
0094 </screenshot>
0095 
0096 <para>In the current version, &ksirk; is a multi-player network-enabled game with an AI. (see <filename>TODO</filename> for details)</para>
0097 
0098 <para>This documentation gives only the major information you need to start playing. Please read the tooltips and the status bar messages to complete your information.</para>
0099 
0100 <para>The goal of the game is simply to conquer the World... It is done by attacking your neighbors with your armies. Peaceful, isn't it ? :-)</para>
0101 </chapter>
0102 
0103 <chapter id="using-kapp">
0104 <title>Using &ksirk;</title>
0105 
0106 <!-- This chapter should tell the user how to use your app. You should use as
0107 many sections (Chapter, Sect1, Sect3, &etc;) as is necessary to fully document
0108 your application. -->
0109 
0110 <sect1 id="playing-ksirk">
0111 <title>Playing &ksirk;</title>
0112 
0113 <para>Preliminary note: the map can be scrolled by three methods:</para>
0114 
0115   <itemizedlist>
0116     <listitem><para>You can put your mouse near a border of the window and the map will scroll in that direction</para></listitem>
0117     <listitem><para>You can use your mouse wheel: with no modifier, it will scroll vertically; when pressing the &Alt; key, it will scroll horizontally</para></listitem>
0118     <listitem><para>You can use the keyboard arrows</para></listitem>
0119   </itemizedlist>
0120 
0121   <sect2 id="mainmenu" >
0122   <title>Starting a game</title>
0123 
0124   <para>When &ksirk; starts, you are presented with a main menu.</para>
0125 
0126   <screenshot>
0127     <screeninfo>The main menu of &ksirk;</screeninfo>
0128     <mediaobject>
0129       <imageobject><imagedata fileref="introscreen.png" format="PNG"/></imageobject>
0130       <textobject><phrase>Main menu</phrase></textobject>
0131     </mediaobject>
0132   </screenshot>
0133 
0134   <variablelist>
0135     <varlistentry>
0136       <term><guibutton>New Local Game</guibutton></term>
0137       <listitem><para><action>Starts a new game.</action></para></listitem>
0138     </varlistentry>
0139 <!--
0140     <varlistentry>
0141       <term><guibutton>Play &ksirk; over Jabber Network</guibutton></term>
0142       <listitem><para><action>Play &ksirk; over <ulink url="https://en.wikipedia.org/wiki/XMPP">Jabber</ulink>. You need to register Jabber account first.</action></para></listitem>
0143     </varlistentry>
0144 -->
0145     <varlistentry>
0146       <term><guibutton>New Standard TCP/IP Network Game</guibutton></term>
0147       <listitem><para><action>Start a new game using <ulink url="https://en.wikipedia.org/wiki/Internet_protocol_suite">Internet protocol suite</ulink>.</action></para></listitem>
0148     </varlistentry>
0149 
0150     <varlistentry>
0151       <term><guibutton>Join Standard TCP/IP Network Game</guibutton></term>
0152       <listitem><para><action>Join to the created by other user game using <ulink url="https://en.wikipedia.org/wiki/Internet_protocol_suite">Internet protocol suite</ulink>.</action></para></listitem>
0153     </varlistentry>
0154 
0155     <varlistentry>
0156       <term><guibutton>Load...</guibutton></term>
0157       <listitem><para><action>Use this to load a previously saved game.</action></para></listitem>
0158     </varlistentry>
0159 
0160     <varlistentry>
0161       <term><guibutton>Quit</guibutton></term>
0162       <listitem><para><action>Maybe you finally don't want to play?</action></para></listitem>
0163     </varlistentry>
0164   </variablelist>
0165 
0166   <para>If you hit <guibutton>New Local Game</guibutton> you will be presented with the <guilabel>New game properties</guilabel> dialog where you will be able to choose the number of players, the skin (or theme) to use, the game type (conquer the goal or have a specific goal) and finally if this game will be played with online players or if it is purely local. New skins can be downloaded using <guibutton>Download New Skins...</guibutton> button.</para>
0167 
0168   <screenshot>
0169     <screeninfo>The New Game dialog</screeninfo>
0170     <mediaobject>
0171       <imageobject><imagedata fileref="newgamedialog.png" format="PNG"/></imageobject>
0172       <textobject><phrase>The New Game dialog</phrase></textobject>
0173     </mediaobject>
0174   </screenshot>
0175 
0176   <para>To start a TCP/IP network game, choose the <guilabel>New Standard TCP/IP Network Game</guilabel> option on introduction screen. After pressing this button you will be able to choose the network parameters: number of local players and TCP port on which waiting for connections.</para>
0177 
0178   <screenshot>
0179     <screeninfo>Network game parameters dialog</screeninfo>
0180     <mediaobject>
0181       <imageobject><imagedata fileref="numnetplayersdialog.png" format="PNG"/></imageobject>
0182       <textobject><phrase>Network game parameters dialog</phrase></textobject>
0183     </mediaobject>
0184   </screenshot>
0185 
0186   <para>Then, network players will be able to connect by choosing <guilabel>Join Standard TCP/IP Network Game</guilabel> on the introduction screen and by indicating the IP or hostname of the host and the port number you just set.</para>
0187 
0188   <screenshot>
0189     <screeninfo>Joining network game dialog</screeninfo>
0190     <mediaobject>
0191       <imageobject><imagedata fileref="joinnetgame.png" format="PNG"/></imageobject>
0192       <textobject><phrase>Joining network game dialog</phrase></textobject>
0193     </mediaobject>
0194   </screenshot>
0195 
0196   <para>Each connection is indicated by a new row in the <guilabel>Players</guilabel> table below the map thumbnail.</para>
0197 
0198   <screenshot>
0199     <screeninfo>New player row</screeninfo>
0200     <mediaobject>
0201       <imageobject><imagedata fileref="justjoined.png" format="PNG"/></imageobject>
0202       <textobject><phrase>New player row</phrase></textobject>
0203     </mediaobject>
0204   </screenshot>
0205 
0206   <para>Let's suppose you keep all the default settings and hit <guibutton>Next</guibutton>. You will then setup two players, one after one. For each one, you'll choose a name, a nationality and, if you want, setup a password such that nobody else than you can reuse this player when reloading this saved game. Lastly, you will here specify if this player is played by the computer or by a human being.</para>
0207 
0208   <screenshot>
0209     <screeninfo>The Player Setup dialog</screeninfo>
0210     <mediaobject>
0211       <imageobject><imagedata fileref="playersetupdialog.png" format="PNG"/></imageobject>
0212       <textobject><phrase>The Player Setup dialog</phrase></textobject>
0213     </mediaobject>
0214   </screenshot>
0215 
0216   <para>Then, after press <guibutton>Start</guibutton>, if you choose to play with goal, the goal of each local player is displayed, preceded by a warning such that other players looking at the same computer can discreetly turn away while the goal is being viewed.</para>
0217 
0218   <screenshot>
0219     <screeninfo>The Goal Display warning message</screeninfo>
0220     <mediaobject>
0221       <imageobject><imagedata fileref="displaygoalwarningmessage.png" format="PNG"/></imageobject>
0222       <textobject><phrase>The Goal Display warning message</phrase></textobject>
0223     </mediaobject>
0224   </screenshot>
0225 
0226   <screenshot>
0227     <screeninfo>The Goal Display dialog</screeninfo>
0228     <mediaobject>
0229       <imageobject><imagedata fileref="displaygoalmessage.png" format="PNG"/></imageobject>
0230       <textobject><phrase>The Goal Display dialog</phrase></textobject>
0231     </mediaobject>
0232   </screenshot>
0233   </sect2>
0234 
0235   <sect2 id="distribution" >
0236   <title>Distribution</title>
0237 
0238   <para>At the beginning of the game, countries are distributed to all the players. Each country contains one army (represented by an infantryman) at the start. Each player has some armies to distribute to his countries at their turn (indicated by the presence of their name and their flag in the status bar). Note that five armies are represented by a cavalryman and 10 by a cannon.</para>
0239 
0240   <para>To put an army on one of your countries, click on it with the &LMB;. To remove an army, click with the &RMB;. Note, as a general rule, that you will never be able to remove more armies than the number you placed.</para>
0241 
0242   <screenshot>
0243     <screeninfo>Placing armies</screeninfo>
0244     <mediaobject>
0245       <imageobject><imagedata fileref="placingarmies.png" format="PNG"/></imageobject>
0246       <textobject><phrase>Placing armies</phrase></textobject>
0247     </mediaobject>
0248   </screenshot>
0249 
0250   <para>When a player has distributed all there armies, the next player is automatically selected to do the same task. When all players have finished to distributing their armies, there is two possibilities that can be selected by two buttons showed in the right panel:</para>
0251 
0252   <variablelist>
0253     <varlistentry>
0254       <term>
0255         <inlinemediaobject>
0256           <imageobject><imagedata fileref="recycling.png" format="PNG"/></imageobject>
0257           <textobject><phrase>Redistribution</phrase></textobject>
0258         </inlinemediaobject>
0259         <guibutton>Recycle</guibutton>
0260       </term>
0261       <listitem><para><action>One player wants to change some of his choices. The first player can then remove an army he just put in a country with the &RMB; and put it in another one with the &LMB;. When he finishes, he gives control to next player with the <guibutton>Valid</guibutton> button. When all players have finished their redistribution, the two buttons are displayed again.</action></para></listitem>
0262     </varlistentry>
0263 
0264     <varlistentry>
0265       <term>
0266         <inlinemediaobject>
0267           <imageobject><imagedata fileref="recyclingFinished.png" format="PNG"/></imageobject>
0268           <textobject><phrase>End of redistribution</phrase></textobject>
0269         </inlinemediaobject>
0270         <guibutton>Done</guibutton>
0271       </term>
0272       <listitem><para><action>The redistribution is finished and the game can continue.</action></para></listitem>
0273     </varlistentry>
0274   </variablelist>
0275   </sect2>
0276 
0277   <sect2 id="fight" >
0278   <title>Fight</title>
0279 
0280   <para>After the redistribution, a turn starts. Each player plays at his turn. He has the choice to:</para>
0281 
0282   <variablelist>
0283     <varlistentry>
0284       <term>
0285         <inlinemediaobject>
0286           <imageobject><imagedata fileref="joueurSuivant.png" format="PNG"/></imageobject>
0287           <textobject><phrase>Next player</phrase></textobject>
0288         </inlinemediaobject>
0289         <guibutton>Next Player</guibutton>
0290       </term>
0291       <listitem><para><action>The turn of the current player finishes and it's the turn of the next one.</action></para></listitem>
0292     </varlistentry>
0293 
0294     <varlistentry>
0295       <term>
0296         <inlinemediaobject>
0297           <imageobject><imagedata fileref="attackOne.png" format="PNG"/></imageobject>
0298           <textobject><phrase>Attack 1</phrase></textobject>
0299         </inlinemediaobject>&nbsp;
0300 
0301         <inlinemediaobject>
0302           <imageobject><imagedata fileref="attackTwo.png" format="PNG"/></imageobject>
0303           <textobject><phrase>Attack 2</phrase></textobject>
0304         </inlinemediaobject>&nbsp;
0305 
0306         <inlinemediaobject>
0307           <imageobject><imagedata fileref="attackThree.png" format="PNG"/></imageobject>
0308           <textobject><phrase>Attack 3</phrase></textobject>
0309         </inlinemediaobject>
0310         <guibutton>Attack with one, two or three armies</guibutton>&nbsp;
0311 
0312         <inlinemediaobject>
0313           <imageobject><imagedata fileref="autoattack.png" format="PNG"/></imageobject>
0314           <textobject><phrase>Auto attack</phrase></textobject>
0315         </inlinemediaobject>
0316         <guibutton>Auto attack</guibutton>
0317       </term>
0318 
0319       <listitem><para>To attack, drag with the mouse from the attacking country and drop to the attacked one. You will then be presented with a contextual menu showing the above entries.</para>
0320 
0321         <screenshot>
0322           <screeninfo>Attack menu</screeninfo>
0323           <mediaobject>
0324             <imageobject><imagedata fileref="attackmenu.png" format="PNG"/></imageobject>
0325             <textobject><phrase>Attack menu</phrase></textobject>
0326           </mediaobject>
0327         </screenshot>
0328 
0329         <para>For a country X to attack a country Y with x armies, 2 conditions must be fulfilled:</para>
0330 
0331         <itemizedlist>
0332           <listitem><para>the two countries must be neighbors;</para></listitem>
0333           <listitem><para>country X must have at least x+1 armies before the attack.</para></listitem>
0334         </itemizedlist>
0335 
0336         <para>If the attack is valid, a dialog is displayed if necessary for the defender to choose if he wants to defend with one or two armies or let the computer decide.</para>
0337 
0338         <para>When the defenders choice is done, the fight will occur and be completed. This will described below.</para>
0339 
0340         <screenshot>
0341           <screeninfo>Defense dialog</screeninfo>
0342           <mediaobject>
0343             <imageobject><imagedata fileref="defensedialog.png" format="PNG"/></imageobject>
0344             <textobject><phrase>Defense dialog</phrase></textobject>
0345           </mediaobject>
0346         </screenshot>
0347       </listitem>
0348     </varlistentry>
0349 
0350     <varlistentry>
0351       <term>
0352         <inlinemediaobject>
0353           <imageobject><imagedata fileref="moveArmies.png" format="PNG"/></imageobject>
0354           <textobject><phrase>Move armies</phrase></textobject>
0355         </inlinemediaobject>
0356         <guibutton>Move Armies from one country to another</guibutton>
0357       </term>
0358 
0359       <listitem><para><action>This is the last action of a player's turn. It gives the possibility to move some armies from one of his country to another, neighboring the first one. To choose the two countries, please drag and drop like you use during an attack. When both countries are selected, a slider is displayed on which you can choose how many armies there will be on each country afterwards.</action></para></listitem>
0360     </varlistentry>
0361   </variablelist>
0362   </sect2>
0363 
0364   <sect2  id="fight-outcome" >
0365   <title>Outcome of the fight</title>
0366 
0367   <para>For each army in the fight there is a corresponding die cast. The player who rolls a higher number on the dice, whether being from the attacker or defender, wins and the one to roll a smaller number on the dice loses armies according to the number of dice thrown.</para>
0368 
0369   <screenshot>
0370     <screeninfo>Attack result displayed</screeninfo>
0371     <mediaobject>
0372       <imageobject><imagedata fileref="shownumberofarmies.png" format="PNG"/></imageobject>
0373       <textobject><phrase>Attack result displayed</phrase></textobject>
0374     </mediaobject>
0375   </screenshot>
0376 
0377   <para>If the number of armies in the defender country reaches 0, the ownership of this country changes to the attacker: his flag is set up and one of his attacking armies is installed in his new country. The "Move armies" slider is displayed as for the moves of the end of the turn.</para>
0378 
0379   <screenshot>
0380     <screeninfo>Invasion slider</screeninfo>
0381     <mediaobject>
0382       <imageobject><imagedata fileref="invasionslider.png" format="PNG"/></imageobject>
0383       <textobject><phrase>Invasion slider</phrase></textobject>
0384     </mediaobject>
0385   </screenshot>
0386   </sect2>
0387 
0388   <sect2  id="end_of_turn" >
0389   <title>End of the turn</title>
0390 
0391   <para>To finish your current turn, if you don't want to move armies, you can hit the <guibutton>Next Player</guibutton> button in the toolbar.</para>
0392 
0393   <para>When everybody has played, the turn is finished. Some armies are distributed to the players, in function of the countries they own: 1 for each group of three countries, with a minimum of 3. There is also a bonus for players that own a complete continent, different for each one. The values of the bonuses for the default skin are:</para>
0394 
0395   <table>
0396     <title>Bonus due to the continents</title>
0397     <tgroup cols="2">
0398       <thead>
0399         <row>
0400           <entry>Continent</entry>
0401           <entry>Bonus</entry>
0402         </row>
0403       </thead>
0404       <tbody>
0405         <row><entry>North America</entry><entry>5</entry></row>
0406         <row><entry>South America</entry><entry>2</entry></row>
0407         <row><entry>Europe</entry><entry>5</entry></row>
0408         <row><entry>Africa</entry><entry>3</entry></row>
0409         <row><entry>Asia</entry><entry>7</entry></row>
0410         <row><entry>Pacific Area</entry><entry>2</entry></row>
0411       </tbody>
0412     </tgroup>
0413   </table>
0414 
0415   <para>When a player has finished distributing his armies, he clicks the <guibutton>Valid</guibutton> button to allow the next player to distribute his bonus armies. As for the initial distribution, when all player have placed their armies, they can start a new redistribution cycle or start a new turn...</para>
0416   </sect2>
0417 
0418 <!-- Does not work for current TCP/IP games
0419 <sect2 id="sending-messages" >
0420 <title>Sending messages to other players</title>
0421 <para>
0422 If you play a local game and want to communicate with the other players, well, let's speak (supposing you have no accessibility problems)... But if you are playing a network game, you can use the chat frame at the bottom of the window (it can be hidden or showed using the arrows). Just type in your message and hit &Enter;.
0423           <screenshot>
0424             <screeninfo>Sending messages</screeninfo>
0425             <mediaobject>
0426               <imageobject>
0427                 <imagedata fileref="messagesent.png" format="PNG"/>
0428               </imageobject>
0429               <textobject>
0430                 <phrase>Sending messages</phrase>
0431               </textobject>
0432             </mediaobject>
0433           </screenshot>
0434 
0435 </para>
0436 </sect2>
0437 -->
0438 </sect1>
0439 </chapter>
0440 
0441 <chapter id="commands">
0442 <title>Command Reference</title>
0443 
0444 <sect1 id="kapp-mainwindow">
0445 <title>The main &ksirk; window</title>
0446 
0447   <sect2>
0448   <title>The buttons</title>
0449 
0450   <variablelist>
0451     <varlistentry>
0452       <term>
0453         <inlinemediaobject>
0454           <imageobject><imagedata fileref="application-exit.png" format="PNG"/></imageobject>
0455           <textobject><phrase>Quit Game</phrase></textobject>
0456         </inlinemediaobject>
0457         <guibutton>Quit</guibutton>
0458       </term>
0459       <listitem><para><action>Causes the program to quit.</action></para></listitem>
0460     </varlistentry>
0461 
0462     <varlistentry>
0463       <term>
0464         <inlinemediaobject>
0465           <imageobject><imagedata fileref="document-new.png" format="PNG"/></imageobject>
0466           <textobject><phrase>New Game</phrase></textobject>
0467         </inlinemediaobject>
0468         <guibutton>New Game</guibutton>
0469       </term>
0470       <listitem><para><action>Starts a new game. It will cause the displaying of a dialog asking the number of players. After that, each player will be asked its name with another dialog.</action></para></listitem>
0471     </varlistentry>
0472   </variablelist>
0473 </sect2>
0474 
0475 </sect1>
0476 </chapter>
0477 
0478 <chapter id="developers">
0479 <title>Developer's Guide to &ksirk;</title>
0480 
0481 <para>Please refer to <ulink url="https://api.kde.org/">https://api.kde.org/</ulink> for the documentation of the API. It was quite complete but is currently a little bit outdated. There are no comments in the <literal role="extension">.cpp</literal> implementation files.</para>
0482 
0483 <para>Note that I originally developed this game under &Windows; with <application>Borland C++</application> and <application>WinG</application>. I ported it to &Java; before converting back to C++ and &kde;. At the beginning I used French or a mix of French and English to name the identifiers (classnames, methods, members, &etc;). I also used French for the comments. When I decided to distribute this game, I decided to convert all to english... but I am clearly not a native English speaker: please suggest or make and submit corrections, to the code comments or to this documentation.</para>
0484 
0485 </chapter>
0486 
0487 <chapter id="skins">
0488 <title>Creating new skins</title>
0489 
0490 <para>&ksirk; comes with a skin editor, named <command>ksirkskineditor</command>, that allows to edit all skin data, as soon as graphics (map, sprites, &etc;) are available in a &SVG; file. Please see the &i18n-ksirkskineditor; manual for further details.</para>
0491 
0492 </chapter>
0493 
0494 <chapter id="faq">
0495 <title>Questions and Answers</title>
0496 
0497 &reporting.bugs;
0498 &updating.documentation;
0499 
0500 <!-- commented out since it breaks compilation (endless loop due to empty answer tag) and looks unfinished anyway.
0501 <qandaset id="faqlist">
0502 <qandaentry>
0503 <question>
0504 <para>What will be the first question concerning &ksirk;?</para>
0505 </question>
0506 <answer>
0507 </answer>
0508 </qandaentry>
0509 </qandaset>
0510 -->
0511 </chapter>
0512 
0513 <chapter id="credits">
0514 
0515 <!-- Include credits for the programmers, documentation writers, and
0516 contributors here. The license for your software should then be included below
0517 the credits with a reference to the appropriate license file included in the KDE
0518 distribution. -->
0519 
0520 <title>Credits and License</title>
0521 
0522 <para>&ksirk;</para>
0523 
0524 <para>Program copyright 2002-2012 Ga&euml;l de Chalendar <email>kleag@free.fr</email></para>
0525 
0526 <para>Program copyright 2013 Nemanja Hirsl <email>nemhirsl@gmail.com</email></para>
0527 
0528 <para>Contributors:
0529 Robin Doer,
0530 &Albert.Astals.Cid;,
0531 Michal Golunski (Polish translation).
0532 </para>
0533 
0534 <para>Documentation copyright 2002-2008 Ga&euml;l de Chalendar <email>kleag@free.fr</email></para>
0535 
0536 <!-- TRANS:CREDIT_FOR_TRANSLATORS -->
0537 
0538 &underFDL;               <!-- FDL: do not remove. Commercial development should -->
0539 <!-- replace this with their copyright and either remove it or re-set this.-->
0540 
0541 <!-- Determine which license your application is licensed under,
0542      and delete all the remaining licenses below:
0543 
0544      (NOTE:  All documentation are licensed under the FDL,
0545      regardless of what license the application uses) -->
0546 
0547 &underGPL;           <!-- GPL License -->
0548 
0549 </chapter>
0550 
0551 <appendix id="installation">
0552 <title>Installation</title>
0553 
0554 <sect1 id="configuration">
0555 <title>Configuration</title>
0556 
0557 <para>The <menuchoice><guimenu>Settings</guimenu> <guimenuitem>Configure &ksirk;...</guimenuitem></menuchoice> menu item opens a dialog that allows you to:</para>
0558 
0559 <screenshot>
0560   <screeninfo>Preferences dialog</screeninfo>
0561   <mediaobject>
0562     <imageobject><imagedata fileref="preferences.png" format="PNG"/></imageobject>
0563     <textobject><phrase>Preferences dialog</phrase></textobject>
0564   </mediaobject>
0565 </screenshot>
0566 
0567 <itemizedlist>
0568   <listitem><para>enable or disable the sounds&nbsp;;</para></listitem>
0569   <listitem><para>set the speed of the sprites (from slow to immediate)&nbsp;;</para></listitem>
0570   <listitem><para>enable or disable the contextual helps displayed in popups&nbsp;;</para></listitem>
0571   <listitem><para>show or hide the number of armies on each country. The following  snapshot shows the map when the number of armies are displayed.</para>
0572 
0573     <screenshot>
0574       <screeninfo>Display of the number of armies</screeninfo>
0575       <mediaobject>
0576         <imageobject><imagedata fileref="shownumberofarmies.png" format="PNG"/></imageobject>
0577         <textobject><phrase>Display of the number of armies</phrase></textobject>
0578         </mediaobject>
0579     </screenshot>
0580   </listitem>
0581 </itemizedlist>
0582 </sect1>
0583 
0584 </appendix>
0585 
0586 &documentation.index;
0587 </book>
0588 <!--
0589 Local Variables:
0590 mode: sgml
0591 sgml-minimize-attributes:nil
0592 sgml-general-insert-case:lower
0593 sgml-indent-step:0
0594 sgml-indent-data:nil
0595 End:
0596 -->