diff options
Diffstat (limited to 'doc/katomic')
| -rw-r--r-- | doc/katomic/Makefile.am | 4 | ||||
| -rw-r--r-- | doc/katomic/index.docbook | 358 |
2 files changed, 362 insertions, 0 deletions
diff --git a/doc/katomic/Makefile.am b/doc/katomic/Makefile.am new file mode 100644 index 00000000..368fc0da --- /dev/null +++ b/doc/katomic/Makefile.am @@ -0,0 +1,4 @@ + +KDE_DOCS = AUTO +KDE_LANG = en + diff --git a/doc/katomic/index.docbook b/doc/katomic/index.docbook new file mode 100644 index 00000000..c1ffb2c7 --- /dev/null +++ b/doc/katomic/index.docbook @@ -0,0 +1,358 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY kappname "&katomic;"> + <!ENTITY package "kdegames"> + <!ENTITY % English "INCLUDE"> + <!ENTITY % addindex "IGNORE"> +]> + +<book lang="&language;"> +<bookinfo> +<title>The Atomic Entertainment Handbook</title> + +<authorgroup> +<author> +<firstname>Dirk</firstname> +<surname>Doerflinger</surname> +</author> + +<othercredit role="developer"> +<firstname>Stephan</firstname><surname>Kulow</surname><contrib>Developer</contrib><affiliation><address>&Stephan.Kulow.mail;</address> +</affiliation></othercredit> +<othercredit role="developer"> +<firstname>Cristian</firstname><surname>Tibirna</surname><contrib>Developer</contrib><affiliation><address>&Cristian.Tibirna.mail;</address> +</affiliation></othercredit> +<othercredit role="reviewer"> +<firstname>Mike</firstname><surname>McBride</surname> +<contrib>Reviewer</contrib> +<affiliation><address>&Mike.McBride.mail;</address></affiliation> +</othercredit> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2005-12-14</date> +<releaseinfo>2.0</releaseinfo> + +<abstract> +<para>This Handbook describes &katomic; Version 2.0</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>kdegames</keyword> +<keyword>KAtomic</keyword> +<keyword>game</keyword> +<keyword>atomic entertainment</keyword> +</keywordset> +</bookinfo> + +<chapter id="introduction"> +<title>Introduction</title> +<para> +<application>Atomic Entertainment</application> is a small game which resembles +<application>Sokoban</application>. The object of the game is to build chemical +molecules on a <application>Sokoban</application> like board.</para> +</chapter> + + +<chapter id="playing-katomic"> +<title>Playing <application>Atomic Entertainment</application></title> + +<sect1 id="rules"> +<title>Rules</title> + +<para>The aim of <application>Atomic Entertainment</application> is to build +chemical molecules using basic atoms you are given. The molecule being built is +shown in a frame in the main window.</para> + +<para>Clicking on an atom will cause arrows to appear beside it. These arrows +show the direction the atom can be moved. After an arrow is clicked, the atom +will move in this direction until it reaches the next border or another atom. If +two atoms touch each other with the corresponding connectors, they form a +molecule. The atoms can only be moved one at a time. </para> + +<para>The level is solved when the new molecule has the same structure as shown +in the preview window.</para> + +<para>In the higher levels, some tactical skill will be necessary for solving +the puzzle.</para> + +<para>The best score in this game is actually the lower score, because the +goal is to solve a level with as few moves as +possible. <guilabel>Highscore:</guilabel> in the main-window shows +the lowest number of moves used for this level. <guilabel>Your score +so far:</guilabel> shows the current number of moves.</para> + +<para>The scrollbar on the top right of the main window changes the game +level.</para> + +</sect1> + +</chapter> + +<chapter id="configuration"> +<title>Menu Reference</title> + +<sect1 id="game-menu"> +<title>The <guimenu>Game</guimenu> Menu</title> + +<variablelist> + +<varlistentry> +<term> +<menuchoice> +<shortcut><keycap>F5</keycap></shortcut> +<guimenu>Game</guimenu> +<guimenuitem>Restart Game</guimenuitem></menuchoice></term> +<listitem><para>This will restart the current level.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut><keycombo action="simul">&Ctrl;<keycap>H</keycap></keycombo> +</shortcut> +<guimenu>Game</guimenu> +<guimenuitem>Show Highscores</guimenuitem></menuchoice></term> +<listitem><para>This will show the best scores for the current level.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut><keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo> +</shortcut> +<guimenu>Game</guimenu> +<guimenuitem>Quit</guimenuitem></menuchoice></term> +<listitem><para>Selecting this item will end your current game, and exit the +&katomic;.</para></listitem> +</varlistentry> +</variablelist> +</sect1> + +<sect1 id="move-menu"> +<title>The <guimenu>Move</guimenu> Menu</title> + +<variablelist> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>Z</keycap> +</keycombo> +</shortcut> +<guimenu>Move</guimenu> +<guimenuitem>Undo</guimenuitem> +</menuchoice> +</term> +<listitem> +<para><action>Undo the last move you made.</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;&Shift;<keycap>Z</keycap></keycombo> +</shortcut> +<guimenu>Move</guimenu> +<guimenuitem>Redo</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>If you have previously undone a move, you can redo it +here.</action></para> +</listitem> +</varlistentry> + +</variablelist> +</sect1> + +<sect1 id="settings-menu"> +<title>The <guimenu>Settings</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure +Shortcuts...</guimenuitem></menuchoice></term> +<listitem><para>This item lets you change the key settings of +<application>Atomic Entertainment</application>. See the section <link +linkend="keybindings" endterm="keybindings-title"></link> for a list of the +defaults.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenu>Settings</guimenu> +<guimenuitem>Configure &katomic;...</guimenuitem></menuchoice></term> +<listitem><para>In the dialog box that appears, the animation-speed of the +atomic movement can be set.</para></listitem> +</varlistentry> +</variablelist> + +</sect1> + +<sect1 id="help"> +<title>The <guimenu>Help</guimenu> Menu</title> + +&help.menu.documentation; + +</sect1> + +<sect1 id="keybindings"> +<title id="keybindings-title">Shortcuts</title> + +<para>Default shortcuts are:</para> + +<table> +<title>Shortcuts</title> +<tgroup cols="2"> +<tbody> +<row> +<entry>Restart Game</entry> +<entry> +<keycap>F5</keycap> +</entry> +</row> +<row> +<entry>Quit</entry> +<entry> +<keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo> +</entry> +</row> +<row> +<entry>Show Highscores</entry> +<entry> +<keycombo action="simul">&Ctrl;<keycap>H</keycap></keycombo> +</entry> +</row> +<row> +<entry>Undo</entry> +<entry> +<keycombo action="simul">&Ctrl;<keycap>Z</keycap></keycombo> +</entry> +</row> +<row> +<entry>Redo</entry> +<entry> +<keycombo action="simul">&Ctrl;&Shift;<keycap>Z</keycap></keycombo> +</entry> +</row> +<row> +<entry>Atom Down</entry> +<entry> +<keycap>Down Arrow</keycap> +</entry> +</row> +<row> +<entry>Atom Left</entry> +<entry> +<keycap>Left Arrow</keycap> +</entry> +</row> +<row> +<entry>Atom Right</entry> +<entry> +<keycap>Right Arrow</keycap> +</entry> +</row> +<row> +<entry>Atom Up</entry> +<entry> +<keycap>Up Arrow</keycap> +</entry> +</row> +<row> +<entry>Next Atom</entry> +<entry><keycap>Tab</keycap></entry> +</row> +<row> +<entry>Previous Atom</entry> +<entry><keycombo action="simul">&Shift;	</keycombo></entry> +</row> +<row> +<entry>Help</entry> +<entry><keycap>F1</keycap></entry> +</row> +<row> +<entry>What's this?</entry> +<entry> +<keycombo action="simul">&Shift;<keycap>F1</keycap></keycombo> +</entry> +</row> +</tbody> +</tgroup> +</table> + +</sect1> +</chapter> + + +<chapter id="credits"> +<title>Credits and License</title> + +<para> +<application>Atomic Entertainment</application> Copyright 1999 &Stephan.Kulow; +&Stephan.Kulow.mail; and Cristian Tibirna +&Cristian.Tibirna.mail;. +</para> +<para> +Atomic Copyright Andreas Wuest <email>Andreas [email protected]</email>. +</para> +<para> +Documentation Copyright 2000 &Dirk.Doerflinger; +<email>[email protected]</email> +</para> +<para> +Proofreading by Michael McBride +&Mike.McBride.mail; +</para> +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +&underFDL; +&underGPL; + +</chapter> + +<appendix id="installation"> +<title>Installation</title> +<sect1 id="getting-katomic"> +<title>How to obtain <application>Atomic Entertainment</application></title> + +<para> +<application>Atomic Entertainment</application> (&katomic;) is written for the &kde; project +<ulink url="http://www.kde.org">http://www.kde.org</ulink> by &Stephan.Kulow; +&Stephan.Kulow.mail; and Cristian Tiberna +&Cristian.Tibirna.mail;. +It is based on Atomic 1.0.67 by Andreas Wuest +<email>[email protected]</email>. +</para> + +&install.intro.documentation; + +</sect1> + +<sect1 id="requirements"> +<title>Requirements</title> +<para> +In order to successfully compile <application>Atomic Entertainment</application>, you need &kde; 3.0 </para> +<para> +All required libraries as well as <application>Atomic Entertainment</application> itself can be found on +&kde-ftp;.</para> +</sect1> + + +<sect1 id="compilation"> +<title>Compilation and Installation</title> + +&install.compile.documentation; + +</sect1> +</appendix> + +</book> +<!-- +Local Variables: +mode: sgml +sgml-omittag: nil +sgml-shorttag: t +End: +--> + + |