Warning, /games/kmines/doc/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 % addindex "IGNORE">
0004   <!ENTITY % English "INCLUDE" > <!-- change language only here -->
0005 ]>
0006 
0007 <book id="kmines" lang="&language;">
0008 
0009 <bookinfo>
0010 <title>The &kmines; Handbook</title>
0011 
0012 <authorgroup>
0013 <author>
0014 <firstname>Nicolas</firstname>
0015 <surname>Hadacek</surname>
0016 <affiliation>
0017 <address>&Nicolas.Hadacek.mail;</address>
0018 </affiliation>
0019 </author>
0020 <author>
0021 <firstname>Michael</firstname>
0022 <surname>McBride</surname>
0023 <affiliation><address><email>mmcbride@ematic.org</email></address></affiliation>
0024 </author>
0025 <author>
0026 <firstname>Anton</firstname>
0027 <surname>Brondz</surname>
0028 <affiliation>
0029 <address><email>dinolinux@gmail.com</email></address>
0030 </affiliation>
0031 </author>
0032 <othercredit role="developer">
0033 <firstname>Nicolas</firstname>
0034 <surname>Hadacek</surname>
0035 <affiliation>
0036 <address>&Nicolas.Hadacek.mail;</address>
0037 </affiliation>
0038 <contrib>Developer</contrib>
0039 </othercredit>
0040 <othercredit role="reviewer">
0041 <firstname>Lauri</firstname>
0042 <surname>Watts</surname>
0043 <affiliation><address>&Lauri.Watts.mail;</address></affiliation>
0044 <contrib>Reviewer</contrib>
0045 </othercredit>
0046 <!-- TRANS:ROLES_OF_TRANSLATORS -->
0047 </authorgroup>
0048 
0049 <copyright>
0050 <year>2000</year>
0051 <holder>&Nicolas.Hadacek;, Michael McBride</holder>
0052 </copyright>
0053 
0054 <legalnotice>&FDLNotice;</legalnotice>
0055 
0056 <date>2021-07-11</date>
0057 <releaseinfo>4.0 (KDE Gear 21.04)</releaseinfo>
0058 
0059 <abstract><para>&kmines; is the &kde; version of the classic minesweeper
0060 game.</para></abstract>
0061 
0062 <keywordset>
0063 <keyword>KDE</keyword>
0064 <keyword>game</keyword>
0065 <keyword>minesweeper</keyword>
0066 </keywordset>
0067 
0068 </bookinfo>
0069 
0070 <chapter id="introduction">
0071 <title>Introduction</title>
0072 <note><title>Gametype:</title><para>Strategy, Board</para></note><!-- Game genre. Use as many as necessary. Available game types are: Arcade, Board, Card, Dice, Toys, Logic, Strategy.-->
0073 <note><title>Number of possible players:</title><para>One</para></note><!--Number of possible players. It can be: One, Two,..., Multiplayer-->
0074 
0075 <para>&kmines; is the classic Minesweeper game. The idea is to uncover all the
0076 squares without blowing up any mines. When a mine is blown up, the game is over.
0077 Numbers indicate how many mines there are nearby.
0078 </para>
0079 
0080 </chapter>
0081 
0082 <chapter id="how-to-play">
0083 <title>How to Play</title>
0084 <note><title>Objective:</title><para>Locate all the mines hidden on the minefield.</para></note><!--Describe the objective of the game.-->
0085 
0086 <screenshot>
0087 <mediaobject>
0088 <imageobject>
0089 <imagedata fileref="gameboard.png" format="PNG"/>
0090 </imageobject>
0091 <textobject>
0092 <phrase>&kmines; Game Board</phrase>
0093 </textobject>
0094 </mediaobject>
0095 </screenshot>
0096 
0097 <para>
0098 To play &kmines;, you need to use the mouse and its three buttons to
0099 uncover or to flag the squares (with two-buttoned mice, clicking the
0100 &MMB; is generally achieved by simultaneously pressing the &LMB; and the
0101 &RMB;).
0102 </para>
0103 
0104 <para>Clicking the &LMB; on your mouse will
0105 uncover a square. If there is a mine there, it will detonate, and the game will be over.
0106 If there is not a mine under the square, the square is cleared and if there aren't other
0107 mines nearby, the square will disappear including any nearby squares without mines.
0108 If there are mines nearby, a number will appear showing how many neighboring squares contain mines.
0109 For each square (excluding edge and corner squares), there are eight
0110 neighboring squares.
0111 </para>
0112 
0113 <note>
0114 <para>
0115 &LMB; clicking a flagged square is safe and does nothing.
0116 </para>
0117 </note>
0118 
0119 <para>
0120 The &RMB; will mark a square as containing a mine (by placing a red flag on it). Clicking the button twice
0121 will set it as being uncertain (by placing a question mark on it). The uncertain tag can
0122 be useful when you are puzzled about the positions of
0123 mines.
0124 The &MMB; will clear the surrounding squares if the right number of squares is
0125 already flagged. It is very useful since it is much quicker than
0126 uncovering all individual squares.
0127 Make sure your flags are correctly placed, if not, you might
0128 detonate a mine.
0129 </para>
0130 </chapter>
0131 
0132 <chapter id="rulestips">
0133 <title>Game Rules, Strategies and Tips</title>
0134 <sect1 id="rules">
0135 <title>Rules</title>
0136 <itemizedlist>
0137 <listitem><para>All the mines have to be cleared before a player can win a game.</para></listitem>
0138 <listitem><para>The player cannot know the exact location of the mines before the game is over.</para></listitem>
0139 <listitem><para>If a mine is detonated, the game is over.</para></listitem>
0140 <listitem><para>Numbers will indicate nearby mines.</para></listitem>
0141 </itemizedlist>
0142 </sect1>
0143 
0144 <sect1 id="strattips">
0145 <title>Strategies and Tips</title>
0146 <itemizedlist>
0147 <listitem><para>Use the numbers to find out where nearby mines are.</para></listitem>
0148 <listitem><para>Place flags where you suspect there are mines. Note that even though the indicated
0149 number of mines goes down when you place a flag, there might not be a mine under the flag.</para></listitem>
0150 <listitem><para>Think before you click, a wrong click could detonate a mine.</para></listitem>
0151 <listitem><para>When you suspect that a square contains a mine, work around the square to uncover any numbers which might help.</para></listitem>
0152 <listitem><para>Try to clear the board as quickly as possible, the less time you spend, the higher your score will be.</para></listitem>
0153 </itemizedlist>
0154 </sect1>
0155 
0156 </chapter>
0157 
0158 <chapter id="command">
0159 <title>Commands/Keyboard Shortcuts</title>
0160 
0161 <para>The following sections briefly describes some menubar options.</para>
0162 
0163 <sect1 id="menu">
0164 <title>Menu Items</title>
0165 
0166 <variablelist>
0167 <varlistentry>
0168 <term><menuchoice>
0169 <shortcut>
0170 <keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>
0171 </shortcut>
0172 <guimenu>Game</guimenu>
0173 <guimenuitem>New</guimenuitem> </menuchoice></term>
0174 <listitem><para>Starts a new game.</para></listitem>
0175 </varlistentry>
0176 
0177 <varlistentry>
0178 <term><menuchoice>
0179 <shortcut><keycap>P</keycap></shortcut>
0180 <guimenu>Game</guimenu>
0181 <guimenuitem>Pause</guimenuitem></menuchoice></term>
0182 <listitem>
0183 <para>
0184 Pauses the game time. Click on the menu item again to make the game resume. Note that the board disappears when the game is paused as it would be unfair if you could search for good moves without the time pressure.
0185 </para>
0186 </listitem>
0187 </varlistentry>
0188 
0189 <varlistentry>
0190 <term><menuchoice>
0191 <shortcut>
0192 <keycombo action="simul">&Ctrl;<keycap>H</keycap></keycombo>
0193 </shortcut>
0194 <guimenu>Game</guimenu>
0195 <guimenuitem>Show High Scores</guimenuitem> </menuchoice></term>
0196 <listitem><para>This shows you the high score (the shortest time) for each
0197 difficulty level.</para></listitem>
0198 </varlistentry>
0199 
0200 <varlistentry>
0201 <term><menuchoice>
0202 <shortcut>
0203 <keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
0204 </shortcut>
0205 <guimenu>Game</guimenu>
0206 <guimenuitem>Quit</guimenuitem> </menuchoice></term>
0207 <listitem><para><action>Quits</action> &kmines;.</para></listitem>
0208 </varlistentry>
0209 
0210 <varlistentry>
0211 <term><menuchoice>
0212 <guimenu>Settings</guimenu>
0213 <guisubmenu>Difficulty</guisubmenu>
0214 </menuchoice></term>
0215 <listitem>
0216 <para>Lets you set the difficulty level from a sub-menu.</para>
0217 <para>There are three default levels of difficulty:
0218 <guimenuitem>Easy</guimenuitem> (9x9 squares, 10 mines),
0219 <guimenuitem>Medium</guimenuitem> (16x16 squares, 40 mines), and
0220 <guimenuitem>Hard</guimenuitem> (30x16 squares, 99 mines).  There is also a
0221 <guimenuitem>Custom</guimenuitem> level settings.</para>
0222 <para>If you select <guimenuitem>Custom</guimenuitem>, then the
0223 settings you have configured in the <guilabel>Configure -
0224 &kmines;</guilabel> dialog will be used.</para></listitem>
0225 </varlistentry>
0226 
0227 </variablelist>
0228 
0229 <para>
0230 Additionally &kmines; has the common &kde; <guimenu>Settings</guimenu> and <guimenu>Help</guimenu>
0231 menu items, for more information read the sections about the <ulink url="help:/fundamentals/menus.html#menus-settings"
0232 >Settings Menu</ulink> and <ulink url="help:/fundamentals/menus.html#menus-help">Help Menu</ulink>
0233 of the &kde; Fundamentals.
0234 </para>
0235 
0236 </sect1>
0237 
0238 <sect1 id="keys"><title>Default Keyboard Shortcuts</title>
0239 <para>The following table shows you the default keyboard shortcuts.</para>
0240 
0241 <table>
0242 <title>Keyboard Shortcuts</title>
0243 <tgroup cols="2">
0244 <thead><row><entry>Key Combo</entry><entry>Action</entry></row></thead>
0245 <tbody>
0246 <row><entry><keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo></entry><entry>New Game</entry></row>
0247 <row><entry><keycap>P</keycap></entry><entry>Pause</entry></row>
0248 <row><entry><keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo></entry><entry>Quit &kmines;</entry></row>
0249 <row><entry><keycap>F1</keycap></entry><entry>&kmines; Handbook</entry></row>
0250 <row><entry><keycombo action="simul">&Shift;<keycap>F1</keycap></keycombo></entry><entry>What's This? help</entry></row>
0251 <row><entry><keycombo action="simul">&Ctrl;<keycap>H</keycap></keycombo></entry><entry>Show High Scores</entry></row>
0252 
0253 </tbody>
0254 </tgroup>
0255 </table>
0256 
0257 <para>These shortcuts can be changed by selecting the
0258 <menuchoice><guimenu>Settings</guimenu> <guimenuitem>Configure
0259 Shortcuts...</guimenuitem></menuchoice> menu item.</para>
0260 
0261 </sect1>
0262 
0263 </chapter>
0264 
0265 <chapter id="faq">
0266 <title>Frequently Asked Questions</title>
0267 <qandaset>
0268 
0269 <qandaentry>
0270 <question>
0271 <para>
0272 Can I change the way the game looks?
0273 </para>
0274 </question>
0275 <answer>
0276 <para>
0277 Yes, click on the <menuchoice><guimenu>Settings</guimenu> <guimenuitem>Configure
0278 &kmines;...</guimenuitem></menuchoice> menu item.
0279 </para>
0280 </answer>
0281 </qandaentry>
0282 
0283 <qandaentry>
0284 <question>
0285 <para>
0286 Is there a way to add more mines and squares?
0287 </para>
0288 </question>
0289 <answer>
0290 <para>
0291 Yes, the easiest way is to use the drop down box in the lower right corner.
0292 </para>
0293 </answer>
0294 </qandaentry>
0295 
0296 </qandaset>
0297 </chapter>
0298 
0299 <chapter id="settings">
0300 <title>Game Settings</title>
0301 <para>
0302 The game settings can be configured by selecting the <menuchoice><guimenu>Settings</guimenu>
0303 <guimenuitem>Configure &kmines;...</guimenuitem></menuchoice> menu item. A dialog will appear.
0304 </para>
0305 <para>
0306     On the <guilabel>General</guilabel> page, you can configure the following game settings.
0307 </para>
0308 <variablelist>
0309     <varlistentry>
0310         <term>Use '?' marks</term>
0311         <listitem>
0312             <para>When checked, allows using the question mark symbol to mark the squares of uncertainty. The mark on the square can be switched by clicking with &RMB;.</para>
0313         </listitem>
0314     </varlistentry>
0315     <varlistentry>
0316         <term>Allow &kmines; reset</term>
0317         <listitem>
0318             <para>When checked, allows you to reset &kmines; game when it is impossible to do anything but guess and your last guess is wrong.</para>
0319         </listitem>
0320     </varlistentry>
0321     <varlistentry>
0322         <term>Disable score on reset</term>
0323         <listitem>
0324             <para>When checked, allows you to disable scoring on reset.</para>
0325         </listitem>
0326     </varlistentry>
0327         <varlistentry>
0328         <term>Explore with left click on number cells</term>
0329         <listitem>
0330             <para>When checked, the &LMB; click on a number cell will have the same effect as the &MMB; click.</para>
0331         </listitem>
0332     </varlistentry>
0333 </variablelist>
0334 
0335 <para>
0336 On the second page, you can set the theme. Select a theme from the list.
0337 Each item in the list shows a small preview left to the theme name. A selection is immediately applied.
0338 </para>
0339 
0340 <para>
0341 On the third page, you can set the height and width of the board and
0342 the number of mines in your custom level.
0343 </para>
0344 
0345 </chapter>
0346 
0347 <chapter id="credits"><title>Credits and License</title>
0348 
0349 <para>
0350 &kmines; Copyright 1996-2007
0351 </para>
0352 
0353 <itemizedlist>
0354 <title>Authors</title>
0355 <listitem>
0356 <para>
0357 &Nicolas.Hadacek; &Nicolas.Hadacek.mail;
0358 </para>
0359 </listitem>
0360 <listitem>
0361 <para>
0362 Mikhail Kourinny
0363 </para>
0364 </listitem>
0365 <listitem>
0366 <para>
0367 Mauricio Piacentini <email>mauricio@tabuleiro.com</email>
0368 </para>
0369 </listitem>
0370 <listitem>
0371 <para>
0372 Dmitry Suzdalev <email>dimsuz@gmail.com</email>
0373 </para>
0374 </listitem>
0375 </itemizedlist>
0376 
0377 <para>Documentation copyright 2000 &Nicolas.Hadacek; &Nicolas.Hadacek.mail;</para>
0378 <para>Documentation updated for &kde; 2.0 by &Mike.McBride;
0379 &Mike.McBride.mail;</para>
0380 <para>Some changes for &kde; 3.2 by &Philip.Rodrigues; &Philip.Rodrigues.mail;</para>
0381 <!-- TRANS:CREDIT_FOR_TRANSLATORS -->
0382 
0383 &underFDL;
0384 &underGPL;
0385 
0386 </chapter>
0387 
0388 </book>
0389 <!--
0390 Local Variables:
0391 mode: sgml
0392 sgml-omittag: nil
0393 sgml-shorttag: t
0394 End:
0395 -->