Warning, /games/picmi/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 % English "INCLUDE">
0004 <!ENTITY % addindex "IGNORE">
0005 ]>
0006 
0007 <book id="picmi" lang="&language;">
0008 <bookinfo>
0009 <title>The &picmi; Handbook</title>
0010 
0011 <authorgroup>
0012 <author>
0013 <firstname>Jakob</firstname>
0014 <surname>Gruber</surname>
0015 <affiliation><address><email>jakob.gruber@gmail.com</email></address></affiliation>
0016 </author>
0017 <!-- TRANS:ROLES_OF_TRANSLATORS -->
0018 </authorgroup>
0019 
0020 <copyright>
0021 <year>2012</year>
0022 <holder>Jakob Gruber</holder>
0023 </copyright>
0024 
0025 <legalnotice>&FDLNotice;</legalnotice>
0026 
0027 <date>2021-10-08</date>
0028 <releaseinfo>2.0.0 (KDE Gear 21.08)</releaseinfo>
0029 
0030 <abstract>
0031 <para>
0032 &picmi;, a nonogram puzzle game.</para>
0033 </abstract>
0034 
0035 <keywordset>
0036 <keyword>KDE</keyword>
0037 <keyword>kdegames</keyword>
0038 <keyword>game</keyword>
0039 <keyword>puzzle game</keyword>
0040 <keyword>Picmi</keyword>
0041 </keywordset>
0042 </bookinfo>
0043 
0044 <chapter id="introduction">
0045 <title>Introduction</title>
0046 
0047 <para>
0048 &picmi; is a single player puzzle game.
0049 </para>
0050 
0051 <screenshot>
0052 <mediaobject>
0053 <imageobject>
0054 <imagedata fileref="gameboard.png" format="PNG"/>
0055 </imageobject>
0056 <textobject>
0057 <phrase>&picmi; gameboard</phrase>
0058 </textobject>
0059 </mediaobject>
0060 </screenshot>
0061 
0062 <para>
0063 The goal of the game is to color cells according to numbers given at the side of the board.
0064 </para>
0065 </chapter>
0066 
0067 <chapter id="how-to-play">
0068 <title>How to Play</title>
0069 
0070 <para>
0071 The player is presented with a blank board, and a list of numbers for each row and column. These numbers represent how runs are organized within any given row or column. For example, a number sequence of <quote>4 8 3</quote> would mean there are sets of four, eight, and three filled cells, in that order, with at least one blank cell between successive groups. The objective of the game is to use these hints to uncover the actual solution, and do this as quickly as possible.
0072 </para>
0073 
0074 <para>
0075 A left-click (un)marks a cell as occupied, while a right click (un)marks a cell as empty. Dragging may be used to mark several cells in a row or column in one go. The elapsed time is displayed in the status bar, and an overview of the game board is located in the upper left corner. A game is completed once all occupied cells have been marked correctly.
0076 </para>
0077 
0078 <para>
0079 The current placement of boxes and crosses (referred to as 'states' from now on) can be saved at any time. Saving a new state does not overwrite previous saved states. Restoring a state always returns to the most recently saved state. This can be repeated until no more saved states remain. The number of actions since the latest saved state is displayed in the status bar.
0080 </para>
0081 
0082 <para>
0083 &picmi; includes two game modes.
0084 Random puzzles (generated by selecting the <menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo></shortcut> <guimenu>Game</guimenu> <guimenuitem>New</guimenuitem></menuchoice> menu item) are generated according to the selected difficulty settings. Alternatively, the included preset puzzles can be played by selecting the <menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo></shortcut> <guimenu>Game</guimenu> <guimenuitem>Load...</guimenuitem></menuchoice> menu item.
0085 </para>
0086 
0087 </chapter>
0088 
0089 <chapter id="rules-strategies-tips">
0090 <title>Game Rules, Strategies and Tips</title>
0091 
0092 <sect1 id="rules">
0093 <title>Rules</title>
0094 <para>The number sequence in a row or column provides certain information about the count of occupied cells and their arrangement within a row or column.</para>
0095 <itemizedlist>
0096   <listitem><para>A number represents the length of a connected run of occupied cells on the board. This run either has at least one empty cell on each side or is located directly on the board edge.</para></listitem>
0097   <listitem><para>Additionally, a number sequence shows the order of these runs within a row or column.</para></listitem>
0098   <listitem><para>When the <guilabel>Prevent mistakes:</guilabel> option is enabled, it is not possible to incorrectly mark a cell as occupied - instead, penalty time is added to the timer. The penalty is increased with each mistake made.</para></listitem>
0099   <listitem><para>If <guilabel>Prevent mistakes:</guilabel> option is disabled, there is no feedback whether a cell has been marked correctly, and there is no penalty for making mistakes.</para></listitem>
0100   <listitem><para>The game will stop once all occupied cells have been marked correctly.</para></listitem>
0101 </itemizedlist>
0102 </sect1>
0103 
0104 </chapter>
0105 
0106 <chapter id="interface-overview">
0107 <title>Interface Overview</title>
0108 
0109 <sect1 id="menu-items">
0110 <title>Menu Items</title>
0111 
0112 <variablelist>
0113   <varlistentry>
0114     <term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo> </shortcut>
0115     <guimenu>Game</guimenu>
0116     <guimenuitem>New</guimenuitem></menuchoice></term>
0117     <listitem><para><action>Starts a new game.</action> It creates a random board using the current difficulty level.</para></listitem>
0118   </varlistentry>
0119 
0120   <varlistentry>
0121     <term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo> </shortcut>
0122     <guimenu>Game</guimenu>
0123     <guimenuitem>Load...</guimenuitem></menuchoice></term>
0124     <listitem><para><action>Loads a preset puzzle.</action> The names of puzzles are hidden until they are solved. High score lists and difficulty settings are disabled.</para></listitem>
0125   </varlistentry>
0126 
0127   <varlistentry>
0128     <term><menuchoice><shortcut><keycap>F5</keycap></shortcut>
0129     <guimenu>Game</guimenu>
0130     <guimenuitem>Restart Game</guimenuitem></menuchoice></term>
0131     <listitem><para><action>This will restart the current game.</action></para></listitem>
0132   </varlistentry>
0133 
0134   <varlistentry>
0135     <term><menuchoice><shortcut><keycap>P</keycap></shortcut>
0136     <guimenu>Game</guimenu>
0137     <guimenuitem>Pause</guimenuitem></menuchoice></term>
0138     <listitem><para><action>Pauses the game time.</action> 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.</para></listitem>
0139   </varlistentry>
0140 
0141   <varlistentry>
0142     <term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>H</keycap></keycombo> </shortcut>
0143     <guimenu>Game</guimenu>
0144     <guimenuitem>Show High Scores...</guimenuitem></menuchoice></term>
0145     <listitem><para><action>Shows a dialog containing the High Scores for the various difficulty levels.</action></para></listitem>
0146   </varlistentry>
0147 
0148   <varlistentry>
0149     <term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo> </shortcut>
0150     <guimenu>Game</guimenu>
0151     <guimenuitem>Quit</guimenuitem></menuchoice></term>
0152     <listitem><para><action>Quits</action> the &picmi;.</para></listitem>
0153   </varlistentry>
0154 
0155   <varlistentry>
0156     <term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>Z</keycap></keycombo> </shortcut>
0157     <guimenu>Move</guimenu>
0158     <guimenuitem>Undo</guimenuitem></menuchoice></term>
0159     <listitem><para><action>Undo the previous move</action> if one exists.</para></listitem>
0160   </varlistentry>
0161 
0162   <varlistentry>
0163     <term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>I</keycap></keycombo> </shortcut>
0164     <guimenu>Move</guimenu>
0165     <guimenuitem>Hint</guimenuitem></menuchoice></term>
0166     <listitem><para><action>Marks a cell as occupied or empty.</action></para></listitem>
0167   </varlistentry>
0168 
0169   <varlistentry>
0170     <term><menuchoice><guimenu>Move</guimenu>
0171     <guimenuitem>Solve</guimenuitem></menuchoice></term>
0172     <listitem><para><action>Play a demo game.</action></para></listitem>
0173   </varlistentry>
0174 
0175   <varlistentry>
0176     <term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>L</keycap></keycombo> </shortcut>
0177     <guimenu>Move</guimenu>
0178     <guimenuitem>Load Position</guimenuitem></menuchoice></term>
0179     <listitem><para><action>Loads the most recently saved position.</action></para></listitem>
0180   </varlistentry>
0181 
0182   <varlistentry>
0183     <term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo> </shortcut>
0184     <guimenu>Move</guimenu>
0185     <guimenuitem>Save Position</guimenuitem></menuchoice></term>
0186     <listitem><para><action>Saves the current board position.</action></para></listitem>
0187   </varlistentry>
0188 
0189   <varlistentry>
0190     <term><menuchoice><shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>F</keycap></keycombo> </shortcut>
0191     <guimenu>View</guimenu>
0192     <guimenuitem>Full Screen Mode</guimenuitem></menuchoice></term>
0193     <listitem><para><action>Toggles the graphic interface to full screen mode.</action></para></listitem>
0194   </varlistentry>
0195 
0196   <varlistentry>
0197     <term><menuchoice><guimenu>Settings</guimenu>
0198     <guisubmenu>Difficulty</guisubmenu></menuchoice></term>
0199     <listitem><para><action>Lets you set the difficulty level from a sub-menu.</action></para>
0200     <para>There are four levels of difficulty:
0201       <itemizedlist>
0202         <listitem><para><guimenuitem>Easy</guimenuitem>: 10 rows, 10 columns, 55% of all cells are occupied, <guilabel>Prevent mistakes:</guilabel> option is disabled.</para></listitem>
0203         <listitem><para><guimenuitem>Medium</guimenuitem>: 10 rows, 15 columns, 55% of all cells are occupied, <guilabel>Prevent mistakes:</guilabel> option is disabled.</para></listitem>
0204         <listitem><para><guimenuitem>Hard</guimenuitem>: 15 rows, 15 columns, 55% of all cells are occupied, <guilabel>Prevent mistakes:</guilabel> option is disabled.</para></listitem>
0205         <listitem><para><guimenuitem>Custom</guimenuitem>: Custom board dimensions and settings.</para></listitem>
0206       </itemizedlist>
0207     </para></listitem>
0208   </varlistentry>
0209 
0210   <varlistentry>
0211     <term><menuchoice><guimenu>Settings</guimenu>
0212     <guimenuitem>Configure &picmi;...</guimenuitem></menuchoice></term>
0213     <listitem><para><action>Choose the game background image, board dimensions and settings for custom difficulty.</action></para></listitem>
0214   </varlistentry>
0215 </variablelist>
0216 
0217 <para>
0218 Additionally &picmi; has the common &kde; <guimenu>Settings</guimenu> and <guimenu>Help</guimenu>
0219 menu items, for more information read the sections about the <ulink url="help:/fundamentals/menus.html#menus-settings">Settings Menu</ulink> and
0220 <ulink url="help:/fundamentals/menus.html#menus-help">Help Menu</ulink>
0221 of the &kde; Fundamentals.
0222 </para>
0223 </sect1>
0224 
0225 <sect1 id="keybindings">
0226 <title id="keybindings-title">Shortcuts</title>
0227 
0228 <para>The default shortcuts are:</para>
0229 
0230 <table>
0231   <title>Shortcuts</title>
0232   <tgroup cols="2">
0233     <tbody>
0234       <row>
0235         <entry>Start a new game</entry>
0236         <entry><keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo></entry>
0237       </row>
0238       <row>
0239         <entry>Load a preset game</entry>
0240         <entry><keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo></entry>
0241       </row>
0242       <row>
0243         <entry>Pause</entry>
0244         <entry><keycap>P</keycap></entry>
0245       </row>
0246       <row>
0247         <entry>Show High Scores</entry>
0248         <entry><keycombo action="simul">&Ctrl;<keycap>H</keycap></keycombo></entry>
0249       </row>
0250       <row>
0251         <entry>Full Screen Mode</entry>
0252         <entry><keycombo action="simul">&Ctrl;&Shift;<keycap>F</keycap></keycombo></entry>
0253       </row>
0254       <row>
0255         <entry>Quit</entry>
0256         <entry><keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo></entry>
0257       </row>
0258       <row>
0259         <entry>Help</entry>
0260         <entry><keycap>F1</keycap></entry>
0261       </row>
0262       <row>
0263         <entry>What's this? help</entry>
0264         <entry><keycombo action="simul">&Shift;<keycap>F1</keycap></keycombo></entry>
0265       </row>
0266     </tbody>
0267   </tgroup>
0268 </table>
0269 
0270 <table>
0271   <title>Keyboard controls</title>
0272   <tgroup cols="2">
0273     <tbody>
0274       <row>
0275         <entry>Move Left</entry>
0276         <entry>&Left; or <keycap>H</keycap></entry>
0277       </row>
0278       <row>
0279         <entry>Move Right</entry>
0280         <entry>&Right; or <keycap>L</keycap></entry>
0281       </row>
0282       <row>
0283         <entry>Move Up</entry>
0284         <entry>&Up; or <keycap>K</keycap></entry>
0285       </row>
0286       <row>
0287         <entry>Move Down</entry>
0288         <entry>&Down; or <keycap>J</keycap></entry>
0289       </row>
0290       <row>
0291         <entry>(Un)mark cell occupied</entry>
0292         <entry><keycap>X</keycap></entry>
0293       </row>
0294       <row>
0295         <entry>(Un)mark cell free</entry>
0296         <entry>&Space;</entry>
0297       </row>
0298     </tbody>
0299   </tgroup>
0300 </table>
0301 
0302 </sect1>
0303 </chapter>
0304 
0305 
0306 <chapter id="credits">
0307 <title>Credits and License</title>
0308 
0309 <para>
0310 &picmi;
0311 </para>
0312 <para>
0313 Program copyright 2012 by Jakob Gruber <email>jakob.gruber@gmail.com</email>
0314 </para>
0315 <para>
0316 Documentation copyright 2012 by Jakob Gruber <email>jakob.gruber@gmail.com</email>
0317 </para>
0318 
0319 <!-- TRANS:CREDIT_FOR_TRANSLATORS -->
0320 
0321 &underFDL;
0322 &underGPL;
0323 
0324 </chapter>
0325 
0326 
0327 &documentation.index;
0328 </book>
0329 <!--
0330 Local Variables:
0331 mode: sgml
0332 sgml-minimize-attributes:nil
0333 sgml-general-insert-case:lower
0334 sgml-always-quote-attributes:t
0335 sgml-indent-step:0
0336 sgml-indent-data:t
0337 End:
0338 -->