diff options
Diffstat (limited to 'doc')
130 files changed, 18540 insertions, 0 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am new file mode 100644 index 00000000..6812bd2d --- /dev/null +++ b/doc/Makefile.am @@ -0,0 +1,5 @@ + +KDE_LANG = en +KDE_DOCS = AUTO +SUBDIRS = $(AUTODIRS) + diff --git a/doc/api/kcarddialog.png b/doc/api/kcarddialog.png Binary files differnew file mode 100644 index 00000000..3446c461 --- /dev/null +++ b/doc/api/kcarddialog.png diff --git a/doc/atlantik/Makefile.am b/doc/atlantik/Makefile.am new file mode 100644 index 00000000..da8216ae --- /dev/null +++ b/doc/atlantik/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = AUTO +KDE_MANS = AUTO diff --git a/doc/atlantik/index.docbook b/doc/atlantik/index.docbook new file mode 100644 index 00000000..56c5079d --- /dev/null +++ b/doc/atlantik/index.docbook @@ -0,0 +1,323 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY kappname "&atlantik;"> + <!ENTITY package "kdegames"> + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE"> +]> + +<book lang="&language;"> + +<bookinfo> +<title>The &atlantik; Handbook</title> + +<authorgroup> +<author> +<firstname>Rob</firstname> +<surname>Kaper</surname> +<affiliation> +<address><email>kaper@kde.org</email></address> +</affiliation> +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<legalnotice>&FDLNotice;</legalnotice> + +<copyright> +<year>2002</year><year>2004</year> +<holder>&Rob.Kaper;</holder> +</copyright> + +<date>2005-12-10</date> +<releaseinfo>0.7.5</releaseinfo> + +<abstract> +<para> +&atlantik; is a &kde; client for playing <trademark +class="registered">Monopoly</trademark>-like boardgames on the +<command>monopd</command> network. +</para> + +</abstract> + + +<keywordset> +<keyword>KDE</keyword> +<keyword>kdegames</keyword> +<keyword>Atlantik</keyword> +<keyword>monopd</keyword> +</keywordset> + +</bookinfo> + +<chapter id="introduction"> +<title>Introduction</title> + +<para>Purpose of the &atlantik; board game is to acquire land in major +cities in North America and Europe while being a transatlantic traveler. To +win the game, players improve monopolized land with profitable buildings in +the hopes of bankrupting all other players.</para> + +<para>All game modes are served by monopd, a dedicated game server designed +for &atlantik;. One of the game modes plays like the popular real estate +board game known as <trademark class="registered">Monopoly</trademark>.</para> + +</chapter> + +<chapter id="connecting"> +<title>Connecting to a Server</title> + +<para>&atlantik; requires a game server to connect to. If you have an +Internet connection, you can request a list of public Internet servers and +you will not require additional software. If you want to play &atlantik; +locally, on a <acronym>LAN</acronym> or on a private Internet server, you +can enter the hostname and port to connect to. In this case, you will need +the <ulink url="http://robertjohnkaper.com/software/atlantik/download.html"> +<command>monopd</command></ulink> server +software installed and running on the host you are connecting to.</para> + +<para>If you have problems connecting to a server, the following troubleshoot +notes might help you:</para> + +<itemizedlist> +<listitem><para>Try another server. The public server list is updated every +three minutes, and the server you are trying to connect to might not be +available any longer.</para> +</listitem> +<listitem> +<para>Check your firewall and masquerading settings. Restrictions might be in +place preventing you from connecting to servers or receiving reply traffic. +By default, monopd servers use TCP port 1234. If you're not sure, contact +your system administrator.</para> +</listitem> +<listitem><para>&atlantik; makes use of +<classname>KExtendedSocket</classname> for network connections, which in +turn uses <classname>QDns</classname>. This might cause issues with IPv6 +and/or resolving hostnames.</para></listitem> +</itemizedlist> + +</chapter> + +<chapter id="menu-reference"> +<title>Menu Reference</title> + +<sect1 id="game-menu"> +<title><guimenu>Game</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>L</keycap></keycombo></shortcut> +<guimenu>Game</guimenu><guimenuitem>Show Event Log</guimenuitem></menuchoice></term> +<listitem><para>Display the event log</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>Quits &atlantik;.</para></listitem> +</varlistentry> +</variablelist> +</sect1> + +<sect1 id="move-menu"> +<title><guimenu>Move</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>R</keycap></keycombo></shortcut> +<guimenu>Move</guimenu><guimenuitem>Roll Dice</guimenuitem></menuchoice></term> +<listitem><para><action>As you may expect, roll the dice.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Move</guimenu><guimenuitem>End Turn</guimenuitem> +</menuchoice></term> +<listitem><para><action>Let the other player know you have finished +moving.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>R</keycap></keycombo></shortcut> +<guimenu>Move</guimenu><guimenuitem>Roll Dice</guimenuitem></menuchoice></term> +<listitem><para><action>As you may expect, roll the dice.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>B</keycap></keycombo></shortcut> +<guimenu>Move</guimenu><guimenuitem>Buy</guimenuitem></menuchoice></term> +<listitem><para>Buy land or buy buildings on your properties.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>A</keycap></keycombo></shortcut> +<guimenu>Move</guimenu><guimenuitem>Auction</guimenuitem></menuchoice></term> +<listitem><para>Start an auction.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Move</guimenu><guimenuitem>Use Card to Leave Jail</guimenuitem></menuchoice></term> +<listitem><para>Use a card to leave jail</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>P</keycap></keycombo></shortcut> +<guimenu>Move</guimenu><guimenuitem>Pay to Leave Jail</guimenuitem></menuchoice></term> +<listitem><para>Pay money to leave the jail.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>J</keycap></keycombo></shortcut> +<guimenu>Move</guimenu><guimenuitem>Roll to Leave Jail</guimenuitem></menuchoice></term> +<listitem><para>Roll the dice to leave the jail.</para></listitem> +</varlistentry> +</variablelist> +</sect1> + +<sect1 id="settings-menu"> +<title><guimenu>Settings</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Notifications...</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Displays</action> a standard &kde; notifications +configuration dialog to change the audio and visual notifications for &atlantik;.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure &atlantik;...</guimenuitem></menuchoice></term> +<listitem><para>Opens the configuration +dialog which lets you tweak a lot of &atlantik;'s options.</para></listitem> +</varlistentry> +</variablelist> +</sect1> + +<sect1 id="help-menu"> +<title><guimenu>Help</guimenu> Menu</title> + +&help.menu.documentation; + +</sect1> +</chapter> + +<chapter id="reporting-bugs"> +<title>Reporting Bugs</title> + +<para>If you think you have found a bug in &atlantik;, please report +it. Developers often catch and fix bugs themselves, but you might +experience issues not yet known. Not reporting your problems might +very well prevent them from being fixed indefinitely.</para> + +<para>Some bugs might be in the monopd server instead of &atlantik;, but you +don't need to worry about that: you can report all bugs under the &atlantik; +package on the <ulink url="http://bugs.kde.org/">&kde; bug +wizard</ulink>. Use the +<menuchoice><guimenu>Help</guimenu><guimenuitem>Report +Bug</guimenuitem></menuchoice> menu item to visit the bug wizard with some +details of your &atlantik; version filled in automatically.</para> + +<para>Please specify details in your bug report, such as game +conditions. For example, a bug might only occur when people are in jail, or +during an auction. If possible, save the event log and attach it to the bug +report or send it to the author. It might contain vital clues about behavior +that could lead to a faster resolution for the bug.</para> + +</chapter> + +<chapter id="download"> +<title>Download</title> + +<para>&atlantik; is part of &kde; releases and as such the recommended +releases are those shipped with &kde;, part of the &package; package. Some +vendors might have individual packages for &atlantik; based on these +releases.</para> + +<para>Users interested in the development version can likewise use the +standard <ulink url="http://www.kde.org/anoncvs.html">&kde; CVS +instructions</ulink> to acquire &atlantik; from the kdegames module.</para> + +<para>Bleeding edge development requiring the development version of monopd +is done using arch. For more information on this, or releases in general, +visit the <ulink +url="http://robertjohnkaper.com/software/atlantik/download.html">&atlantik;</ulink> download +page.</para> + +</chapter> + +<chapter id="faq-answers"> +<title>Answers to Frequently Asked Questions</title> + +<qandaset> + +<qandaentry> +<question> +<para>How do I add a computer player?</para> +</question> +<answer> +<para>Unfortunately, computer opponents are not yet supported by &atlantik;. +Work is in progress to development a network bot that can connect to +servers, called Pacifik, but is has +not yet reached a useful level.</para> +<para>Users are advised to take advantage of the public +Internet servers or a private <acronym>LAN</acronym> server.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>How do I trade?</para> +</question> +<answer> +<para>Click on a player portfolio or estate with the &RMB; and you can open +a trade.</para> +<para>There are a two usability issues with trades that can cause confusion. +If you in any way include another player in a trade, that player will get +the trade window. Any player can reject the terms, which unnecessarily ends +the trade session for all other players as well. A trade has to be accepted +by all players in it before it can completed, which can be complicated +because players remain a participant in deals even when they are no longer +involved with tradeable items.</para> +</answer> +</qandaentry> + +</qandaset> +</chapter> + +<chapter id="credits-and-licenses"> +<title>Credits and Licenses</title> + +<para>The program &atlantik; and the documentation are copyright © +1998-2004 Rob Kaper <email>kaper@kde.org</email>.</para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +&underFDL; +&underGPL; + + +</chapter> + +&documentation.index; + +</book> + +<!-- +Local Variables: +mode: sgml +sgml-minimize-attributes:nil +sgml-general-insert-case:lower +sgml-indent-step:0 +sgml-indent-data:nil +End: + +// vim:ts=2:sw=2:tw=78:noet +--> diff --git a/doc/atlantik/man-atlantik.6.docbook b/doc/atlantik/man-atlantik.6.docbook new file mode 100644 index 00000000..340650a6 --- /dev/null +++ b/doc/atlantik/man-atlantik.6.docbook @@ -0,0 +1,86 @@ +<?xml version="1.0" ?> +<!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + +<!ENTITY % English "INCLUDE"> +]> + +<refentry lang="&language;"> +<refentryinfo> +<author><personname><firstname>Lauri</firstname><surname>Watts</surname></personname> +<email>lauri@kde.org</email></author> +<date>March 7, 2003</date> +</refentryinfo> + +<refmeta> +<refentrytitle><command>atlantik</command></refentrytitle> +<manvolnum>6</manvolnum> +</refmeta> + +<refnamediv> +<refname><command>atlantik</command></refname> +<refpurpose>&kde; monopd client</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<cmdsynopsis> +<command>atlantik</command> +<group><option>-h, --host</option> <replaceable> host</replaceable></group> +<group><option>-p, --port</option> <replaceable> port</replaceable></group> +<group><option>-g, --game</option> <replaceable> game</replaceable></group> +<group><option>KDE Generic Options</option></group> +<group><option>Qt Generic Options</option></group> + +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1> +<title>Description</title> + +<para>&atlantik; is a &kde; client for playing Monopoly-like +boardgames on the monopd network.</para> + +<para>Purpose of the atlantik board game is to acquire land in major +cities in North America and Europe while being a transatlantic +traveller. All game modes are served by monopd, a dedicated game +server designed for &atlantik;. One of the game modes plays like the +popular real estate board game known as Monopoly.</para> + +</refsect1> + +<refsect1> +<title>Options</title> + +<variablelist> +<title>&atlantik; options</title> +<varlistentry> +<term><option>-h, --host</option> <parameter>host</parameter></term> +<listitem> +<para>Connect to this host.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><option>-p, --port</option> <parameter>port</parameter></term> +<listitem><para>Connect to this port</para></listitem> +</varlistentry> + +<varlistentry> +<term><option>-g, --game</option> <parameter>game</parameter></term> +<listitem><para>Join this game</para></listitem> +</varlistentry> +</variablelist> + +</refsect1> + +<refsect1> +<title>See Also</title> + +<para>More detailed user documentation is available from <ulink +url="help:/atlantik">help:/atlantik</ulink> (either enter this +<acronym>URL</acronym> into &konqueror;, or run +<userinput><command>khelpcenter</command> +<parameter>help:/atlantik</parameter></userinput>).</para> + +</refsect1> + +</refentry> diff --git a/doc/kasteroids/Makefile.am b/doc/kasteroids/Makefile.am new file mode 100644 index 00000000..368fc0da --- /dev/null +++ b/doc/kasteroids/Makefile.am @@ -0,0 +1,4 @@ + +KDE_DOCS = AUTO +KDE_LANG = en + diff --git a/doc/kasteroids/fuel.png b/doc/kasteroids/fuel.png Binary files differnew file mode 100644 index 00000000..7ee0ff73 --- /dev/null +++ b/doc/kasteroids/fuel.png diff --git a/doc/kasteroids/index.docbook b/doc/kasteroids/index.docbook new file mode 100644 index 00000000..61563db0 --- /dev/null +++ b/doc/kasteroids/index.docbook @@ -0,0 +1,328 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ +<!ENTITY kappname "&kasteroids;"> +<!ENTITY package "kdegames"> +<!ENTITY % addindex "IGNORE"> +<!ENTITY % English "INCLUDE" > <!-- change language only here --> +]> + +<book lang="&language;"> + +<bookinfo> + +<title>The &kasteroids; Handbook</title> + +<authorgroup> +<author> +&Martin.R.Jones; &Martin.R.Jones.mail; +</author> + +<author> +&Philip.Rodrigues; &Philip.Rodrigues.mail; +</author> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<copyright> +<year>2000</year> +<holder>Martin R. Jones</holder> +</copyright> + +<copyright> +<year>2001-2005</year> +<holder>Philip Rodrigues</holder> +</copyright> +<legalnotice>&FDLNotice;</legalnotice> + +<date>2005-01-18</date> +<releaseinfo>2.3</releaseinfo> + +<abstract><para>&kasteroids; is, as you would expect, the &kde; clone of the +popular <application>Asteroids</application> game.</para></abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>games</keyword> +<keyword>linux</keyword> +<keyword>asteroids</keyword> +</keywordset> + +</bookinfo> + +<chapter id="introduction"> +<title>Introduction</title> + +<para>The objective of &kasteroids; is to destroy all the asteroids on the +screen to advance to the next level. Your ship is destroyed if it makes contact +with an asteroid.</para> + +</chapter> + +<chapter id="ship"> +<title>Your Ship</title> + +<para>When your ship is first launched, it has only basic abilities: Turning, +Thrusting and Shooting</para> + +<para>In order to move your ship, rotate it to face the direction you wish to +travel and press the thrust key. Of course the ship has momentum, so you will +have to compensate when you select the angle of the ship. Thrusting uses fuel, +so you should not use your thrusters more than necessary.</para> + +<para>You have an unlimited amount of ammunition, so shoot away. Only a limited +number of shots can be active at once, though. If you repeatedly shoot and +miss, you will find that you are unable to shoot until some of the shots have +expired.</para> + +<para>Your ship has a limited amount of fuel. When all the ship's fuel has been +consumed it is unable to thrust anymore. This leaves you immobile, but not +defenseless ‐ you can still rotate and shoot.</para> + +<para>Fortunately the asteroids occasionally release fuel when they are shot. +Fly your ship into the fuel symbol to collect it.</para> + +<screenshot> +<screeninfo>Fuel Upgrade</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="fuel.png" format="PNG"/> +</imageobject> +<textobject> +<phrase>Fuel Upgrade</phrase> +</textobject> +<caption><para>Fuel Upgrade</para></caption> +</mediaobject> +</screenshot> + +</chapter> + +<chapter id="upgrades"> +<title>Ship Upgrades</title> + +<para>Occasionally when you shoot an asteroid a symbol will be produced. These +symbols represent upgrades to your ship. Fly over the symbol to install it in +your ship. The upgrades have a cumulative effect, up to a maximum of 5.</para> + +<para>The improvements available are:</para> + +<variablelist> +<varlistentry> +<term>>Brakes</term> +<listitem><para>Brakes stop your ship as quickly as possible. The more brake +upgrades you have the faster you can stop, with lower fuel +usage.</para></listitem> +</varlistentry> + +<varlistentry> +<term>Shields</term> +<listitem><para>Shields absorb the collision with asteroids, but use a lot of +fuel. You need at least two shield upgrades to survive a hit from a medium +sized rock, and 3 to survive a large rock. You will also need to have enough +fuel to maintain the shield during the strike.</para></listitem> +</varlistentry> +</variablelist> + +</chapter> + +<chapter id="controls"> +<title>Controls</title> + +<para>The key bindings are configurable via the +<menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure +Shortcuts...</guimenuitem></menuchoice> menu item.</para> + +<para>The defaults are:</para> + +<itemizedlist> +<listitem><para><action>Rotate Anti-Clockwise</action> - <keysym>Left +Arrow</keysym></para></listitem> +<listitem><para><action>Rotate Clockwise</action> - <keysym>Right +Arrow</keysym></para></listitem> +<listitem><para><action>Thrust</action> - <keysym>Up +Arrow</keysym></para></listitem> +<listitem><para><action>Shoot</action> - <keysym>Space +Bar</keysym></para></listitem> +<listitem><para><action>Shields</action> - <keycap>S</keycap></para></listitem> +<listitem><para><action>Pause</action> - <keycap>P</keycap></para></listitem> +<listitem><para><action>Brake</action> - <keycap>X</keycap></para></listitem> +</itemizedlist> + +</chapter> + +<chapter id="config"> +<title>Configuring &kasteroids;</title> +<para>&kasteroids; only has a few options, which can be reached from +<menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure +KAsteroids...</guimenuitem></menuchoice>.</para> + +<variablelist> +<varlistentry><term>Start new game with <replaceable>n</replaceable> +ships</term> +<listitem><para>When you start a new game, you have ships in +reserve, in case of an accident ;-). This specifies how many ships you have +<emphasis>in total</emphasis> when the game starts.</para> +</listitem> +</varlistentry> + +<varlistentry><term>Show Highscores on Game Over</term> +<listitem><para>If selected, shows all of the highscores each time you finish a +game, regardless of whether or not you achieve a highscore.</para> +</listitem> +</varlistentry> + +<varlistentry><term>Player can destroy Powerups</term> +<listitem><para>If selected, shooting a powerup destroys it. If unselected, the +powerup remains, allowing you to still pick it up.</para> +</listitem> +</varlistentry> + +</variablelist> + +</chapter> + +<chapter id="tips"> +<title>Tips</title> + +<para>Here are some tips that may help:</para> + +<tip><para>If you want to stop your ship, use the brakes rather than stopping +manually. The brakes stop you faster, with less fuel usage.</para></tip> + +<tip><para>Shields are expensive. They should be used as a last resort. Try to +use your thrusters to avoid collisions when practical.</para></tip> + +<tip><para>Avoid the edges of the playing field. It's more difficult to see +asteroids approaching from the opposite side of the field.</para></tip> +</chapter> + +<chapter id="menu-reference"> +<title>Menu Reference</title> +<sect1 id="game-menu"> +<title>The <guimenu>Game</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo> +</shortcut> +<guimenu>Game</guimenu> +<guimenuitem>New</guimenuitem> +</menuchoice></term> +<listitem><para><action>Starts a new game of +&kasteroids;</action></para></listitem> </varlistentry> +<varlistentry> +<term><menuchoice> +<shortcut><keycap>P</keycap></shortcut> +<guimenu>Game</guimenu> +<guimenuitem>Pause</guimenuitem> +</menuchoice></term> +<listitem><para><action>Pauses the game</action></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><action>Shows the High Scores for +&kasteroids;</action></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><action>Quits</action> &kasteroids;</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>Brings up the Shortcuts Configuration dialog. This is +a standard &kde; shortcuts configuration dialog, which you are +probably familiar with. See <xref linkend="controls"/> for details of the +default controls.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure KAsteroids...</guimenuitem> +</menuchoice></term> +<listitem><para><action>Brings up the configuration dialog</action> for +&kasteroids;. See <xref linkend="config"/>. +</para></listitem> </varlistentry> +</variablelist> + +</sect1> + +<sect1 id="help"> +<title>The <guimenuitem>Help</guimenuitem> Menu</title> + +&help.menu.documentation; + +</sect1> + +</chapter> + + +<chapter id="credits"> +<title>Credits</title> + +<para>&kasteroids;</para> + +<para>Program Copyright 1997 &Martin.R.Jones; &Martin.R.Jones.mail;</para> + +<para>Documentation based on the original by &Martin.R.Jones;, currently +maintained by &Philip.Rodrigues; &Philip.Rodrigues.mail;.</para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +&underFDL; +&underGPL; + +</chapter> + +<appendix id="installation"> +<title>Installation</title> + +<sect1 id="getting-kasteroids"> +<title>How to obtain &kasteroids;</title> + +&install.intro.documentation; + +</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 +sgml-indent-step: nil +End: +--> + + 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 Wuest@gmx.de</email>. +</para> +<para> +Documentation Copyright 2000 &Dirk.Doerflinger; +<email>ddoerflinger@gmx.net</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>AndreasWuest@gmx.de</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: +--> + + diff --git a/doc/kbackgammon/Makefile.am b/doc/kbackgammon/Makefile.am new file mode 100644 index 00000000..368fc0da --- /dev/null +++ b/doc/kbackgammon/Makefile.am @@ -0,0 +1,4 @@ + +KDE_DOCS = AUTO +KDE_LANG = en + diff --git a/doc/kbackgammon/board.png b/doc/kbackgammon/board.png Binary files differnew file mode 100644 index 00000000..2556cbcd --- /dev/null +++ b/doc/kbackgammon/board.png diff --git a/doc/kbackgammon/index.docbook b/doc/kbackgammon/index.docbook new file mode 100644 index 00000000..d8dfe39d --- /dev/null +++ b/doc/kbackgammon/index.docbook @@ -0,0 +1,622 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY kappname "&kbackgammon;"> + <!ENTITY package "kdegames"> + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE" > <!-- change language only here --> +]> + +<book lang="&language;"> + +<bookinfo> +<title>The &kbackgammon; Handbook</title> + +<authorgroup> +<author> +<firstname>Jens</firstname> +<surname>Hoefkens</surname> +<affiliation><address>&Jens.Hoefkens.mail;</address></affiliation> +</author> + +<othercredit role="developer"> +<firstname>Bo</firstname> +<surname>Thorsen</surname> +<affiliation><address>&Bo.Thorsen.mail;</address></affiliation> +<contrib>Developer</contrib> +</othercredit> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<copyright> +<year>1999</year><year>2000</year> +<holder>&Jens.Hoefkens;</holder> +</copyright> + +<legalnotice>&FDLNotice;</legalnotice> + +<date>2005-12-22</date> +<releaseinfo>2.6.0</releaseinfo> + +<abstract> +<para>&kbackgammon; is a graphical backgammon program for &kde;. It +supports backgammon games with other players, games against computer +engines like &GNU; <application>bg</application> and even on-line games +on the <ulink url="http://www.fibs.com/">First Internet Backgammon +Server</ulink>.</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>game</keyword> +<keyword>backgammon</keyword> +<keyword>FIBS</keyword> +<keyword>gnubg</keyword> +</keywordset> + +</bookinfo> + +<chapter id="introduction"> +<title>Introduction</title> + +<para>&kbackgammon; is a graphical backgammon program. The objective +of backgammon is to move your checkers off the board before your +opponent does. While the rules of backgammon are moderately difficult +(the most difficult part apparently being the initial positioning of +the checkers), this document does not try to teach these rules: please +refer to the Web, a book, or (probably best) a friend for this.</para> + +<para>&kbackgammon; offers you a graphical backgammon board that can +be used almost entirely by using the mouse (although textual commands +are also available and it should be possible to play backgammon +without the mouse, too). Therefore, &kbackgammon; is easy to use and +allows you to concentrate on the important aspects of playing +backgammon.</para> + +<para>In order to play backgammon, you usually need an +opponent. &kbackgammon; offers you to play against hundreds of +different opponents of various strength on the <ulink +url="http://www.fibs.com/">First Internet Backgammon +Server</ulink>. If you prefer, you may also use the <link +linkend="engine-offline">Offline Engine</link> which allows you to +play against yourself or friends that are with you at your +computer.</para> + +<para>In the near future &kbackgammon; will allow you to play against +<link linkend="engine-gnubg">&GNU; Backgammon</link>, which is a +powerful backgammon program that usually runs without a graphical +frontend. It plays on <acronym>FIBS</acronym> with a rating of about +2000 (which is quite high).</para> + +<para>Additionally, plans are on the way that will allow games over +the Internet between two &kbackgammon; programs (and their respective +users). Finally, the architecture of &kbackgammon; is quite open and +it is possible to include support for other engines easily (if you are +interested in this, please contact the author).</para> + +</chapter> + +<chapter id="use-the-board"> +<title>How to use the Board</title> + +<para>&kbackgammon; is centered around a graphical backgammon +board. This board consists of the checkers, the dice, and the +cube. All these game elements can be conveniently manipulated with the +mouse.</para> + +<para>The following image shows a typical game situation with the +white player moving from 1 to 24 and the black player moving from 24 +to 1. Currently, the white player owns the cube and has just rolled 3 +and 4.</para> + +<screenshot> +<screeninfo>The backgammon board</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="board.png" format="PNG"/> +</imageobject> +<textobject> +<phrase>The Board</phrase> +</textobject> +</mediaobject> +</screenshot> + +<para>If it is their turn, players can roll the dice by double +clicking on the squares representing the dice or by using the +corresponding menu entry or toolbar icon (if the toolbar is visible +and rolling has been included in the toolbar).</para> + +<para>If they own the cube, players can double the cube by either +double clicking on the square representing the cube or by using the +corresponding menu entry or toolbar icon (if the toolbar is visible +and the cube has been included in the toolbar).</para> + +<para>If it is their turn to move, players can move checkers by +clicking on them and moving the mouse pointer to the desired location +(while holding the mouse button continuously pressed). This is called +dragging the checker. Depending on the selection made in the current +<link linkend="engines">engine's</link> <link +linkend="prefs">configuration</link>, the move will be finished once +the maximum number of checkers has been moved (this may be anywhere +between 1 and 4 checkers, although it will usually be 2 +checkers).</para> + +<para>In addition to dragging the checkers, the board offers a feature +called <firstterm>short move feature</firstterm>. If this has been +enabled in the board's configuration menu, checkers can be moved by +simply clicking on them. The board will then automatically make the +shortest move possible away from the current field. If the short move +feature <link linkend="prefs">is enabled</link>, it may be set to +single or double click. This option is very useful for users of +touchpads that are sometimes difficult to use for dragging.</para> + +<para>Finally, the board has a certain smartness: it will only accept +moves that are allowed (based on the current dice). While the <link +linkend="engine-offline">offline engine</link> allows this to be +switched off (for the <guilabel>Edit Mode</guilabel>), this is usually +very helpful for unexperienced users (and advanced players will +probably never notice this). This feature can also be used to cancel a +move in progress: just drop it over an illegal field.</para> + +</chapter> + +<chapter id="engines"> +<title>Backgammon Engines</title> + +<para>&kbackgammon; is built around the backgammon board, which +doesn't know anything about how to play backgammon. The whole +infrastructure (rolling the dice, &etc;) that allows backgammon games +is handled by backgammon engines.</para> + +<sect1 id="engine-offline"> +<title>The Offline Engine</title> + +<para>The offline engine <guilabel>Open Board</guilabel> allows you to play against yourself, or +probably more fun, another person sitting with you.</para> + +</sect1> + +<sect1 id="engine-FIBS"> +<title>The <acronym>FIBS</acronym> Engine</title> + +<para><acronym>FIBS</acronym> is the <quote>First Internet Backgammon +Server</quote>, a 24-hour international online community of backgammon +players of all ages and experience from Beginner to Experts.</para> + +<para>As well as playing the game, <acronym>FIBS</acronym> allows you +to save games, chat with other players, and has a complex rating +system.</para> + +<para>There is also a large <ulink +url="http://www.fibs.com/">website</ulink> well worth some of your +time, if you are a backgammon fan.</para> + +</sect1> + +<sect1 id="engine-gnubg"> +<title>The &GNU; Backgammon Engine</title> + +<para>The GNUbg engine does not yet exist (although it already has an +entry in the <guilabel>Engine</guilabel> menu). Therefore, the +remainder of this section should be taken with a grain of salt.</para> + +<para>Use of the GNUbg engine requires a working installation of the +actual GNUbg program. &kbackgammon; then starts GNUbg in the +background and communicates with it. All this is transparent to the +user (&ie; it is hidden from the user) and all interaction with GNUbg +is through the &GUI; elements of &kbackgammon;.</para> + +<para>If there are other enhancements that can help using GNUbg from +&kbackgammon;, please contact the author of &kbackgammon; (or better: +send a patch). Some of the more advanced features will probably be +position analysis and save/restore functions. However, playing is the +most pressing issue.</para> + +<para>The one thing that will never happen is a combination of the +GNUbg and the <acronym>FIBS</acronym> engine! Using computer programs +to enhance user ratings is cheating!</para> + +</sect1> + +</chapter> + +<chapter id="prefs"> +<title>Game options</title> + +<para>The options to &kbackgammon; are set by selecting <menuchoice> +<guimenu>Settings</guimenu> <guimenuitem>Configure &kbackgammon;...</guimenuitem> +</menuchoice> from the menubar. This will bring up a dialog +box.</para> + +</chapter> + +<chapter id="command"> +<title>Menu Reference/Keyboard Shortcuts</title> + +<para>The following sections briefly describe each menubar option.</para> + +<sect1 id="file-menu"> +<title><guimenu>Game</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo> +</shortcut> +<guimenu>Game</guimenu> +<guimenuitem>New</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Start a new game</action>. This item opens a dialog to enter the nicknames of both players.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>P</keycap></keycombo> +</shortcut> +<guimenu>Game</guimenu> +<guimenuitem>Print...</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Print a picture of the board.</action></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><action>Quit</action> and close &kbackgammon;</para> +</listitem> +</varlistentry> +</variablelist> + +</sect1> + +<sect1 id="move-menu"> +<title><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> + +<varlistentry> +<term><menuchoice> +<guimenu>Move</guimenu> +<guimenuitem>Redisplay</guimenuitem> +</menuchoice></term> +<listitem><para><action>Redraw the board.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>R</keycap> +</keycombo> +</shortcut> +<guimenu>Move</guimenu> +<guimenuitem>Roll Dice</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>As you may expect, roll the dice.</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Move</guimenu> +<guimenuitem>End Turn</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Let the other player know you have finished +moving.</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Move</guimenu> +<guimenuitem>Double Cube</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Offer</action> the opponent player during the course of a game +(just before you roll the dice) to continue the game at twice the current stakes. +If the opponent rejects this offer, you win the game. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Move</guimenu> +<guisubmenu>Engine</guisubmenu> +</menuchoice> +</term> +<listitem> +<para>Choose from the various game engines (Open Board, FIBS, GNU Backgammon, Next Generation) here.</para> +</listitem> +</varlistentry> + +</variablelist> + +</sect1> + +<sect1 id="command-menu"> +<title><guimenu>Command</guimenu> Menu</title> + +<para>This menu has different items depending on the chosen game engine.</para> + +<para><guisubmenu>Open Board</guisubmenu> engine</para> + +<variablelist> +<varlistentry><term> +<menuchoice><guimenu>Command</guimenu> +<guimenuitem>New Game</guimenuitem> +</menuchoice></term> +<listitem><para> +<action>Start a new game</action>. This item opens a dialog to enter the nicknames of both players. +</para></listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice><guimenu>Command</guimenu> +<guimenuitem>Edit Mode</guimenuitem></menuchoice> +</term> +<listitem> +<para> +In this mode the board accepts moves that are not allowed +(based on the current dice). +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenu>Command</guimenu> +<guimenuitem>Swap Colors</guimenuitem></menuchoice> +</term> +<listitem> +<para> +Swap the colors of the checkers between player 1 and player 2. +</para> +</listitem> +</varlistentry> +</variablelist> + +<!-- To Do : write the menuitems for the other game engines +<para><guisubmenu>FIBS</guisubmenu> engine</para> +<para><guisubmenu>GNU Backgammon</guisubmenu> engine</para> +<para><guisubmenu>Next Generation</guisubmenu> engine</para> +--> +</sect1> + +<sect1 id="settings-menu"> +<title><guimenu>Settings</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>M</keycap> +</keycombo> +</shortcut> +<guimenu>Settings</guimenu> +<guimenuitem>Show Menubar</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Toggle on and off the menubar</action>.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guisubmenu>Toolbars</guisubmenu> +<guimenuitem>Main (&kbackgammon;)</guimenuitem> +</menuchoice></term> +<listitem><para><action>Toggle</action> the <guilabel>Main Toolbar</guilabel></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guisubmenu>Toolbars</guisubmenu> +<guimenuitem>Command Characters (&kbackgammon;)</guimenuitem> +</menuchoice></term> +<listitem><para><action>Toggle</action> the <guilabel>Command Toolbar</guilabel></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Show Statusbar</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Toggle on and off the statusbar</action>.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Save Settings</guimenuitem> +</menuchoice></term> +<listitem> +<para> +<action>Saves the current settings to become the default for &kbackgammon;.</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Shortcuts...</guimenuitem> +</menuchoice></term> +<listitem><para><action>Opens a dialog for changing the key bindings.</action> +Using this option you can change the standard key shortcut for &kbackgammon;'s commands +or create new ones.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Toolbars...</guimenuitem> +</menuchoice></term> +<listitem><para><action>Opens a dialog for configuring the toolbar.</action> You +can add and remove toolbuttons for &kbackgammon;'s commands with this +option.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure &kbackgammon;...</guimenuitem> +</menuchoice></term> +<listitem><para><action>Opens a dialog for changing some options</action> for +&kbackgammon;.</para> +</listitem> +</varlistentry> + +</variablelist> + +</sect1> + +<sect1 id="help-menu"> +<title><guimenu>Help</guimenu> Menu</title> + +<para>&kbackgammon; has a standard &kde; <guimenu>Help</guimenu> as described +below, with one addition:</para> + +<variablelist> +<varlistentry> +<term><menuchoice><guimenu>Help</guimenu> +<guimenuitem>Backgammon on the Web</guimenuitem> +</menuchoice></term> +<listitem> +<para>Opens the websites of FIBS Home, Backgammon Rules, or &kbackgammon; in &konqueror;.</para> +</listitem> +</varlistentry> +</variablelist> + +<para>The standard &kde; <guimenu>Help</guimenu> entries are:</para> + +&help.menu.documentation; + +</sect1> + +<sect1 id="keys"><title>Default Shortcuts</title> + +<para>The following tables show you the default shortcuts of +&kbackgammon;.</para> + +<table> +<title>Key bindings</title> +<tgroup cols="2"> +<thead><row><entry>Key Combo</entry><entry>Action</entry></row></thead> +<tbody> +<row><entry><keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo></entry><entry>New Game</entry></row> +<row><entry><keycombo action="simul">&Ctrl;<keycap>R</keycap></keycombo></entry><entry>Roll Dice</entry></row> +<row><entry><keycombo action="simul">&Ctrl;<keycap>P</keycap></keycombo></entry><entry>Print Game</entry></row> +<row><entry><keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo></entry><entry>Quit &kbackgammon;</entry></row> +<row><entry><keycap>F1</keycap></entry><entry>Help Contents</entry></row> +<row><entry><keycombo action="simul">&Shift;<keycap>F1</keycap></keycombo></entry><entry>What's This? Help</entry></row> +<row><entry><keycombo action="simul">&Ctrl;<keycap>M</keycap></keycombo></entry><entry>Show Menubar</entry></row> +<row><entry><keycombo action="simul">&Ctrl;<keycap>Z</keycap></keycombo></entry><entry>Undo move</entry></row> +<row><entry><keycombo action="simul">&Ctrl;&Shift;<keycap>Z</keycap></keycombo></entry><entry>Redo previously undone move</entry></row> +</tbody> +</tgroup> +</table> + +<para>These shortcuts can be changed by selecting <menuchoice> +<guimenu>Settings</guimenu> <guimenuitem>Configure +Shortcuts</guimenuitem> </menuchoice> from the menubar.</para> + +</sect1> + +</chapter> + +<chapter id="credits"> +<title>Credits and License</title> + +<para>&kbackgammon;</para> + +<para>Program copyright 1999-2000 &Jens.Hoefkens; +&Jens.Hoefkens.mail;</para> + +<para>Documentation copyright 2000 &Jens.Hoefkens; +&Jens.Hoefkens.mail;</para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +&underFDL; +&underGPL; + +</chapter> + +<appendix id="installation"> +<title>Installation</title> + +<sect1 id="getting-kbackgammon"> +<title>How to obtain &kbackgammon;</title> + +&install.intro.documentation; + +<para>The home page of &kbackgammon; is located at <ulink +url="http://backgammon.sourceforge.net/">http://backgammon.sourceforge.net</ulink>. +It will usually contain the most up-to-date information the program +available.</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: +--> + + diff --git a/doc/kbattleship/Makefile.am b/doc/kbattleship/Makefile.am new file mode 100644 index 00000000..41691557 --- /dev/null +++ b/doc/kbattleship/Makefile.am @@ -0,0 +1,3 @@ +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/kbattleship/index.docbook b/doc/kbattleship/index.docbook new file mode 100644 index 00000000..9e380d17 --- /dev/null +++ b/doc/kbattleship/index.docbook @@ -0,0 +1,485 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY kappname "&kbattleship;"> + <!ENTITY package "kdegames"> + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE" > <!-- change language only here --> +]> + +<book lang="&language;"> +<bookinfo> +<title>The &kbattleship; Handbook</title> + +<authorgroup> +<author> +&Daniel.Molkentin; &Daniel.Molkentin.mail; +</author> + +<author> +&Nikolas.Zimmermann; &Nikolas.Zimmermann.mail; +</author> + +<othercredit role="reviewer"> +&Frerich.Raabe; +<!-- <contrib>Reviewer</contrib> --> +&Frerich.Raabe.mail; +</othercredit> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> + +</authorgroup> + +<legalnotice>&FDLNotice;</legalnotice> + +<copyright> +<year>2001</year> +<holder>&Daniel.Molkentin;</holder> +</copyright> +<copyright> +<year>2001</year> +<holder>&Nikolas.Zimmermann;</holder> +</copyright> +<copyright> +<year>2001</year> +<holder>Kevin Krammer</holder> +</copyright> + + +<date>2005-12-14</date> +<releaseinfo>1.1</releaseinfo> + +<abstract> +<para> +&kbattleship; is a network-enabled implementation of the famous <quote>Battle Ship</quote> game for &kde;.</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>kdegames</keyword> +<keyword>kbattleship</keyword> +<keyword>game</keyword> +<keyword>battleship</keyword> +<keyword>battle</keyword> +</keywordset> + +</bookinfo> + +<chapter id="introduction"> +<title>Introduction</title> + +<sect1 id="features"> +<title>Features</title> +<itemizedlist> +<listitem><para>Network Gaming</para></listitem> +<listitem><para>Computer Player (AI)</para></listitem> +<listitem><para>Sounds</para></listitem> +<listitem><para>Chat</para></listitem> +<listitem><para>Statistics</para></listitem> +<listitem><para>Highscore List</para></listitem> +</itemizedlist> + +<tip> +<para> +&kbattleship; uses an &XML; based communication protocol so you can write +clients for every platform and in any language. If you want to write +one in your favorite programming language or/and environment, contact +us. We would really like to hear of it. +</para> +</tip> +</sect1> + +</chapter> + +<chapter id="using-kbattleship"> +<title>Using &kbattleship;</title> + +<para> +If you want to play &kbattleship;, you will need two players, either play +against the computer or in a network against another player.</para> +<para> +In a network game one player has to open the game via +<menuchoice><guimenu>Game</guimenu> <guimenuitem>Start +Server</guimenuitem></menuchoice> or by pressing <keycap>F3</keycap>. +</para> + +<para> +A dialog box opens which will ask you for for a +<guilabel>Nick name:</guilabel> and <guilabel>Port:</guilabel>. Normally, +&kbattleship; will suggest your login name but you can enter any string +you want. The predefined port should be OK. However, if you encounter +problems, you can choose any other free ports above 1024. +</para> + +<note> +<para>You need to tell the other player in case you use a port other than +the default as both players need to use the same port in order to be able +to establish a connection.</para> +</note> + +<para> +The other player has to choose <menuchoice><guimenu>Game</guimenu> +<guimenuitem>Connect to Server</guimenuitem></menuchoice>, or press +<keycap>F2</keycap>. Again, a <guilabel>Nick name:</guilabel> is +suggested, but you can choose any name you like. +</para> + +<para> +An important point is the field <guilabel>Server:</guilabel>. Here, you +have to enter the host name of the server (the machine of the player +that initiated the game). +</para> + +<para> +Another possibility is to play &kbattleship; against your +computer. Select <guimenuitem>Single Player</guimenuitem> from the +<guimenuitem>Game</guimenuitem> Menu, or press <keycap>F4</keycap>. +</para> + +<para> +When you are done, you can start the game. Simply follow the +instructions in the statusbar. It will issue hints and suggest what to +do next. When you now look at the screen, you will find two grid fields, +the so-called <quote>battle areas</quote>. The left area belongs to +you. This is where you place your ships and where you can follow the +military actions of your enemy. The right area is where your enemy's +fleet is located. When it's your turn to fire, you need to click on a +certain sector (a field of the battle area) where you suppose the ships +to be located. +</para> + +<para> +First, you need to place your ships. The game initiator starts. When +he/she is done, player two sets his/her ships. +</para> + +<para> +Ship placement is very easy: Simply click on the field where you want to +place your ship. The first one will have a length of four squares, the next +will be three squares long &etc;. Click on the field where you want to start +the placement. If you click with the &LMB; the ship will be placed horizontally, +a &Shift; &LMB; click will cause it to be placed +vertically. &Shift; itself will flip the ship placement preview. +</para> + +<para> +Now you can blindly fire with a &LMB; click on the enemy battle area. The status bar indicates +who is about to shoot. +</para> + +<para> +The first player destroying all their opponents ships wins the game! +</para> + +</chapter> + +<chapter id="menu-reference"> +<title>The Menus</title> + +<sect1 id="game-menu"> +<title>The <guimenu>Game</guimenu> menu</title> + +<variablelist> +<varlistentry> +<term> +<menuchoice> +<shortcut><keycap>F2</keycap></shortcut> +<guimenu>Game</guimenu> +<guimenuitem>Connect to Server...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +<action>Initiate a connection to another player's server.</action> +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut><keycap>F3</keycap></shortcut> +<guimenu>Game</guimenu> +<guimenuitem>Start Server...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +<action>Start the server so another player can connect to you.</action> +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut><keycap>F4</keycap></shortcut> +<guimenu>Game</guimenu> +<guimenuitem>Single Player...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +<action>Start a game with your computer as the opponent.</action> +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut action="simul">&Ctrl;<keycap>H</keycap></shortcut> +<guimenu>Game</guimenu> +<guimenuitem>Show Highscores</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +<action>Show the highest scores so far.</action> +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycap>F11</keycap></shortcut> +<guimenu>Game</guimenu> +<guimenuitem>Enemy Info</guimenuitem> +</menuchoice></term> +<listitem> +<para>Show the enemy's client (might also be &Mac;), the client +version, a short description and the protocol version used.</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> +<action>Exit</action> &kbattleship; +</para> +</listitem> +</varlistentry> +</variablelist> +</sect1> + +<sect1 id="settings-menu"> +<title>The <guimenu>Settings</guimenu> menu</title> + +<variablelist> +<varlistentry> +<term> +<menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Show Statusbar</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +<action>Toggle on or off the display of the statusbar.</action> The +default is on. +</para> +</listitem> +</varlistentry> + + +<varlistentry> +<term> +<menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Show Grid</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +<action>Toggle on and off the display of a grid on the playing +field.</action> The default is off. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Play Sounds</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +<action>Toggle whether sounds (played when shooting) should be played.</action> +The default is on. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Shortcuts...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +<action>Configure the keyboard shortcuts used by &kbattleship;.</action> +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Notifications...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +<action>Configure</action> the audio and visual notifications used by &kbattleship;. +</para> +</listitem> +</varlistentry> + + +</variablelist> +</sect1> + +<sect1 id="help-menu"> +<title>The <guimenu>Help</guimenu> menu</title> + +&help.menu.documentation; + +</sect1> +</chapter> + +<chapter id="questions-answers-and-tips"> +<title>Questions, Answers, and Tips</title> + +<qandaset id="faq"> +<title>Frequently asked questions</title> +<qandaentry> +<question> +<para>I get the error: <errorname>Couldn't connect to &arts; +Soundserver. Sound deactivated.</errorname></para> +</question> +<answer> +<para>&kbattleship; relies on &arts;, &kde;'s soundserver, to play any +sound. Enable &arts; in the &kcontrolcenter; by browsing to +<menuchoice><guisubmenu>Sound & Multimedia</guisubmenu> +<guimenuitem>Sound System</guimenuitem></menuchoice> and making sure that +the box labelled <guilabel>Enable the sound system</guilabel> is checked.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>I have a question that is likely to become a &FAQ;. Who should I +contact?</para> +</question> +<answer> +<para>Contact the authors. They will most likely add it here.</para> +</answer> +</qandaentry> +</qandaset> + +</chapter> + +<chapter id="credits"> +<title>Credits and Licenses</title> + +<para>&kbattleship; Copyright 2000, 2001</para> + +<itemizedlist> +<title>Authors</title> +<listitem> +<para> +&Nikolas.Zimmermann; &Nikolas.Zimmermann.mail; +</para> +</listitem> +<listitem> +<para> +&Daniel.Molkentin; &Daniel.Molkentin.mail; +</para> +</listitem> +<listitem> +<para> +Kevin Krammer <email>kevin.krammer@gmx.at</email> +</para> +</listitem> +</itemizedlist> + +<itemizedlist> +<title>Contributors</title> +<listitem> +<para> +Benjamin Adler <email>benadler@bigfoot.de</email> +</para> +</listitem> +<listitem> +<para> +Nils Trzebin <email>nils.trzebin@stud.uni-hannover.de</email> +</para> +</listitem> + +<listitem> +<para>Elmar Hoefner <email>elmar.hoefner@uibk.ac.at</email></para> +</listitem> + +</itemizedlist> + +<para>Documentation updated for &kde; 3.4 by +<personname><firstname>Brian</firstname><surname>Beck</surname></personname> +<email>brian.beck@mchsi.com</email></para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +&underFDL; +&underGPL; + +</chapter> + +<appendix id="installation"> +<title>Installation</title> + +&install.intro.documentation; + +<sect1 id="requirements"> +<title>Requirements</title> + +<para><!-- This needs updating --> +At the time of writing, &kbattleship; requires &kde; 3.x or greater and +&Qt; 3.x or greater. +</para> + +</sect1> + +<sect1 id="compiling"> +<title>Compiling</title> + +&install.compile.documentation; + +</sect1> + +</appendix> + +</book> +<!-- +Local Variables: +mode: sgml +sgml-omittag:nil +sgml-shorttag:t +sgml-general-insert-case:lower +sgml-indent-step:0 +sgml-indent-data:nil +End: +--> + diff --git a/doc/kblackbox/Makefile.am b/doc/kblackbox/Makefile.am new file mode 100644 index 00000000..368fc0da --- /dev/null +++ b/doc/kblackbox/Makefile.am @@ -0,0 +1,4 @@ + +KDE_DOCS = AUTO +KDE_LANG = en + diff --git a/doc/kblackbox/index.docbook b/doc/kblackbox/index.docbook new file mode 100644 index 00000000..d45c2f76 --- /dev/null +++ b/doc/kblackbox/index.docbook @@ -0,0 +1,491 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY kappname "&kblackbox;"> + <!ENTITY package "kdegames"> + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE" > <!-- change language only here --> +]> + +<book lang="&language;"> + +<bookinfo> +<title>&kblackbox; Game Manual</title> + +<authorgroup> +<author> +&Robert.Cimrman; &Robert.Cimrman.mail; +</author> + +<author> +&Philip.Rodrigues; &Philip.Rodrigues.mail; +</author> + +<othercredit role="developer"> +&Robert.Cimrman; &Robert.Cimrman.mail; +<!-- Uncomment this when xslt bug is fixed! +<contrib>Developer</contrib> +--> +</othercredit> + +<othercredit role="reviewer"> +&Lauri.Watts; &Lauri.Watts.mail; +<!-- Uncomment this when xslt bug is fixed! +<contrib>Reviewer</contrib> +--> +</othercredit> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> + +</authorgroup> + +<copyright> +<year>1998</year><year>2000</year> +<holder>&Robert.Cimrman;</holder> +</copyright> + +<copyright> +<year>2001-2003</year> +<holder>&Philip.Rodrigues;</holder> +</copyright> + +<legalnotice>&FDLNotice;</legalnotice> + +<date>2005-12-10</date> +<releaseinfo>0.3.0</releaseinfo> + +<abstract><para>&kblackbox; is a superb graphical logical game, inspired +by the <application>emacs</application> blackbox game.</para></abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KBlackBox</keyword> +<keyword>kdegames</keyword> +<keyword>blackbox</keyword> +<keyword>game</keyword> +</keywordset> + +</bookinfo> + +<chapter id="what-is-kblackbox"> +<title>What is &kblackbox;?</title> + +<para>&kblackbox; is a superb :-) graphical logical game, inspired by +the <application>emacs</application> blackbox game. A major part of this help +file is based on the original <application>emacs</application> +help. </para> + +<para>&kblackbox; is a game of hide and seek played on a grid of +boxes. Your opponent (the Random number generator, in this case) has +hidden several balls within this box. By shooting rays into the box and +observing where they emerge it is possible to deduce the positions of +the hidden balls. The fewer rays you use to find the balls, the better +(the lower) your score.</para> + +</chapter> + +<chapter id="game-description"> +<title>Game Description</title> + +<para>In the first part of this section a description of the game board +will be given. The second part deals with user interaction with the +game board and finally in the third part the actual game rules are +explained.</para> + +<sect1 id="game-board-descritpion"> +<title>Game Board Description</title> + +<para>The following types of field are found on the game board: </para> + +<variablelist> +<varlistentry> +<term><interface>Black squares</interface></term> +<listitem><para>The black box. Here you must mark the squares you think +a ball is in.</para></listitem> +</varlistentry> + +<varlistentry> +<term><interface>Green squares</interface></term> +<listitem><para>These are the lasers, shooting rays of light when +switched on.</para></listitem> +</varlistentry> + +<varlistentry> +<term><interface>Light Gray squares</interface></term> +<listitem><para>Nothing here of interest, this is just a +border :-).</para></listitem> +</varlistentry> + +<varlistentry> +<term><interface>Blue balls</interface></term> +<listitem><para><quote>There must be one there!</quote> you think. These mark +where you suspect a ball is placed in the black box.</para></listitem> +</varlistentry> + +<varlistentry> +<term><interface>Cyan balls</interface></term> +<listitem><para>Show where the balls actually are.</para></listitem> +</varlistentry> + +<varlistentry> +<term><interface>Red balls</interface></term> +<listitem><para>Incorrectly positioned balls you have marked are +indicated in red.</para></listitem> +</varlistentry> + +<varlistentry> +<term><interface>Brown squares</interface></term> +<listitem><para>Marking color</para></listitem> +</varlistentry> +</variablelist> + +<note><para>The names of colors are used just for identifying the +different types of the fields in this text. They <emphasis>might +not</emphasis> be in any relation with the actual color of the +fields. Simply said: the black box is in the center, around are the +lasers and around them is the border. Remap the colors yourself +:-). </para></note> + +</sect1> + +<sect1 id="user-interaction"> +<title>User Interaction</title> + +<para>The cursor can be moved around the box with the +standard cursor movement keys or the mouse. Switching of lasers or +marking of black boxes is done with the &LMB;, or by pressing the +<keycap>Return</keycap> or &Enter; key.</para> + +<para>You can mark the fields where you think a ball cannot be, too. Just press +the &RMB;. It often helps you to find an area where a ball could possibly +be. To clear any marks (blue or brown) press the +&LMB;. Brown marks cannot overwrite blue +marks. This way you cannot erase the blue marks (guessed balls) by accident when +playing with the &RMB;. </para> + +<para>When you think the configuration of balls you have placed is +correct, press the &MMB;. You +will be informed whether you are correct or not, and be given your +score. Your score is the number of letters and numbers around the +outside of the box plus five for each incorrectly placed ball. If you +placed any balls incorrectly, they will be indicated with red fields, +and their actual positions indicated with cyan fields.</para> + +</sect1> + +<sect1 id="game-rules"> +<title>Game Rules</title> + +<para>You have to find balls hidden in the black box. Your means are +limited - you can just fire lasers which are around the box. There are +three possible outcomes for each ray you send into the box: </para> + +<anchor id="detour"/> +<variablelist> + +<varlistentry> +<term>Detour</term> +<listitem><para>The ray is deflected and emerges somewhere other than +where you sent it in. On the playfield, detours are denoted by matching +pairs of numbers - one where the ray went in, and the other where it +came out.</para></listitem> +</varlistentry> + +<varlistentry> +<term>Reflection</term> +<listitem><para>The ray is reflected and emerges in the same place it +was sent in. On the playfield, reflections are denoted by the letter +<guilabel>R</guilabel>.</para></listitem> +</varlistentry> + +<varlistentry> +<term>Hit</term> +<listitem><para>The ray strikes a ball directly and is absorbed. It does not +emerge from the box. On the playfield, hits are denoted by the letter +<guilabel>H</guilabel>.</para></listitem> +</varlistentry> +</variablelist> + +<para>The rules for how balls deflect rays are simple and are best shown by +example.</para> + +<para>As a ray approaches a ball it is deflected ninety degrees. Rays +can be deflected multiple times. In the diagrams below, the dashes +represent empty box locations and the letter <guilabel>O</guilabel> +represents a ball. The entrance and exit points of each ray are marked +with numbers as described under <link linkend="detour">Detour</link> +above. Note that the entrance and exit points are always +interchangeable. <guilabel>*</guilabel> denotes the path taken by the +ray.</para> + +<para>Note carefully the relative positions of the ball and the ninety +degree deflection it causes.</para> + +<screen> + 1 + - * - - - - - - - - - - - - - - - - - - - - - - + - * - - - - - - - - - - - - - - - - - - - - - - +1 * * - - - - - - - - - - - - - - - O - - - - O - + - - O - - - - - - - O - - - - - - - * * * * - - + - - - - - - - - - - - * * * * * 2 3 * * * - - * - - + - - - - - - - - - - - * - - - - - - - O - * - - + - - - - - - - - - - - * - - - - - - - - * * - - + - - - - - - - - - - - * - - - - - - - - * - O - + 2 3 +</screen> + +<para> +As mentioned above, a reflection occurs when a ray emerges from the same +point it was sent in. This can happen in several ways: +</para> + +<screen> + - - - - - - - - - - - - - - - - - - - - - - - - + - - - - O - - - - - O - O - - - - - - - - - - - +R * * * * - - - - - - - * - - - - O - - - - - - - + - - - - O - - - - - - * - - - - R - - - - - - - - + - - - - - - - - - - - * - - - - - - - - - - - - + - - - - - - - - - - - * - - - - - - - - - - - - + - - - - - - - - R * * * * - - - - - - - - - - - - + - - - - - - - - - - - - O - - - - - - - - - - - + +</screen> + +<para>In the first example, the ray is deflected downwards by the upper +ball, then left by the lower ball, and finally retraces its path to its +point of origin. The second example is similar. The third example is a +bit anomalous but can be rationalized by realizing the ray never gets a +chance to get into the box. Alternatively, the ray can be thought of as +being deflected downwards and immediately emerging from the box.</para> + +<para>A hit occurs when a ray runs straight into a ball:</para> + +<screen> + - - - - - - - - - - - - - - - - - - - - - - - - + - - - - - - - - - - - - - - - - - - - - O - - - + - - - - - - - - - - - - O - - - H * * * * - - - - + - - - - - - - - H * * * * O - - - - - - * - - - - + - - - - - - - - - - - - O - - - - - - O - - - - +H * * * O - - - - - - - - - - - - - - - - - - - - + - - - - - - - - - - - - - - - - - - - - - - - - + - - - - - - - - - - - - - - - - - - - - - - - - + +</screen> + +<para>Be sure to compare the second example of a hit with the first +example of a reflection.</para> + +</sect1> +</chapter> +<chapter id="gui-description"> +<title>&GUI; description</title> + +<sect1 id="game-menu"> +<title>The <guimenu>Game</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo> +</shortcut> +<guimenu>Game</guimenu> +<guimenuitem>New</guimenuitem></menuchoice></term> +<listitem><para>Starts a new game (and abandons the current, if +any.)</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenu>Game</guimenu> +<guimenuitem>Give Up</guimenuitem></menuchoice></term> +<listitem><para>Shows you positions of the balls.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenu>Game</guimenu> +<guimenuitem>Done</guimenuitem></menuchoice></term> +<listitem><para>Checks whether all balls are placed. If yes, it terminates +the current game, computes the final score and indicates real positions of +the balls. The <mousebutton>middle</mousebutton> mouse button has the same +function. </para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenu>Game</guimenu> +<guimenuitem>Resize</guimenuitem></menuchoice></term> +<listitem><para>Resizes the main window, so that its contents fit perfectly. This is useful when you accidentally change the size of the +window...</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>Quits &kblackbox;</para></listitem> +</varlistentry> +</variablelist> + +</sect1> + +<sect1 id="settings-menu"> +<title>The <guimenu>Settings</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu><guimenuitem>Show/Hide Toolbar</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Shows or hides the &kblackbox; toolbar.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu><guimenuitem>Show/Hide Statusbar</guimenuitem> +</menuchoice></term> +<listitem> +<para>Shows or hides the &kblackbox; status bar at the base of the screen.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenu>Settings</guimenu> +<guisubmenu>Size</guisubmenu></menuchoice></term> +<listitem><para>Sets the size of the game field (black box). You may choose +between <guimenuitem>8 x 8</guimenuitem>, <guimenuitem>10 x 10</guimenuitem> and +<guimenuitem>12 x 12</guimenuitem>. The default is <guimenuitem>8 x +8</guimenuitem>.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenu>Settings</guimenu> +<guisubmenu>Balls</guisubmenu></menuchoice></term> +<listitem><para>Sets the number of balls in the black box. You may choose +between <guimenuitem>4</guimenuitem> (the default), <guimenuitem>6</guimenuitem> +or <guimenuitem>8</guimenuitem>.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenu>Settings</guimenu> +<guimenuitem>Tutorial</guimenuitem></menuchoice></term> +<listitem><para>Switches the tutorial mode on or off. In tutorial mode, +you can see where the balls actually are. Note that you have to start a new +game for this change to take effect.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenu>Settings</guimenu> +<guimenuitem>Configure Shortcuts...</guimenuitem></menuchoice></term> +<listitem><para>Displays a standard &kde; shortcut configuration dialog, in +which you can change the keyboard shortcuts used by &kblackbox;.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu><guimenuitem>Configure Toolbars...</guimenuitem> +</menuchoice></term> +<listitem> +<para>Brings up the standard &kde; toolbar configuration dialog to customize the &kblackbox; toolbar.</para> +</listitem> +</varlistentry> + +</variablelist> + +</sect1> + +<sect1 id="help"> +<title>The <guimenuitem>Help</guimenuitem> Menu</title> + +&help.menu.documentation; + +</sect1> + +<sect1 id="toolbar"> +<title>The Toolbar</title> + +<screenshot> +<screeninfo>&kblackbox;'s toolbar</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="kblackboxtbar.png" format="PNG"/> +</imageobject> +</mediaobject> +</screenshot> + +<para>The &kblackbox; toolbar offers quick access to the most commonly used +&kblackbox; functions. From left to right, the icons are:</para> + +<variablelist> + +<varlistentry> +<term><guiicon>New</guiicon></term> +<listitem><para>Starts a new game.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guiicon>Give Up</guiicon></term> +<listitem><para>Shows you positions of the balls.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guiicon>Done</guiicon></term> +<listitem><para>Checks whether all balls are placed. If yes, it terminates +the current game, computes the final score and indicates real positions of +the balls. The <mousebutton>middle</mousebutton> mouse button has the same +function. </para></listitem> +</varlistentry> + +</variablelist> +</sect1> +</chapter> + +<chapter id="credits-and-license"> +<title>Credits and License</title> + +<para>&kblackbox;</para> + +<para>Program Copyright 1998-2000 &Robert.Cimrman; &Robert.Cimrman.mail;</para> + +<para>Documentation by &Robert.Cimrman;. Updated and converted to Docbook +for &kde; 2.0 by &Lauri.Watts; &Lauri.Watts.mail;</para> + +<para> +Current maintainer &Philip.Rodrigues; &Philip.Rodrigues.mail; +</para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +&underFDL; +&underGPL; + +</chapter> + + +<appendix id="installation"> +<title>Installation</title> + +&install.intro.documentation; + +<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: +--> + diff --git a/doc/kblackbox/kblackboxtbar.png b/doc/kblackbox/kblackboxtbar.png Binary files differnew file mode 100644 index 00000000..1f129bc8 --- /dev/null +++ b/doc/kblackbox/kblackboxtbar.png diff --git a/doc/kbounce/Makefile.am b/doc/kbounce/Makefile.am new file mode 100644 index 00000000..085981d9 --- /dev/null +++ b/doc/kbounce/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/kbounce/index.docbook b/doc/kbounce/index.docbook new file mode 100644 index 00000000..8e4896d1 --- /dev/null +++ b/doc/kbounce/index.docbook @@ -0,0 +1,383 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY kappname "&kbounce;"> + <!ENTITY package "kdegames"> + <!ENTITY % English "INCLUDE" > + <!ENTITY % addindex "IGNORE"> +]> + +<book lang="&language;"> + +<bookinfo> +<title>The &kbounce; Handbook</title> + +<authorgroup> +<author> +&Aaron.J.Seigo; &Aaron.J.Seigo.mail; +</author> + +<othercredit role="reviewer"> +&Lauri.Watts; &Lauri.Watts.mail; +<!-- <contrib>Reviewer</contrib> --> +</othercredit> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<legalnotice>&FDLNotice;</legalnotice> + +<date>2005-12-10</date> +<releaseinfo>0.5</releaseinfo> + +<!-- Abstract about this handbook --> + +<abstract> +<para> +&kbounce; is a ball game for &kde;. +</para> +</abstract> + + +<keywordset> +<keyword>KDE</keyword> +<keyword>kdegames</keyword> +<keyword>jezzball</keyword> +</keywordset> + +</bookinfo> + +<chapter id="how-to-play"> +<title>How To Play</title> + +<para>&kbounce; is played on a field, surrounded by a wall, with two or +more balls that move about in the field bouncing off of the +walls.</para> + +<para>Walls are a darker color while the active areas of the field are +a lighter color.</para> + +<para>The size of the active area of the field is decreased by making +new walls that enclose areas without balls in them. To complete a +level, the player must decrease the size of the active field by at +least 75% within the time allowed.</para> + +<para>With each new level, another ball is added to the field, and the +player is given one more life than in the level before. The time +allotted to complete the level is also increased.</para> + +<para>Scoring is based on how much of the field is cleared.</para> + +<para>New walls are built by clicking the +<mousebutton>left</mousebutton> mouse button in an active area of the +field, at which point two walls will begin to grow in opposite +directions from the square the mouse was clicked in. Only two walls +may be growing on the screen at any given time.</para> + +<screenshot> +<screeninfo>A new wall growing</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="jezball_newWall.png" format="PNG"/> +</imageobject> +<textobject> +<phrase>A new wall growing</phrase> +</textobject> +</mediaobject> +</screenshot> + +<para>When the mouse is on the field, the cursor is shown as a pair of +arrows pointing in opposite directions, either horizontally or +vertically. The arrows point in the direction the walls will grow +when the <mousebutton>left</mousebutton> is clicked. This direction +can be changed by clicking the <mousebutton>right</mousebutton> mouse +button.</para> + +<para>A new wall has a <quote>head</quote> which moves away from the +point where the mouse was clicked. A wall is not permanent until this +<quote>head</quote> runs into another wall. If a ball collides with +any part of the wall except the head, before the head has run into +another wall, the new wall will disappear completely and one life will +be lost. If a ball collides with the head in the direction of the +wall's growth, the wall will stop growing there, and become permanent, +with no loss of life. If a ball collides with the head from any other +side, the ball will bounce off and the wall will continue to grow +normally.</para> + +</chapter> + +<chapter id="strategy"> +<title>Strategy</title> + +<para>Many players find the game becomes quite difficult by only the +third or fourth level, given the number of balls on the field at +once.</para> + +<para>The trick to playing &kbounce; successfully is to build +<quote>corridors</quote>. To build a corridor, start a pair of walls +growing close to another wall, and time it such that one of the walls +will be hit by a ball and one of the walls will not, and thus become +permanent.</para> + +<screenshot> +<screeninfo>Building a corridor</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="jezball_corridor1.png" format="PNG"/> +</imageobject> +<textobject> +<phrase>Building a corridor</phrase> +</textobject> +</mediaobject> +</screenshot> + +<para>This will leave a narrow corridor only a few squares high on the +field, surrounded on three sides by walls. Wait for the balls to +bounce into the open end of the corridor, and close the corridor +behind the ball with a new wall. Although you will most likely lose a +life for each corridor created, you can trap several balls in a single +corridor.</para> + +<screenshot> +<screeninfo>Capturing balls in a corridor</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="jezball_corridor2.png" format="PNG"/> +</imageobject> +<textobject> +<phrase>Capturing balls in a corridor</phrase> +</textobject> +</mediaobject> +</screenshot> + +<para>A final tip — take your time! There is plenty of time, as +shown in the <guilabel>Time</guilabel> display on the right hand side +of the screen. Rushing will just get you in trouble!</para> + +</chapter> + +<chapter id="menu-reference"> +<title>Menu Reference</title> + +<sect1 id="game-menu"> +<title>The <guimenu>Game</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term> +<menuchoice><shortcut> +<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo> +</shortcut> +<guimenu>Game</guimenu> +<guimenuitem>New</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Start a new game.</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice><shortcut> +<keycombo action="simul">&Ctrl;<keycap>End</keycap> +</keycombo> +</shortcut> +<guimenu>Game</guimenu> +<guimenuitem>End Game</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>End the current game.</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice><shortcut> +<keycap>P</keycap></shortcut> +<guimenu>Game</guimenu> +<guimenuitem>Pause</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Pause or resume the game.</action></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>Opens a dialog that displays different high score tables. +<guibutton>Export</guibutton> the high scores into a file or click on +<guibutton>Configure</guibutton> to open a dialog to customize your Nickname +and add a Comment.</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><action>Quit</action> and close &kbounce;.</para> +</listitem> +</varlistentry> +</variablelist> +</sect1> + +<sect1 id="settings-menu"> +<title>The <guimenu>Settings</guimenu> Menu</title> +<variablelist> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Select Background Folder...</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Opens a dialog to select a folder for the background images.</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Show Backgrounds</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Shows the background images in the selected folder. Only enabled, if a background folder is already selected</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Show/Hide Toolbar</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Shows/hides the &kbounce; toolbar.</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Show/Hide Statusbar</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Shows/hides the &kbounce; statusbar.</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Play Sounds</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>If checked, &kbounce; game sounds are played.</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Shortcuts...</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Opens a standard &kde; shortcut configuration dialog, in which +you can change the keyboard shortcuts used by &kbounce;.</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Toolbars...</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Opens the standard &kde; toolbar configuration dialog to customize the &kbounce; toolbar.</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Highscores...</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Opens a dialog to customize your <guilabel>Nickname</guilabel> and +add a <guilabel>Comment</guilabel>.</action></para> +</listitem> +</varlistentry> + +</variablelist> +</sect1> + + +<sect1 id="help-menu"> +<title>The <guimenu>Help</guimenu> Menu</title> + +&help.menu.documentation; + +</sect1> + +</chapter> + +<chapter id="credits-and-licenses"> +<title>Credits and Licenses</title> + + +<para>&kbounce;</para> + +<para>Copyright 2000, Stefan Schimanski</para> + +<itemizedlist> +<title>Developers</title> +<listitem> +<para>Stefan Schimanski <email>schimmi@kde.org</email></para> +</listitem> +<listitem> +<para>Sandro Sigala <email>ssigala@globalnet.it</email> - +Highscore</para> +</listitem> +</itemizedlist> + +<para>Documentation copyright 2002, &Aaron.J.Seigo; +&Aaron.J.Seigo.mail;</para> + +<para>This handbook is dedicated to Dennis E. Powell.</para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +&underFDL; + +&underGPL; + +</chapter> + +<appendix id="installation"> +<title>Installation</title> + +&install.intro.documentation; + +&install.compile.documentation; + +</appendix> + +&documentation.index; +</book> +<!-- +Local Variables: +mode: sgml +sgml-minimize-attributes: nil +sgml-general-insert-case: lower +End: +--> + diff --git a/doc/kbounce/jezball_corridor1.png b/doc/kbounce/jezball_corridor1.png Binary files differnew file mode 100644 index 00000000..42df31c8 --- /dev/null +++ b/doc/kbounce/jezball_corridor1.png diff --git a/doc/kbounce/jezball_corridor2.png b/doc/kbounce/jezball_corridor2.png Binary files differnew file mode 100644 index 00000000..38c84169 --- /dev/null +++ b/doc/kbounce/jezball_corridor2.png diff --git a/doc/kbounce/jezball_newWall.png b/doc/kbounce/jezball_newWall.png Binary files differnew file mode 100644 index 00000000..4700df3e --- /dev/null +++ b/doc/kbounce/jezball_newWall.png diff --git a/doc/kenolaba/Makefile.am b/doc/kenolaba/Makefile.am new file mode 100644 index 00000000..8c5320d4 --- /dev/null +++ b/doc/kenolaba/Makefile.am @@ -0,0 +1,4 @@ + +KDE_DOCS = AUTO +KDE_LANG = en +KDE_MANS = AUTO diff --git a/doc/kenolaba/index.docbook b/doc/kenolaba/index.docbook new file mode 100644 index 00000000..b8d87be5 --- /dev/null +++ b/doc/kenolaba/index.docbook @@ -0,0 +1,869 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY kappname "&kenolaba;"> + <!ENTITY package "kdegames"> + <!ENTITY % English "INCLUDE"> + <!ENTITY % addindex "IGNORE"> +]> + +<book lang="&language;"> +<bookinfo> +<title>The &kenolaba; Handbook</title> + +<authorgroup> +<author> +&Josef.Weidendorfer; +</author> + +<author> +&Philip.Rodrigues; &Philip.Rodrigues.mail; +</author> + +<othercredit role="reviewer"> +&Lauri.Watts; &Lauri.Watts.mail; +<!-- Uncomment this when xslt bug is fixed +<contrib>Reviewer</contrib> +--> +</othercredit> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> + +</authorgroup> + +<date>2006-01-13</date> +<releaseinfo>1.06b</releaseinfo> + +<copyright> +<year>2001</year> +<holder>&Philip.Rodrigues;</holder> +</copyright> + +<legalnotice>&FDLNotice;</legalnotice> + +<abstract><para>&kenolaba; is a simple board strategy game that is +played by two players.</para> </abstract> + + +<keywordset> +<keyword>KDE</keyword> +<keyword>game</keyword> +<keyword>kenolaba</keyword> +<keyword>linux</keyword> +</keywordset> +</bookinfo> + +<chapter id="introduction"> +<title>Introduction</title> + +<para>&kenolaba; is a simple board strategy game that is played by two +players. There are red and yellow pieces for each player. Beginning from +a position where each player has 14 pieces, moves are drawn until +one player has pushed 6 of his opponent's pieces out of the +board.</para> + +<para>The original program was developed in 1993 for DOS and pure +Xlib. For &kde; there was a major rewrite.</para> + +<note><para> If you know the board game called Abalone, you will like this +program. In fact, this program was inspired by the mentioned game. +Abalone is a trademark of Abalone SA, France.</para></note> + +</chapter> + +<chapter id="rules-of-the-game"> +<title>Rules of the Game</title> + +<para>Red always moves first.</para> + +<para>Two types of moves are allowed:</para> + +<variablelist> +<varlistentry> +<term>Normal</term> +<listitem><para>One, two or three of your pieces in a row can be moved by one +space in the 6 directions. Side moves are also allowed.</para> + +<para>Press the &LMB; on the first piece you want to move. +The piece will then be highlighted. Now drag the mouse in the desired +direction. If the move is valid, the cursor will change to an arrow in +that direction and all the pieces of the move will be highlighted. If +this is the move you want to draw, release the mouse button.</para> + +<para>Side moves are handled another way: For two adjacent pieces click between +them and drag; for three pieces press the &MMB; on the middle piece - if a side +move is allowed for the pieces they will be highlighted. Otherwise only the +middle one is highlighted and you draw a normal move. </para> + +</listitem> +</varlistentry> + +<varlistentry> +<term>Pushing</term> + +<listitem><para>You can push a maximum of two pieces of the opponent in +front of your own pieces as long as the number of pieces you move is +greater than the number of the opponent's pieces that you push. That +means with three of your pieces you can push one or two of the +opponent's and with two pieces one.</para> + +<para>Special pushing moves are those which push a piece of the opponent +out of the board. If you have pushed six of your opponent's pieces out +of the board you have won. </para> + +</listitem> +</varlistentry> +</variablelist> + +<para>If you still do not know what &kenolaba; is all about, look at a +game where the computer plays both sides. After starting &kenolaba;, +select <menuchoice><guimenu>Settings</guimenu><guisubmenu>Computer +Play</guisubmenu><guimenuitem>Both</guimenuitem></menuchoice> and start +a new game. </para> + +</chapter> + +<chapter id="network-play"> +<title>Network Play</title> +<sect1 id="general-network-play"> +<title>General Network Play</title> + +<para> +&kenolaba; supports playing across a network. This allows two people to +play against each other on different computers, or one person to observe +the game play of another &kenolaba; program. To use &kenolaba;'s network +features, &kenolaba; must be set to Network Mode by selecting +<menuchoice><guimenu>Game</guimenu><guimenuitem>Network Play</guimenuitem></menuchoice>.</para> + + +<para> +All running &kenolaba; programs which are in Network Mode broadcast +changed positions to each other.</para> + +<para>To exchange positions, the &kenolaba; programs have to be told +about each other. If they are running on the same machine, nothing is +needed (apart from switching to Network Mode). If running on different +computers you have to specify the other's machine on the command line +with the <option>-h</option> switch, as so:</para> + +<screen width="40"><prompt>%</prompt><userinput><command>kenolaba</command> <option>-h</option> <parameter><replaceable>SomeHostName</replaceable></parameter></userinput></screen> + +<note><para> For insiders: &kenolaba;, when in Network Mode, listens on +a <acronym>TCP</acronym> socket for position change commands by other +&kenolaba; programs. You can specify the port number with the +<option>-p</option> command line switch. You need this if you want to +play two different &kenolaba; Network games.</para></note> + +<sect2 id="network-examples"> +<title>Examples</title> + +<itemizedlist> +<listitem> +<para>Chris on <systemitem class="systemname">machine1</systemitem> and +Mary on <systemitem class="systemname">machine2</systemitem> want to +play against each other: Mary simply starts &kenolaba;, sets +<menuchoice><guimenu>Options</guimenu><guisubmenu>Computer +Play</guisubmenu></menuchoice> to <guimenuitem>None</guimenuitem> and +switches to Network Mode. Chris starts &kenolaba; with + +<screen width="40"><prompt>%</prompt><userinput><command>kenolaba</command> <option>-h</option> <parameter><replaceable>machine2</replaceable></parameter></userinput></screen> + +and then does the same as Mary. +Now one of the two can start the game and draw a red move. Each time the +position is changed in one program, it automatically changes in the other one +too.</para> +</listitem> + +<listitem> +<para>John wants to observe the game: He does the same as Chris, but +doesn't draw a move himself.</para> +</listitem> + +<listitem> +<para>Two different &kenolaba; Network Games will run among machines +<systemitem class="systemname">m1</systemitem> and <systemitem +class="systemname">m2</systemitem>. To distinguish the games, we choose +port number 12345 for one. On <systemitem +class="systemname">m1</systemitem> we start as usual: + +<screen width="40"><prompt>%</prompt><userinput><command>kenolaba</command></userinput></screen> + +for the first game, and (not so usual): + +<screen width="40"><prompt>%</prompt><userinput><command>kenolaba</command> <option>-p</option> <parameter><replaceable>12345</replaceable></parameter></userinput></screen> + +for the second. On <systemitem class="systemname">m2</systemitem> we +start the first game with: + +<screen width="40"><prompt>%</prompt><userinput><command>kenolaba</command> <option>-h</option> <parameter><replaceable>m1</replaceable></parameter></userinput></screen> + +and the second with: + +<screen width="40"><prompt>%</prompt><userinput><command>kenolaba</command> <option>-h</option> <parameter><replaceable>m1:12345</replaceable></parameter></userinput></screen> + +(The colon separates host and port as in a &URL;).</para> </listitem> +</itemizedlist> + +</sect2> + +</sect1> +</chapter> + +<chapter id="advanced-options"> +<title>Advanced Options</title> + +<sect1 id="modify-mode"> +<title>Modify Mode</title> + +<para> +You can edit the current board position by selecting +<menuchoice><guimenu>Edit</guimenu><guimenuitem>Modify</guimenuitem></menuchoice> +to put &kenolaba; in Modify Mode.You can add red or yellow pieces or +delete them. The status line shows the number of red and yellow pieces, +the move number, the side which is to draw the next move, and whether +the position is valid: An exclamation sign means no, a checked symbol +yes. +</para> + +<important> +<para> +If the position is invalid and you switch back to normal Play Mode, you +can not play! Only valid positions can be used as a starting position for +a game. +</para> +</important> + +<para><menuchoice><guimenu>Move</guimenu><guimenuitem>Take Back</guimenuitem> +</menuchoice> and +<menuchoice><guimenu>Move</guimenu><guimenuitem>Forward</guimenuitem> +</menuchoice> simply decrement and increment the move number, but don't change +any pieces.</para> + +<sect2 id="modify-mode-usage"> +<title>Usage</title> + +<para>By pressing the <mousebutton>left</mousebutton> or +<mousebutton>right</mousebutton> mouse button on an empty or yellow +field, you enter <quote>Red piece Adding</quote> mode. By pressing the +<mousebutton>middle</mousebutton> button on an empty or red field, you +enter <quote>Yellow piece Adding</quote> mode. Finally by pressing the +<mousebutton>left</mousebutton> or the <mousebutton>right</mousebutton> +mouse button on a red piece, or the <mousebutton>middle</mousebutton> +mouse button on an yellow piece, you enter <quote>Piece Deleting</quote> +Mode. Any piece that the mouse passes over with the button pressed will +be deleted. +</para> + +<para>To exit Modify Mode and re-enter Play Mode, just uncheck +<guimenuitem>Modify</guimenuitem> in the <guimenu>Edit</guimenu> +menu.</para> + +<sect3 id="clipboard-features"> +<title>Using the Clipboard</title> + +<para>The current &kenolaba; board can be copied to the clipboard using +the <guimenuitem>Copy</guimenuitem> command in the +<guimenu>Edit</guimenu> menu, and then pasted back in using +<guimenuitem>Paste</guimenuitem>. This way you can copy the board +positions of one &kenolaba; program to another by pressing +<guimenuitem>Copy</guimenuitem> in one program and +<guimenuitem>Paste</guimenuitem> in the other, but this is better done +with Network Mode (see above). Another usage is to save positions into a +text file (using <guimenuitem>Copy</guimenuitem> and your Editor of +choice) and retrieve a position later by selecting it in the editor and +pasting in &kenolaba;.</para> +</sect3> +</sect2> +</sect1> + +<sect1 id="computer-level"> +<title>Computer Level</title> +<para>The computer can play at four different levels, namely:</para> +<itemizedlist> +<listitem><para><guimenuitem>Easy</guimenuitem></para> +</listitem> +<listitem><para><guimenuitem>Normal</guimenuitem></para> +</listitem> +<listitem><para><guimenuitem>Hard</guimenuitem></para> +</listitem> +<listitem><para><guimenuitem>Challenge</guimenuitem></para> +</listitem> +</itemizedlist> + +<para>The harder the setting, the longer the computer searches for a +move. You can interrupt the search by pressing the <keycap>S</keycap> +key.</para> + +</sect1> + +<sect1 id="spying"> +<title>Spying</title> + +<para> +<quote>Spying</quote> can be turned on and off from the +<guimenu>Settings</guimenu> menu, and the <guimenuitem>Spy</guimenuitem> +option. If it is your turn, you can see the computer's rating of the +move you want to play in the status bar. If it's the computer's turn you +can see (in status bar and highlighted pieces) the move he actually +thinks is the best to play. Of course this changes along his +search.</para> +</sect1> + +<sect1 id="computer-plays"> +<title>Selecting what color the computer plays</title> + +<para> +You can make the computer play Red, Yellow or both sides. Choose between +these options before starting a new game. Of course it works in a game +too if you want to change sides. Choose <guimenuitem>None</guimenuitem> +to play against another human. This is very useful in Network +Mode.</para> +</sect1> + +</chapter> + +<chapter id="advanced-config"> +<title>Advanced Configuration</title> + +<para>&kenolaba; offers advanced configuration options for the daring, enabling +you to change the whole scoring system if you wish. To access these advanced +options, select <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure +Kenolaba...</guimenuitem></menuchoice>. As you change settings, the score that +your modified settings give for the current move is displayed at the bottom of +the dialog, next to <guilabel>Evaluation of actual position:</guilabel>.</para> + +<sect1 id="the-moves-tab"> +<title>The <guilabel>Moves</guilabel> Tab</title> +<para>The number of points added to the total for each type of move can be +modified here, depending on the type of move, and how many pieces are +involved. The moves are divided into three types:</para> + +<variablelist> + +<varlistentry> +<term><guilabel>Normal</guilabel></term> +<listitem><para>A normal move is one in which you move one or more pieces of +your own, but do not push any of your opponent's pieces.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Push</guilabel></term> +<listitem><para>A push move is one in which you push one or more of your +opponent's pieces, but they remain on the board.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Push Out</guilabel></term> +<listitem><para>A push out move is one in which you push one or more of your +opponent's pieces off the board.</para> +</listitem> +</varlistentry> + +</variablelist> + +</sect1> + +<sect1 id="the-position-tab"> +<title>The <guilabel>Position</guilabel> Tab</title> + +<para>The number of points added to the total score for a board position is +dependent on which ring on the board the pieces are on. For each ring, from the +center out, an average score to add can be set, with a +/- range. The score +given for a particular position is varied randomly within the +/- range. This +is to stop computer-computer games going into an infinite loop. +</para> +</sect1> + +<sect1 id="the-in-a-row-tab"> +<title>The <guilabel>In-A-Row</guilabel> Tab</title> + +<para>For each time the number of pieces in a row occurs, the given number of points +is added to the score, ⪚ + <inlinemediaobject> + <imageobject> + <imagedata fileref="kenolaba-pieces.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>X O O O</phrase> + </textobject> + </inlinemediaobject> +adds the score for three in a row, and also two times the score for two in a row.</para> +</sect1> + +<sect1 id="the-count-tab"> +<title>The <guilabel>Count</guilabel> Tab</title> +<para> +Adds the given amount of points based on the difference in the number of balls +on both sides, from <guilabel>1 Ball more:</guilabel> up to <guilabel>5 Balls +more:</guilabel>. If there is a difference of 6 balls, the game is over. +</para> +</sect1> + +<sect1 id="the-evaluation-tab"> +<title>The <guilabel>Evaluation Schemes</guilabel> Tab</title> +<para> +Your evaluation schemes, defined in all other tabs of this dialog, +can be stored or deleted here. +</para> +</sect1> +</chapter> + +<chapter id="menu-reference"> +<title>Menu Reference</title> + +<para>Drawing moves is explained under <link +linkend="rules-of-the-game">Rules of the Game</link>. The buttons in the +toolbar have the same meaning as entries in the <guimenu>Game</guimenu> +or <guimenu>Edit</guimenu> menu.</para> + +<sect1 id="the-game-menu"> +<title>The <guimenu>Game</guimenu> Menu</title> +<variablelist> +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>N</keycap> +</keycombo> +</shortcut> +<guimenu>Game</guimenu> +<guimenuitem>New</guimenuitem> +</menuchoice></term> +<listitem><para><action>Starts a new game</action> even if a game is +currently in play.</para></listitem> +</varlistentry> + + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo><keycap>N</keycap></keycombo> +</shortcut> +<guimenu>Game</guimenu><guimenuitem>Network Play</guimenuitem> +</menuchoice></term> +<listitem> +<para> +If this toggle is switched on, the application is in Network Mode. +</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><action>Quits</action> &kenolaba;.</para> +</listitem> +</varlistentry> +</variablelist> + +</sect1> + +<sect1 id="the-edit-menu"> +<title>The <guimenu>Edit</guimenu> Menu</title> + +<variablelist> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>C</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu><guimenuitem>Copy</guimenuitem> +</menuchoice></term> +<listitem> +<para>Copy a representation of the &kenolaba; board to the clipboard</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>V</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu><guimenuitem>Paste</guimenuitem> +</menuchoice></term> +<listitem><para> +Interpret the content of the X clipboard as an ASCII representation of +a &kenolaba; board, and copy it to the current board. A valid +ASCII representation is generated by <guimenuitem>Copy</guimenuitem>.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>Insert</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu><guimenuitem>Modify</guimenuitem> +</menuchoice></term> +<listitem> +<para>Switches &kenolaba; to Modify Mode.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu><guimenuitem>Save Position</guimenuitem> +</menuchoice></term> +<listitem><para> +Save the actual position to be retrieved later with +<menuchoice><guimenu>Edit</guimenu> <guimenuitem>Restore Position</guimenuitem> +</menuchoice>. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu><guimenuitem>Restore Position</guimenuitem> +</menuchoice></term> +<listitem><para> +Restore the board position stored in the &kenolaba; Configuration file +by <menuchoice><guimenu>Edit</guimenu> <guimenuitem>Save +Position</guimenuitem></menuchoice>.</para> +</listitem> +</varlistentry> +</variablelist> + +</sect1> + +<sect1 id="the-move-menu"> +<title>The <guimenu>Move</guimenu> Menu</title> + +<variablelist> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo><keycap>H</keycap></keycombo> +</shortcut> +<guimenu>Move</guimenu><guimenuitem>Hint</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +A hint for your next move is shown. Only possible if you play at level +normal or above, the move number is 2 or greater and you have not undone +your move.</para> +</listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo><keycap>S</keycap></keycombo> +</shortcut> +<guimenu>Move</guimenu> +<guimenuitem>Stop Search</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +When the computer is thinking, his depth search is interrupted and he +draws the best move he has found so far.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo><keycap>PagegUp</keycap></keycombo> +</shortcut> +<guimenu>Move</guimenu><guimenuitem>Take Back</guimenuitem> +</menuchoice> +</term> +<listitem> +<para> +Take back your previous move. Two (!) moves are undone: the opponents +move and your last move. So it's your turn again. 100 moves are +remembered; so don't hesitate to take back moves until you are at the +beginning of the game. When in Modify mode (see +<menuchoice><guimenu>Edit</guimenu><guimenuitem>Modify</guimenuitem></menuchoice> +), decrement move number of this position.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<shortcut> +<keycombo><keycap>PageDown</keycap></keycombo> +</shortcut> +<guimenu>Move</guimenu><guimenuitem>Forward</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Only useful in Modify mode: Increment move number of this +position.</para> +</listitem> +</varlistentry> + +</variablelist> + +</sect1> + +<sect1 id="the-settings-menu"> +<title>The <guimenu>Settings</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl; <keycap>M</keycap> +</keycombo> +</shortcut> +<guimenu>Settings</guimenu> +<guimenuitem>Show Menubar</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Shows or hides the &kenolaba; menubar.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu><guimenuitem>Show Toolbar</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Shows or hides the &kenolaba; toolbar.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu><guimenuitem>Show Statusbar</guimenuitem> +</menuchoice></term> +<listitem> +<para>Shows or hides the &kenolaba; status bar at the bottom of the screen.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu><guimenuitem>Save Settings</guimenuitem> +</menuchoice></term> +<listitem> +<para> +Saves the current settings to become the default for &kenolaba;.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu><guisubmenu>Choose Game Type</guisubmenu> +</menuchoice></term> +<listitem><para> +Select the level that the computer plays at. Can be one of: +<itemizedlist> +<listitem><para><guimenuitem>Easy</guimenuitem></para> +</listitem> +<listitem><para><guimenuitem>Normal</guimenuitem></para> +</listitem> +<listitem><para><guimenuitem>Hard</guimenuitem></para> +</listitem> +<listitem><para><guimenuitem>Challenge</guimenuitem></para> +</listitem> +</itemizedlist> +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu><guisubmenu>Computer +Play</guisubmenu> +</menuchoice></term> +<listitem><para> +Choose which colors the computer plays. Can be one of: +<itemizedlist> +<listitem> +<para><guimenuitem>Red</guimenuitem></para> +</listitem> +<listitem> +<para><guimenuitem>Yellow</guimenuitem></para> +</listitem> +<listitem> +<para><guimenuitem>Both</guimenuitem></para> +</listitem> +<listitem> +<para><guimenuitem>None</guimenuitem></para> +</listitem> +</itemizedlist> +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu><guimenuitem>Move Slow</guimenuitem> +</menuchoice></term> +<listitem><para> A move drawn by the computer when this option is +checked is shown by blinking and highlighting the pieces used in this +move. Uncheck this option if you don't want to wait for this animation: +Then only a quick highlighting is done.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu><guimenuitem>Render Balls</guimenuitem> +</menuchoice></term> +<listitem> +<para> +If checked, the pieces are rendered online by an internal simple ray +tracer when needed (⪚ when resizing the window).</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu><guimenuitem>Spy</guimenuitem> +</menuchoice></term> +<listitem><para> +If checked, turns on <quote>spying</quote>.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu><guimenuitem>Configure Shortcuts...</guimenuitem> +</menuchoice></term> +<listitem><para> +Brings up the standard &kde; shortcuts configuration dialog to customize the shortcuts used by &kenolaba;.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu><guimenuitem>Configure Toolbars...</guimenuitem> +</menuchoice></term> +<listitem> +<para>Brings up the standard &kde; toolbar configuration dialog to customize the &kenolaba; toolbar.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu><guimenuitem>Configure &kenolaba;...</guimenuitem> +</menuchoice></term> +<listitem> +<para>Opens the &kenolaba; configuration dialog to change &kenolaba; +settings. See <xref linkend="advanced-config"/>.</para> +</listitem> +</varlistentry> + + +</variablelist> + +</sect1> + +<sect1 id="help-menu"> +<title>The <guimenuitem>Help</guimenuitem> Menu</title> + +&help.menu.documentation; + +</sect1> +</chapter> + + +<chapter id="commandline-options"> +<title>Command line options</title> + +<cmdsynopsis> +<command>kenolaba</command> +<group> +<option>-p</option> +<replaceable>MyPortNumber</replaceable> +</group> +<group> +<option>-h</option> +<replaceable>host:port</replaceable> +</group> +</cmdsynopsis> + +<para>With <option>-p</option> you specify the port number of the +listening TCP socket when in Network Mode.</para> + +<para>With <option>-h</option> you specify a remote &kenolaba; process +(with optional port number, when not using the default port on the +remote machine) to communicate with when in Network mode. You can +specify multiple remote processes.</para> +</chapter> + +<chapter id="credits-and-licenses"> +<title>Credits & Licenses</title> + +<para>&kenolaba;</para> + +<para>Program copyright 1997-2000 &Josef.Weidendorfer; +&Josef.Weidendorfer.mail; +</para> + +<para>Original Documentation by Robert Williams +<email>rwilliams@kde.org</email> and &Josef.Weidendorfer;</para> + +<para>Documentation maintained by &Philip.Rodrigues; &Philip.Rodrigues.mail;.</para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +&underFDL; +&underGPL; + +</chapter> + +<appendix id="installation"> +<title>Installation</title> +<sect1 id="getting-kenolaba"> +<title>How to obtain &kenolaba;</title> + +&install.intro.documentation; + +</sect1> + +<sect1 id="compilation"> +<title>Compilation and Installation</title> + +&install.compile.documentation; + +</sect1> + +</appendix> + +</book> +<!-- +Local Variables: +mode: sgml +sgml-minimize-attributes:nil +sgml-general-insert-case:lower +sgml-indent-step:0 +sgml-indent-data:nil +End: + +// vim:ts=0:sw=2:tw=78:noet +--> + + + + + + diff --git a/doc/kenolaba/kenolaba-pieces.png b/doc/kenolaba/kenolaba-pieces.png Binary files differnew file mode 100644 index 00000000..58869a47 --- /dev/null +++ b/doc/kenolaba/kenolaba-pieces.png diff --git a/doc/kenolaba/man-kenolaba.6.docbook b/doc/kenolaba/man-kenolaba.6.docbook new file mode 100644 index 00000000..a89a79fd --- /dev/null +++ b/doc/kenolaba/man-kenolaba.6.docbook @@ -0,0 +1,80 @@ +<?xml version="1.0" ?> +<!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ +<!ENTITY % English "INCLUDE"> +]> + +<refentry lang="&language;"> +<refentryinfo> +<author><personname><firstname>Jan</firstname><surname>Schaumann</surname></personname> +<email>jschauma@netmeister.org</email></author> +<date>April 8, 2003</date> +</refentryinfo> + +<refmeta> +<refentrytitle><command>kenolaba</command></refentrytitle> +<manvolnum>6</manvolnum> +</refmeta> + +<refnamediv> +<refname><command>kenolaba</command></refname> +<refpurpose>A &kde; based game</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<cmdsynopsis> +<command>kenolaba</command> + +<group><option>-h, --host</option> <arg>hostname</arg></group> +<group><option>-p, --port</option> <arg>port</arg></group> +<group><option>KDE Generic Options</option></group> +<group><option>Qt Generic Options</option></group> + +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1> +<title>Description</title> + +<para>&kenolaba; is a simple board strategy game that is played by two +players. There are red and yellow pieces for each player. Beginning +from a start position where each player has 14 pieces, moves are drawn +until one player has pushed 6 of his opponent's pieces out of the +board. </para> + +</refsect1> + +<refsect1> +<title>Options</title> + +<variablelist> +<varlistentry><term><option>-h, --host</option> <replaceable>hostname</replaceable></term> +<listitem><para>Use <replaceable>hostname</replaceable> for network game.</para></listitem> +</varlistentry> +<varlistentry> +<term><option>-p, --port</option> <replaceable>port</replaceable></term> +<listitem><para>Use <replaceable>port</replaceable> for network game.</para></listitem> +</varlistentry> +</variablelist> + +</refsect1> + +<refsect1> +<title>See Also</title> + +<para>More detailed user documentation is available from <ulink +url="help:/kenolaba">help:/kenolaba</ulink> (either enter this +<acronym>URL</acronym> into &konqueror;, or run +<userinput><command>khelpcenter</command> +<parameter>help:/kenolaba</parameter></userinput>).</para> + + +</refsect1> + +<refsect1> +<title>Bugs</title> + +<para>&kenolaba; was written by <personname><firstname>Joseph</firstname><surname>Weidendorfer</surname></personname><email>kde@jowenn.at</email></para> +<para>This man page is based on the one prepared by <personname><firstname>Jan</firstname><surname>Schaumann</surname></personname> <email>jschauma@netmeister.org</email> for the <quote>Missing Man Pages Project</quote> at <ulink url="http://www.netmeister.org/misc/m2p2/index.html">http://www.netmeister.org/misc/m2p2/index.html</ulink>.</para> +</refsect1> + +</refentry> diff --git a/doc/kfouleggs/Makefile.am b/doc/kfouleggs/Makefile.am new file mode 100644 index 00000000..085981d9 --- /dev/null +++ b/doc/kfouleggs/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/kfouleggs/gamescreen.png b/doc/kfouleggs/gamescreen.png Binary files differnew file mode 100644 index 00000000..4f510ddb --- /dev/null +++ b/doc/kfouleggs/gamescreen.png diff --git a/doc/kfouleggs/index.docbook b/doc/kfouleggs/index.docbook new file mode 100644 index 00000000..1d68cce8 --- /dev/null +++ b/doc/kfouleggs/index.docbook @@ -0,0 +1,802 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY kappname "&kfouleggs;"> + <!ENTITY package "kdegames"> + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE" > <!-- change language only here --> +]> + +<book lang="&language;"> + +<bookinfo> +<title>The &kfouleggs; Handbook</title> + +<authorgroup> +<author> +&Philip.Rodrigues; &Philip.Rodrigues.mail; +</author> + +<othercredit role="developer"> +&Nicolas.Hadacek; &Nicolas.Hadacek.mail; +<!-- Uncomment this when xslt is fixed +<contrib>Developer</contrib> +--> +</othercredit> + +<othercredit role="reviewer"> +&Lauri.Watts; &Lauri.Watts.mail; +<!-- Uncomment this when xslt is fixed +<contrib>Reviewer</contrib> +--> +</othercredit> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> + +</authorgroup> + +<copyright> +<year>2000-2003</year> +<holder>&Philip.Rodrigues;</holder> +</copyright> + +<legalnotice>&FDLNotice;</legalnotice> + +<date>2006-06-19</date> +<releaseinfo>2.1.11</releaseinfo> + +<abstract><para>&kfouleggs; is a clone of the Japanese PuyoPuyo game for +the K Desktop Environment.</para></abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>kdegames</keyword> +<keyword>KFoulEggs</keyword> +<keyword>PuyoPuyo</keyword> +</keywordset> + +</bookinfo> + +<chapter id="introduction"> +<title>Introduction</title> + +<para>&kfouleggs; is a clone of the Japanese PuyoPuyo game, with advanced +features such as multiplayer games against human or <acronym>AI</acronym>. +If you have played <application>Tetris</application>, or one of +its many clones, you will find &kfouleggs; easy to learn.</para> + +</chapter> + + +<chapter id="gameplay"> +<title>Game Play</title> + +<sect1 id="starting-a-new-game"> +<title>Starting a New Game</title> + +<para>When you start &kfouleggs;, just click on the <guibutton>Start +</guibutton> button, or select <guimenuitem>New</guimenuitem> from the +<guimenu>Game</guimenu> menu at any time to start a new game.</para> + +</sect1> + +<sect1 id="aim-of-the-game"> +<title>Aim of the Game</title> + +<para>The aim of the game is to achieve the highest score possible by +moving the falling tiles in such a way that tiles of the same color are +adjacent, and disappear. The more tiles you remove, the higher your +score.</para> + +</sect1> + +<sect1 id="playing-the-game"> +<title>Playing the Game</title> + +<para>Use the <keycap>Left</keycap> and <keycap>Right</keycap> arrow +keys to move the falling tile in the relevant direction, and the +<keycap>Up</keycap> arrow and <keycap>Return</keycap> keys to rotate the +tile left and right respectively. The <keycap>Shift</keycap> key drops +the tile down one line, and the <keycap>Down</keycap> key drops the tile +all the way down - use it as a way of saving time. </para> + +<para>All of these shortcuts can be customized by selecting +<guimenuitem>Configure Shortcuts...</guimenuitem> from the +<guimenu>Settings</guimenu> menu.</para> + +<para>If two or more tiles of the same color come to rest horizontally +or vertically next to each other, they become <quote>glued</quote>. If +four or more pieces of the same color come to be <quote>glued</quote>, +they disappear, and any pieces above them fall down according to the law +of gravity ;-). If this causes four or more pieces to become +<quote>glued</quote>, then they will also disappear, and so on.</para> + +<para>Every time you remove 100 tiles, you advance to the next level, +where the tiles fall faster, and the game is more difficult.</para> + +<para>The game ends when the central column fills with tiles, and no +more can fall.</para> + +</sect1> + +<sect1 id="game-screen"> +<title>The Game Screen</title> + +<para> +<screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="gamescreen.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>&kfouleggs; in Action</phrase> + </textobject> + </mediaobject> +</screenshot> + +A quick explanation of what each of the parts of the game screen are for... +</para> + +<para> +Along the left hand side, from top to bottom: + +<variablelist> + +<varlistentry> +<term><guilabel>Score</guilabel></term> +<listitem><para>Shows your current score.</para> +</listitem> +</varlistentry> + +<!-- If you can think of a better way to describe this below, please change it :-) --> +<varlistentry> +<term><guilabel>Puyos</guilabel></term> +<listitem><para>Shows the number of removed sets of pieces.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Level</guilabel></term> +<listitem><para>Shows the number of the level you are currently on. The first, +easiest level is level one, progressing to the last, hardest level, 20.</para> +</listitem> +</varlistentry> + +</variablelist> +</para> + +<para> +In the center is the area where the action takes place. The tiles fall through +the rectangle (whose properties can be changed in +<menuchoice><guimenu>>Settings</guimenu><guimenuitem>Configure KFoulEggs...</guimenuitem> +</menuchoice>, see <xref linkend="game-config"/>) until reaching the +bottom. The two small black rectangles under the main one are the tile's +<quote>shadow</quote> which show where it will land. You can toggle the tile's +shadow in <xref linkend="game-config"/>. +</para> + +<para> +On the right hand side, the <guilabel>Next Tile</guilabel> box shows what the +next tile to fall will be, if you have enabled it in <xref +linkend="game-config"/>. +</para> + +</sect1> + + +</chapter> + +<chapter id="preferences"> +<title>&kfouleggs; Configuration and Default Shortcuts</title> + +<sect1 id="game-configuration"> +<title>Configuring Gameplay</title> +<para> +The &kfouleggs; configuration is accessed from +<menuchoice><guimenu>Settings</guimenu> +<guimenuitem>Configure &kfouleggs;...</guimenuitem></menuchoice>. The +options are as follows: +</para> + +<sect2 id="game-config"> +<title>Game Configuration</title> + +<variablelist> + +<varlistentry> +<term><guilabel>Initial level:</guilabel></term> +<listitem><para>Set the level which you will play at startup, from 1 (easiest) +to 20 (hardest). Default is level one.</para> +</listitem> +</varlistentry> + +<varlistentry><term><guilabel>Direct drop down</guilabel></term> +<listitem><para>If checked, pressing the <keysym>Down Arrow</keysym> will cause +a tile to immediately fall to the bottom of the screen. If unchecked, pressing +the <keysym>Down Arrow</keysym> only causes the piece to fall until the key is released.</para> +</listitem> +</varlistentry> + +</variablelist> + +</sect2> + +<sect2 id="appearance-config"> +<title>Appearance Configuration</title> + +<variablelist> + +<varlistentry> +<term><guilabel>Enable animations</guilabel></term> +<listitem><para>If checked, pieces are shown with an +animation (a small rebound effect), when they touch the bottom.</para></listitem> +</varlistentry> + +<varlistentry><term><guilabel>Show piece's shadow</guilabel></term> +<listitem><para>If checked, a shadow is placed beneath the game board +showing where the piece will fall.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Show next piece</guilabel></term> +<listitem><para>If checked, shows the next tile that will fall onto the +game board.</para></listitem> +</varlistentry> + +<varlistentry><term><guilabel>Show detailed "removed lines" +field</guilabel></term> +<listitem><para>If checked, the <guilabel>Puyos</guilabel> counter on the left +of the screen shows how many times each number of Puyos have been removed. If +unchecked, just the total number removed is shown.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Background</guilabel></term> +<listitem><para>Select the color and the opacity for &kfouleggs; background. +An opacity of zero makes the &kfouleggs; background +completely transparent, and a setting of one makes the &kfouleggs; background +completely opaque.</para> +</listitem> +</varlistentry> + +</variablelist> +</sect2> + +<sect2 id="colors-config"> +<title>Colors Configuration</title> +<para>Here you can select the colors used for the tiles in &kfouleggs;.</para> +</sect2> + +<sect2 id="ai-config"> +<title>A.I. Configuration</title> +<para>Here you can configure the A.I. in &kfouleggs;.</para> +</sect2> +</sect1> + +<sect1 id="highscore-configuration"> +<title>Configuring Highscores</title> +<para> +The configuration is accessed from +<menuchoice><guimenu>Settings</guimenu> +<guimenuitem>Configure Highscores...</guimenuitem></menuchoice>. The +options are as follows: +</para> + +<sect2 id="highscore-main-config"> +<title>The <guilabel>Main</guilabel> Tab</title> + +<variablelist> + +<varlistentry> +<term><guilabel>Nickname:</guilabel></term> +<listitem><para>Displays your current nickname and allows you to change it.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Comment</guilabel></term> +<listitem><para>A comment about yourself. You choose...</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>World-wide highscores enabled</guilabel></term> +<listitem><para>If checked and if you are connected to the Internet, +&kfouleggs; will send your score automatically at the end of the game +to the highscore web server (kfouleggs.sf.net).</para></listitem> +</varlistentry> + +</variablelist> +</sect2> + +<sect2 id="highscore-advanced-config"> +<title>The <guilabel>Advanced</guilabel> Tab</title> + +<para>This tab displays your <guilabel>Registration Data</guilabel> +on kfouleggs.sf.net:</para> + +<variablelist> +<varlistentry> +<term><guilabel>Nickname:</guilabel></term> +<listitem><para>Displays your current nickname from the <guilabel>Main</guilabel> tab.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Key:</guilabel></term> +<listitem><para>This key was generated when you registered on kfouleggs.sf.net by +selecting <guilabel>World-wide highscores enabled</guilabel> the first time. +The registration key is used in conjunction with the +nickname to identify uniquely users, but users cannot have the same nickname. +Click on the <guibutton>Remove</guibutton> button to delete you from the world highscores +list.</para> +</listitem> +</varlistentry> +</variablelist> +</sect2> + +</sect1> + +<sect1 id="default-keybindings"> +<title>Default Shortcuts</title> + +<para>The default shortcuts for &kfouleggs; in all player modes are as +follows:</para> + +<informaltable> +<tgroup cols="2"> +<tbody> +<row> +<entry>New</entry> +<entry><keycombo action="simul">&Ctrl;<keysym>N</keysym></keycombo></entry> +</row> +<row> +<entry>Pause</entry> +<entry><keysym>P</keysym></entry> +</row> +<row> +<entry>Quit</entry> +<entry><keycombo action="simul">&Ctrl;<keysym>Q</keysym></keycombo></entry> +</row> +<row> +<entry>Zoom In</entry> +<entry><keycombo action="simul">&Ctrl;<keysym>+</keysym></keycombo></entry> +</row> +<row> +<entry>Zoom Out</entry> +<entry><keycombo action="simul">&Ctrl;<keysym>-</keysym></keycombo></entry> +</row> +<row> +<entry>Show Highscores</entry> +<entry><keycombo action="simul">&Ctrl;<keysym>H</keysym></keycombo></entry> +</row> +<row> +<entry>Show Menubar</entry> +<entry><keycombo action="simul">&Ctrl;<keysym>M</keysym></keycombo></entry> +</row> +<row> +<entry>&kfouleggs; Handbook</entry> +<entry><keysym>F1</keysym></entry> +</row> +<row> +<entry>What's This?</entry> +<entry><keycombo action="simul">&Shift;<keysym>F1</keysym></keycombo></entry> +</row> +</tbody> +</tgroup> +</informaltable> + +<para>The default shortcuts for &kfouleggs; in one-player mode are as +follows:</para> + +<informaltable> +<tgroup cols="2"> +<tbody> +<row> +<entry>Rotate Left</entry> +<entry><keysym>Up Arrow</keysym></entry> +</row> +<row> +<entry>Rotate Right</entry> +<entry><keysym>Return</keysym></entry> +</row> +<row> +<entry>Move Left</entry> +<entry><keysym>Left Arrow</keysym></entry> +</row> +<row> +<entry>Move Right</entry> +<entry><keysym>Right Arrow</keysym></entry> +</row> +<row> +<entry>Move to Left Column</entry> +<entry><keycombo action="simul">&Ctrl;<keysym>Left Arrow</keysym></keycombo></entry> +</row> +<row> +<entry>Move to Right Column</entry> +<entry><keycombo action="simul">&Ctrl;<keysym>Right Arrow</keysym></keycombo></entry> +</row> +<row> +<entry>Drop Down</entry> +<entry><keysym>Down Arrow</keysym></entry> +</row> +</tbody> +</tgroup> +</informaltable> + +</sect1> +</chapter> + +<chapter id="multiplayer-play"> +<title>Multiplayer Play</title> + +<sect1 id="general-multiplayer"> +<title>General Information</title> + +<para>&kfouleggs; supports two local multiplayer types - Human vs. Human +and Human vs. Computer. To play either of these, select it from the +<guimenu>Multiplayer</guimenu> menu.</para> + +<sect2 id="local-multiplayer"> +<title>Multiplayer Games</title> + +<para>In Human vs. Human or Human vs. Computer mode, two gameboards are +shown, one for the first player and one for the second. Each has its own +<guilabel>Score</guilabel>, <guilabel>Puyos</guilabel> and +<guilabel>Level</guilabel> indicator. The keys for the first human +player become, by default:</para> + +<informaltable> +<tgroup cols="2"> +<tbody> +<row> +<entry>Rotate Left</entry> +<entry><keycap>E</keycap></entry> +</row> +<row> +<entry>Rotate Right</entry> +<entry>C</entry> +</row> +<row> +<entry>Move Left</entry> +<entry><keycap>F</keycap></entry> +</row> +<row> +<entry>Move Right</entry> +<entry><keycap>G</keycap></entry> +</row> +<row> +<entry>Move to Left Column</entry> +<entry><keycombo action="simul">&Shift;<keycap>F</keycap></keycombo></entry> +</row> +<row> +<entry>Move to Right Column</entry> +<entry><keycombo action="simul">&Shift;<keycap>G</keycap></keycombo></entry> +</row> +<row> +<entry>Drop Down</entry> +<entry><keycap>D</keycap></entry> +</row> +<row> +<entry>Drop One Line</entry> +<entry><keysym>Space</keysym></entry> +</row> +</tbody> +</tgroup> +</informaltable> + +<para>The keys for the second human player are the same as for the +player in single player mode. </para> + +<para>To return to single player mode, select +<guimenu>Multiplayer</guimenu> and <guimenuitem>Single +Human</guimenuitem>.</para> + +</sect2> +<!-- network gaming was disabled +<sect2 id="network-games"> +<title>Network Multiplayer Games</title> + +<para>Multiplayer network games are set up by selecting +<menuchoice><guimenu>Multiplayer</guimenu> +<guimenuitem>More...</guimenuitem></menuchoice></para> + +<para>Multiplayer games of &kfouleggs; use the model of a hosted game +which other players join.</para> + +</sect2> + +<sect2 id="hosting-a-game"> +<title>Hosting a game</title> + +<para>To host a game, select <guilabel>Create a network game</guilabel> +in the Multiplayer option dialog, set the port you want to use, and +click on the <guibutton>Next</guibutton> button.You then have the option +of changing local players' settings, if there are more than one local +players. Clicking the <guibutton>Finish</guibutton> button advances the +dialog to the waiting for clients stage. When enough clients have +joined, <guibutton>Start Game</guibutton> starts the multiplayer +game.</para> + +</sect2> + +<sect2 id="joining-a-game"> +<title>Joining a game</title> + +<para>To join a game, select <guimenuitem>Join a network +game</guimenuitem> in the Multiplayers option dialog. Select the host +(<guilabel>Server address</guilabel>) and <guilabel>Port</guilabel> you +want to connect to.</para> + +<tip><para>Make sure that the port you set when joining a game is the +same as the port that was set by the host of the game!</para></tip> + +<para>Clicking <guibutton>Next</guibutton> takes you to the +<guilabel>Local players settings</guilabel> dialog (see above), and then +<guibutton>Finish</guibutton> connects to the remote game. The game +starts when the host chooses - the client has no choice.</para> + +</sect2> +--> +</sect1> + +</chapter> + +<chapter id="commands"> +<title>Command Reference</title> + +<sect1 id="kfouleggs-mainwindow"> +<title>The Main &kfouleggs; window</title> + +<sect2> +<title>The <guimenu>Game</guimenu> Menu</title> + +<variablelist> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo> +</shortcut> +<guimenu>Game</guimenu> +<guimenuitem>New</guimenuitem> +</menuchoice></term> +<listitem><para><action>Starts a new game.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo><keycap>P</keycap></keycombo> +</shortcut> +<guimenu>Game</guimenu> +<guimenuitem>Pause</guimenuitem> +</menuchoice></term> +<listitem><para><action>Pauses or resumes the game</action></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><action>Opens a dialog</action> that displays different high score tables. +Clicking on the links below the tables downloads world-wide scores.</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><action>Quits</action> &kfouleggs;</para></listitem> +</varlistentry> + +</variablelist> + +</sect2> + +<sect2> +<title>The <guimenu>View</guimenu> Menu</title> + +<variablelist> + +<varlistentry> +<term><menuchoice><shortcut><keycombo action="simul"> +&Ctrl;<keycap>+</keycap></keycombo></shortcut> +<guimenu>View</guimenu> +<guimenuitem>Zoom In</guimenuitem> +</menuchoice></term> +<listitem><para><action>Enlarges the game board +</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><shortcut><keycombo action="simul"> +&Ctrl;<keycap>-</keycap></keycombo></shortcut> +<guimenu>View</guimenu> +<guimenuitem>Zoom Out</guimenuitem> +</menuchoice></term> +<listitem><para><action>Reduces the game board size +</action></para></listitem> +</varlistentry> + +</variablelist> + +</sect2> + +<sect2> +<title>The <guimenu>Multiplayer</guimenu> Menu</title> + +<variablelist> + +<varlistentry> +<term><menuchoice> +<guimenu>Multiplayer</guimenu> +<guimenuitem>Single Human</guimenuitem> +</menuchoice></term> +<listitem><para><action>Sets the multiplayer mode to single +player</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Multiplayer</guimenu> +<guimenuitem>Human vs Human</guimenuitem> +</menuchoice></term> +<listitem><para><action>Sets the multiplayer mode to two player with two human +players.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Multiplayer</guimenu> +<guimenuitem>Human vs Computer</guimenuitem> +</menuchoice></term> +<listitem><para><action>Sets the multiplayer mode to two player with one human +and one computer player.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Multiplayer</guimenu> +<guimenuitem>More...</guimenuitem> +</menuchoice></term> +<listitem><para><action>Displays the multiplayer +settings dialog.</action></para></listitem> +</varlistentry> + +</variablelist> + +</sect2> + +<sect2> +<title>The <guimenu>Settings</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>M</keycap></keycombo> +</shortcut> +<guimenu>Settings</guimenu> +<guimenuitem>Show Menubar</guimenuitem> +</menuchoice></term> +<listitem><para><action>Shows or hides the Menubar.</action>To return the +menubar, right-click anywhere on the gameboard and select <guimenuitem>Show +Menubar</guimenuitem>. </para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Shortcuts...</guimenuitem> +</menuchoice></term> +<listitem><para><action>Displays a standard &kde; key bindings +configuration dialog to change the keyboard shortcuts for &kfouleggs;.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Notifications...</guimenuitem> +</menuchoice></term> +<listitem><para><action>Displays a standard &kde; notifications +configuration dialog to change the audio and visual notifications for &kfouleggs;.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Highscores...</guimenuitem> +</menuchoice></term> +<listitem><para><action>Displays</action> the <link linkend="highscore-configuration">high score configuration dialog</link>, +in which you can change several settings that affect how &kfouleggs; treats highscores.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure &kfouleggs;...</guimenuitem> +</menuchoice></term> +<listitem><para><action>Displays</action> the <link linkend="game-config">&kfouleggs; +configuration dialog</link>.</para></listitem> +</varlistentry> + +</variablelist> + +</sect2> + +<sect2 id="help"> +<title>The <guimenuitem>Help</guimenuitem> Menu</title> + +&help.menu.documentation; + +</sect2> + +</sect1> + +</chapter> + +<chapter id="credits"> + +<title>Credits and License</title> + +<para>&kfouleggs;</para> + +<para>Program core engine copyright 1995 Eirik End.</para> +<para>Program copyright 1996-2001 &Nicolas.Hadacek; &Nicolas.Hadacek.mail;.</para> + +<para>Documentation copyright 2000-2003 &Philip.Rodrigues; &Philip.Rodrigues.mail;.</para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +&underFDL; + +&underGPL; + +</chapter> + +<appendix id="installation"> +<title>Installation</title> + +<sect1 id="getting-kfouleggs"> +<title>How to obtain &kfouleggs;</title> + +&install.intro.documentation; + +<sect2 id="compilation"> +<title>Compilation and Installation</title> + +&install.compile.documentation; + +<para>Should you run into problems please report them to the &kde; +mailing list, or the program maintainer, &Nicolas.Hadacek;, at +&Nicolas.Hadacek.mail;.</para> + +</sect2> + +</sect1> + +</appendix> + +&documentation.index; + +</book> + +<!-- +Local Variables: +mode: sgml +sgml-omittag: nil +sgml-shorttag: t +sgml-indent-step:0 +sgml-indent-data:f +End: +--> + diff --git a/doc/kgoldrunner/Makefile.am b/doc/kgoldrunner/Makefile.am new file mode 100644 index 00000000..41691557 --- /dev/null +++ b/doc/kgoldrunner/Makefile.am @@ -0,0 +1,3 @@ +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/kgoldrunner/editbar.png b/doc/kgoldrunner/editbar.png Binary files differnew file mode 100644 index 00000000..72c16150 --- /dev/null +++ b/doc/kgoldrunner/editbar.png diff --git a/doc/kgoldrunner/enemy.png b/doc/kgoldrunner/enemy.png Binary files differnew file mode 100644 index 00000000..3a13cfab --- /dev/null +++ b/doc/kgoldrunner/enemy.png diff --git a/doc/kgoldrunner/hero.png b/doc/kgoldrunner/hero.png Binary files differnew file mode 100644 index 00000000..002fb700 --- /dev/null +++ b/doc/kgoldrunner/hero.png diff --git a/doc/kgoldrunner/index.docbook b/doc/kgoldrunner/index.docbook new file mode 100644 index 00000000..b420d16d --- /dev/null +++ b/doc/kgoldrunner/index.docbook @@ -0,0 +1,1674 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.1.2-Based Variant V1.0//EN" "dtd/kdex.dtd" [ + <!ENTITY kgoldrunner "<application>KGoldrunner</application>"> + <!ENTITY kappname "&kgoldrunner;"> + <!ENTITY package "kdegames"> + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE" > <!-- change language only here --> +]> + +<book lang="&language;"> + +<bookinfo> +<title>The &kgoldrunner; Handbook</title> +<authorgroup> +<author> +<firstname>Ian</firstname> +<surname>Wadham</surname> +<affiliation><address><email>ianw@netspace.net.au</email></address></affiliation> +</author> +<author> +<firstname>Marco</firstname> +<surname>Krüger</surname> + +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<copyright> +<year>2003</year> +<holder>Ian Wadham</holder><holder>Marco Krüger</holder> +</copyright> + +<legalnotice>&FDLNotice;</legalnotice> + +<date>2005-12-10</date> +<releaseinfo>2.0</releaseinfo> + +<abstract> +<para> +<inlinemediaobject><imageobject> +<imagedata fileref="kgoldrunner.png" format="PNG"/> +</imageobject></inlinemediaobject> +&kgoldrunner;, a game of action and puzzle solving. Run through +the maze, dodge your enemies, collect all the gold and climb up to the +next level.</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KGoldrunner</keyword> +</keywordset> +</bookinfo> + +<chapter id="playing-kgoldrunner"> +<title>Playing &kgoldrunner;</title> + +<sect1 id="introduction"> +<title>Introduction</title> + +<para>&kgoldrunner; is an action game where the hero +<inlinemediaobject><imageobject> +<imagedata fileref="hero.png" format="PNG"/> +</imageobject></inlinemediaobject> +runs through a maze and dodges enemies +<inlinemediaobject><imageobject> +<imagedata fileref="enemy.png" format="PNG"/> +</imageobject></inlinemediaobject> +</para> + +<para>You must guide the hero with the mouse or keyboard and collect +all the gold nuggets, then you can climb up into the next level. Your +enemies are also after the gold. Worse still, they are after you! They +will kill you if they catch you!</para> + +<para>The problem is you have no weapon to kill +<emphasis>them</emphasis>. All you can do is run away, dig holes in +the floor to trap them or lure them into some area where they cannot +hurt you. After a short time a trapped enemy climbs out of his hole, +but if it closes before that, he will die and reappear somewhere else. +</para> + +<para>If you have never played before, try the <quote>Tutorial</quote> +game, which teaches you the rules and basic skills. Then try the +<quote>Initiation</quote> game. Experts might enjoy the +<quote>Challenge</quote> or <quote>Vengeance of Peter W</quote> games, +but the <quote>Initiation</quote> game has 100 levels and some are +very difficult. It is a good game for achieving a High Score.</para> + +<para> As you move to more advanced levels, you will find that +&kgoldrunner; combines action, strategy, tactics and puzzle +solving — all in one game. Good luck!</para> + +</sect1> + +<sect1 id="typical-game"> +<title>A Typical Game</title> + +<para>Below is a typical game in progress. The hero (green) is at +level 4 in the Advanced Tutorial game. The window's status bar shows +how many lives he has left and how many points he has scored. It also +shows that there is a hint available for this level (as there always +is in tutorial games) and that the action is stopped (while taking +this snapshot), but can be continued by pressing <keycap>P</keycap> or +<keycap>Esc</keycap>.</para> + +<para>The hero started at the top left, dug a hole and dropped into a +line of false bricks and gold where you can now see him falling. The +enemy above him will fall into the hole, then climb out and be trapped +up there till the end of the level. He could cause the hero some +problems then, because that is where the hidden ladders appear when +all the gold is gone. The hero has to use them to get to the next +level.</para> + +<screenshot> +<screeninfo>&kgoldrunner; typical game</screeninfo> +<mediaobject> +<imageobject><imagedata fileref="tute008.png" format="PNG"/></imageobject> +<textobject><phrase>&kgoldrunner; typical game</phrase></textobject> +</mediaobject> +</screenshot> + +<para>The enemy on the right is falling and carrying some gold. +Notice his gold outline. The third enemy is about to come down a ladder to +chase the hero. He will have to dodge both enemies when he reaches +the floor ... This level also shows diggable bricks and undiggable +concrete and has lots of traps (false bricks), which look just like +ordinary bricks.</para> + +</sect1> + +<sect1 id="how-to-play"> +<title>How To Play</title> + +<sect2> +<title>Starting the Game</title> + +<para>When the &kgoldrunner; window appears, click on the name of one +of the games in the list displayed, then click on the <guibutton>Start +Game</guibutton> button. Level 1 of the game you selected will appear +and the mouse pointer will be over the hero. You start play by moving +the mouse, clicking the mouse or pressing any key that can control the +hero (⪚ <keycap>Space</keycap>), but avoid using +<keycap>Q</keycap>, <keycap>S</keycap>, <keycap>P</keycap> or &Esc; at +this stage. You start each level in the same way.</para> + +<para>You have five lives at the start and gain a bonus life for each +level completed.</para> + +</sect2> + +<sect2 id="mouse-control"> +<title>Moving Around</title> + +<para>By default you control the hero (green) with the mouse, but you +can also control him with the keyboard (<link +linkend="keyboard-control">see below</link>). He moves towards +wherever you place the mouse pointer. He cannot move as fast as you +can move the mouse, but he will try hard to catch up. If the mouse +pointer is above or below his level, he will always go up or down when +there is a ladder available or a place to fall into. Otherwise he will +move horizontally until he is above, below or right at the mouse +pointer. You can make him follow simple paths (like _ | L or U), but +be careful not to get too many twists and turns ahead of him.</para> + +<para>You can move left or right over bricks, concrete, ladders or +bars and up or down over ladders. If you are on an empty square or a +gold nugget and there is no brick, concrete, ladder or bar to hold you +up, gravity takes over and you fall. You can also fall by moving down +from a bar or the bottom of a ladder, so keep the mouse pointer up +there if you want to hold on.</para> + +</sect2> + +<sect2 id="keyboard-control"> +<title>Keyboard Control</title> + +<para>If you prefer, you can use the keyboard to control the hero. The +default keys are the arrow keys and <keycap>I</keycap>, +<keycap>J</keycap>, <keycap>K</keycap> and <keycap>L</keycap> (in +honor of the original Apple II game), with the keys +<keycap>Z</keycap> and <keycap>C</keycap> or <keycap>U</keycap> and +<keycap>O</keycap> for digging. You can play one-handed by using +<keycap>U</keycap>, <keycap>I</keycap>, <keycap>O</keycap>, +<keycap>J</keycap>, <keycap>K</keycap>, <keycap>L</keycap> and +<keycap>Space</keycap> (on a <quote>QWERTY</quote> keyboard) or +two-handed by using the arrow keys, <keycap>Space</keycap>, +<keycap>Z</keycap> and <keycap>C</keycap>. You can also choose other +keys, on the <guimenu>Settings</guimenu> menu, if you have the &kde; +desktop version of &kgoldrunner;.</para> + +<para>You enter keyboard mode by pressing one of the keys that can +control the hero or by selecting <guimenuitem>Keyboard +Controls Hero</guimenuitem> on the <guimenu>Settings</guimenu> +menu.</para> + +<para>The movement keys (<keycap>I</keycap>, <keycap>J</keycap>, +<keycap>K</keycap>, <keycap>L</keycap> or arrows) start the hero +moving up, down, left or right. He continues moving in that direction, +if he can, until you press another movement key or +<keycap>Space</keycap> to stop. In mouse mode, he stops automatically +when he gets to the mouse pointer.</para> + +<para>A word of warning: using the keyboard is much harder, in the +long run, than using the mouse. Think of the mouse as a +joystick.</para> + +</sect2> + +<sect2 id="pausing"> +<title>Taking a Break</title> + +<para>You can stop the game at any time by pressing a Pause key +(either <keycap>P</keycap> or &Esc;). You can resume by pressing the +<keycap>P</keycap> or &Esc; key again. There is also a +<guimenuitem>Pause</guimenuitem> option in the <guimenu>Game</guimenu> +menu, but the problem is to get up there without moving the hero and +getting into trouble.</para> + +<tip><para>When you want to use the &kgoldrunner; menu or do +some work in another window, always press a Pause key and stop the +game. Otherwise the hero will go on following the mouse pointer and +might get into trouble.</para></tip> + +</sect2> + +<sect2 id="winning"> +<title>Winning a Level</title> + +<para>The object of the game is to collect all the gold, by moving or +falling onto it. When there is none left, you must move to the top of +the playing area to get to the next level. Often, as you collect the +last piece of gold, hidden ladders will appear and you can use them to +climb to the top. </para> + +</sect2> + +<sect2 id="false-bricks"> +<title>Beware of False Bricks</title> + +<para>False bricks, otherwise known as fall-through bricks or traps, +are the other hidden feature of the game. They look just like ordinary +bricks, but if you run over one you fall. This can be bad if there is +an enemy or a pit down there, or good if there is some gold.</para> + +</sect2> + +<sect2 id="enemies"> +<title>Enemies</title> + +<para>Enemies move in very much the same way as the hero. The main +difference is when they fall into a hole the hero has dug (see <link +linkend="rules-of-digging">Rules of Digging</link> below). They will +pick up gold either always or at random, depending on the game +settings, and will drop gold at random on brick, concrete or the top +of a ladder. An enemy who is carrying gold has a gold outline. You +must get the gold away from him before you can finish the +level.</para> + +<para>If an enemy touches you or you move down onto one, you die and +must start the level again, if you have any lives left. However, it is +possible to walk or stand on an enemy's head and you can ride an enemy +down when he is falling. Some advanced levels require such a +move.</para> + +</sect2> + +<sect2 id="losing-a-level"> +<title>Losing a Level</title> + +<para>As explained above, you can lose a level and a life by touching +an enemy. You can also lose by getting caught in a dug brick when it +closes. Otherwise you can commit suicide by pressing key +<keycap>Q</keycap> or using the menu item +<menuchoice><guimenu>Game</guimenu><guimenuitem>Kill +Hero</guimenuitem></menuchoice>. Why would you want to do that? Well, +sometimes you can get trapped in a place from which you cannot +escape. You will stay imprisoned for ever unless you commit +suicide!</para> + +</sect2> + +<sect2 id="importance-of-digging"> +<title>The Importance of Digging</title> + +<para>Digging is one of the most powerful tactics you have. To dig a +hole in a brick to the left or right, just click the +<mousebutton>Left</mousebutton> or <mousebutton>Right</mousebutton> +mouse button, or use one of the digging keys (defaults +<keycap>Z</keycap>, <keycap>C</keycap>, <keycap>U</keycap>, +<keycap>O</keycap>.)</para> + +<para>You can dodge an oncoming enemy by digging a hole, waiting for +him to fall in and then running quickly over his head. At the same +time you can collect any gold he was carrying. Usually you can dig two +holes to capture and run over two enemies who are close together, but +this rarely works if the enemies are separated or there are more than +two of them.</para> + +<para>You can kill enemies by digging enough holes in their path. It +usually takes two or more holes to kill one enemy and up to eight or +more holes to kill four or five. When enemies die, they reappear +immediately, either where they started the level or near the top of +the playing area, depending on whether the game follows +<quote>&kgoldrunner;</quote> or <quote>Traditional</quote> rules and +settings (see <link linkend="choice-of-rules">Choice of Rules</link>).</para> + +</sect2> + +<sect2 id="rules-of-digging"> +<title>The Rules of Digging</title> + +<para>You click the <mousebutton>Left</mousebutton> or +<mousebutton>Right</mousebutton> mouse button, to dig a hole to the +left or right, or use the <keycap>Z</keycap>, <keycap>C</keycap>, +<keycap>U</keycap> or <keycap>O</keycap> keys. Only bricks can be dug, +not anything else. The hole will appear in the floor on one side or +the other (&ie; below and to the left or right of the hero). You can +be running, standing or falling when you dig. There must be an empty +space or hole above the brick (&ie; no digging under a ladder, bar, +gold, brick, concrete, false brick or enemy).</para> + +<para>The hero can move in any direction through dug holes, including +falling right through a hole to escape an enemy. After a short time, +dug holes close up, so you must use them quickly. Plan your digging in +advance. There is no time to stop and think while you dig.</para> + +<para>Enemies are always captured if they fall into a dug hole and +will always climb UP to get out of it. Their time in the hole is less +than the time the hole stays open, so to kill enemies you usually have +to dig several holes in quick succession. Enemies always give up gold +as they fall into a hole, so you can quickly run onto the enemy's head +and grab the gold before he climbs out.</para> + +<para>Enemies will never fall down through a hole from above, but +depending on the game rules and <guimenu>Settings</guimenu>, they can +run horizontally into a dug hole and not be captured and can fall from +there or run into another hole or run out of the hole. Several levels +that follow <quote>Traditional</quote> rules depend on an enemy being +able to run through a hole.</para> + +</sect2> + +<sect2 id="winning-and-losing-the-game"> +<title>Winning and Losing the Game</title> + +<para>You win by completing the last level in the game. You lose when +your last life is gone. Either way, if you have achieved one of the +ten highest scores for that game, you can record your achievement in +the <quote>KGoldrunner Hall of Fame</quote></para> + +</sect2> +</sect1> + +<sect1 id="scoring"> +<title>Scoring</title> + +<itemizedlist> +<listitem> +<para>Start with 5 lives.</para> +</listitem> +<listitem> +<para>Lose a life and repeat a level when the hero dies</para> +</listitem> +<listitem> +<para>Gain a life when you complete a level</para> +</listitem> +<listitem> +<para>75 points for trapping an enemy</para> +</listitem> +<listitem> +<para>75 points for killing an enemy</para> +</listitem> +<listitem> +<para>250 points for collecting gold</para> +</listitem> +<listitem> +<para>1500 points for completing a level</para> +</listitem> +</itemizedlist> + +</sect1> + +<sect1 id="choice-of-rules"> +<title>Choice of Rules</title> + +<para>Most of the rules of &kgoldrunner; are covered in the section +<link linkend="how-to-play">How to Play</link>, however there are two +major rule settings that affect the style of play: known as +<quote>Traditional</quote> and <quote>&kgoldrunner;</quote>. It is +important to know which settings are in force when you are playing a +game. Many <quote>Traditional</quote> levels are impossible with +<quote>&kgoldrunner;</quote> settings. Most +<quote>&kgoldrunner;</quote> levels are easier with +<quote>Traditional</quote> settings, but the +<quote>Traditional</quote> games are no pushover. To make life easier, +&kgoldrunner; automatically chooses the correct settings for a game +when you go into it, but you can can change them if you wish. </para> + +<para>The main difference between <quote>Traditional</quote> and +<quote>&kgoldrunner;</quote> settings is the method by which the +enemies choose a path to the hero.</para> + +<itemizedlist> +<listitem> +<para>In the <quote>Traditional</quote> search method, enemies look +for vertical paths (ladders and falls) and they try to stay above the +hero or at the same height. They go below him only as a last +resort. The enemies make no attempt to chase the hero in the +horizontal direction until they are at the same height and can find a +horizontal path. This leads to situations where you can +<quote>control</quote> enemies who are far away from you and make them +work for you or at least keep out of your hair.</para> +</listitem> +<listitem> +<para>The <quote>&kgoldrunner;</quote> method searches alternately for +horizontal and vertical paths, which tends to keep the enemies over +your side of the playing area and at about the same height (&ie; they +are more aggressive and not so easy to manipulate). That leads to a +more action-packed game, but with less opportunity for strategy and +puzzle-solving.</para> +</listitem> +</itemizedlist> + +<para>The other differences are listed below:</para> + +<itemizedlist> +<listitem> +<para>In <quote>&kgoldrunner;</quote> play the enemies and hero always +move at the same speed and bricks always take the same time to +close. In <quote>Traditional</quote> play the game speed depends on +the number of enemies in a level. The more enemies, the slower they +run. The hero also becomes slower, but not so noticeably.</para> +</listitem> +<listitem> +<para>In <quote>Traditional</quote> play, enemies always collect gold +nuggets when they run into them. In <quote>&kgoldrunner;</quote> play +it is a random choice. The enemies drop nuggets after a random time in +both types of play.</para> +</listitem> +<listitem> +<para>Enemies can run horizontally through holes in +<quote>Traditional</quote> play but not in +<quote>&kgoldrunner;</quote> play. The trick in several +<quote>Traditional</quote> levels depends on releasing an enemy from +behind a brick wall. When you dig away the bricks, he runs out through +the hole.</para> +</listitem> +<listitem> +<para>When enemies die in <quote>&kgoldrunner;</quote> play, they go +back to where they started the level. In <quote>Traditional</quote> +play, they reappear at a random place near the top of the playing +area. This makes a big difference, especially in levels where you have +to get enemies to fetch nuggets down for you, but also because the +enemies keep falling down onto you as fast as you can kill +them.</para> +</listitem> +</itemizedlist> + +</sect1> +</chapter> + +<chapter id="level-selection-dialog"> +<title>The Level Selection Dialog</title> + +<sect1 id="level-selection-dialog-box"> +<title>Using the Level Selection Dialog Box</title> + +<screenshot> +<screeninfo>The Level Selection dialog</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="select.png" format="PNG" /> +</imageobject> +<textobject> +<phrase>The Level Selection dialog</phrase> +</textobject> +</mediaobject> +</screenshot> + +<para>This box appears when the game starts and also when you select +options from the <guimenu>Game</guimenu> or <guimenu>Editor</guimenu> +menus. You use it to choose a game and a level to play, edit, save, +move or delete. The main button at the bottom is the +<guibutton>OK</guibutton>" button. Its label changes according to what +you are doing: in this case choosing a game and level to edit.</para> + +<sect2 id="selecting-a-game"> +<title>Selecting a Game</title> + +<para>There are several <quote>System</quote> games that come with the +&kgoldrunner; release and they appear at the top of the list box. If +you have composed games and levels yourself, they appear below the +<quote>System</quote> games. To select one of the games in the list, +just click on its name.</para> + +<para>When you select a game, the dialog automatically shows what rule +settings apply (see <link linkend="choice-of-rules">Choice of Rules</link>) +and how many levels there are. The <guibutton>More Info...</guibutton> +button shows you further information about the game.</para> + +</sect2> + +<sect2 id="selecting-a-level"> +<title>Selecting a Level</title> + +<para>When you are starting a game, the level is fixed at +<quote>001</quote>. In other cases, such as this example, you can +choose a level. The default selection will be something reasonable, +such as the last level you played or edited.</para> + +<para>You can select a level either by typing it in or by moving the +slider. The arrows at the end increase or decrease the number by +one. Also you can drag the slider with the left mouse button held down +and change the number rapidly or you can change it by 10 if you click +in the space to the left or right of the slider. </para> + +<para>As the level number changes, a preview of the level appears in the +small preview window and the level's name (if it has one) appears +below the slider. </para> + +</sect2> + +<sect2 id="completing-selection"> +<title>Completing your Selection</title> + +<para>When you have chosen a game and a level, just click the main +button at the bottom to proceed with your edit or play.</para> + +<para>Until you do that, nothing changes, so you can always click +<guibutton>Cancel</guibutton> and go back to what you were doing +earlier. Note that the game action is frozen while this dialog box +appears, so you can continue playing where you left off if you choose +<guibutton>Cancel</guibutton>.</para> + +</sect2> + +<sect2 id="saving-changes"> +<title>Saving Changes</title> + +<para>If you select an action on the <guimenu>Game</guimenu> or +<guimenu>Editor</guimenu> menu and you were previously editing and had +not saved your changes, you will get a message asking you to save, +abandon or continue your work. The level selection dialog box for the +new action will not appear until you have made a decision about your +previous work.</para> + +</sect2> + +<sect2 id="any-level"> +<title>Playing or Editing <quote>Any</quote> Level</title> + +<para>Note that the menus allow you to select and play or edit +<quote>any</quote> level. If you start a game after level 1, that is +OK, you will just not get such a high score. Dedicated players often +prefer to play high-numbered levels for fun, rather than go for a high +score, or they might like to <quote>train</quote> on higher levels +before attempting a high score.</para> + +<para>If you select a System level for editing, that is OK too, but +you must save it in one of your own games: not back in the System +game. If it is a very difficult level, you might want to change it so +that you don't go back to the start of the level every time you +die.</para> + +<para>To see what this means, try the <quote>Challenge</quote> game, +level 16, <quote>The Three Musketeers</quote>. That level has about +ten difficult puzzles in it. When you have solved puzzle 1, you don't +want to keep repeating it while you work on puzzle 2. The secret is to +make an editable copy, then keep updating it and changing the hero's +starting point, until you have solved all the puzzles. Then you can +attempt the real thing.</para> + +</sect2> +</sect1> +</chapter> + +<chapter id="menu-reference"> +<title>The Menu Reference</title> + +<sect1 id="menu-overview"> +<title>Overview of Menus</title> + +<variablelist> +<varlistentry> +<term><link linkend="game-menu"><guimenu>Game</guimenu></link></term> +<listitem> +<para>This menu contains options affecting game play, such as starting +and finishing games, saving games, loading saved games, showing high +scores and getting a hint (if available). The +<guimenu>Game</guimenu> Menu also contains the +<guimenuitem>Quit</guimenuitem> option. You can also +quit by clicking the <guiicon>X</guiicon> at the top right of the +&kgoldrunner; window.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><link +linkend="editor-menu"><guimenu>Editor</guimenu></link></term> +<listitem> +<para>This menu has everything you need to create your own games and +levels and maintain them, including features to help you re-order levels +or move them between games or to delete them when no longer needed. When +you reorganize your levels, the level numbers in your game remain +consecutive (no gaps) and the levels are automatically +renumbered.</para> +<para>When you are using the Game Editor a graphical toolbar with tool +tip text appears under the menu bar. See the <link +linkend="game-editor">Game Editor</link> for more details of how to +create and edit &kgoldrunner; levels.</para> </listitem> +</varlistentry> + +<varlistentry> +<term><link +linkend="landscapes-menu"><guimenu>Landscapes</guimenu></link></term> +<listitem> +<para>This menu offers you a choice of landscapes (actually color +schemes) in which to play. All the landscapes have keyboard shortcuts, +so you can actually change the landscape as the game is playing. Try +<keycap>Shift+A</keycap>, to switch to the nostalgic Apple II landscape.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><link +linkend="settings-menu"><guimenu>Settings</guimenu></link></term> +<listitem> +<para>This menu has four groups of settings: the choice of mouse or +keyboard control, the game-speed options, the choice of of +<quote>&kgoldrunner;</quote> or <quote>Traditional</quote> playing rules +(see <link linkend="choice-of-rules">Choice of Rules</link>) and +lastly the options to increase or decrease the size of the playing area. +The current selections are checked. The settings are automatically +selected when you start playing, but you can use this menu to vary them +if you wish. </para> +<para>On the &kde; desktop version of &kgoldrunner;, there is also an +option to re-assign keyboard shortcuts and hero-control keys. </para> +</listitem> +</varlistentry> + +<varlistentry> +<term><link linkend="help-menu"><guimenu>Help</guimenu></link></term> +<listitem> +<para>The <guimenu>Help</guimenu> menu contains an option +to get a hint (if available), access to the +&kgoldrunner; Handbook (this document), <guimenuitem>About +&kgoldrunner;</guimenuitem> and <guimenuitem>About &kde;</guimenuitem> (or +<guimenuitem>About Qt</guimenuitem> Toolkit). </para> +<para>In the &kde; desktop version, there is also an option to report a +Bug or Wishlist item.</para> +<para>If you would like to make a suggestion or you have some new levels +to contribute, the current author's email address is in the +<guimenuitem>About &kgoldrunner;</guimenuitem> menu item.</para> +</listitem> +</varlistentry> +</variablelist> + +</sect1> + +<sect1 id="game-menu"> +<title>The <guimenu>Game</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice> +<shortcut><keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo></shortcut> +<guimenu>Game</guimenu><guimenuitem>New Game...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Shows the level selection dialog box, where you choose a game +(which will start at level 1).</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut><keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo></shortcut> +<guimenu>Game</guimenu><guimenuitem>Load Saved Game...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Brings up a table of previously saved games, sorted with the +latest first. Each line lists the game, level, number of lives, score, +day of week, date and time. If you select a line and click the +<guibutton>OK</guibutton> button, that game starts at the beginning of +that level, with the lives and score you saved.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Game</guimenu><guimenuitem>Play Any Level...</guimenuitem> +</menuchoice> +</term> +<listitem><para>Shows the level selection dialog box, where you choose +a game and a level to play.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Game</guimenu><guimenuitem>Play Next Level...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Shows the level selection dialog box with the game +and level set to one more than previously. You can then choose to play +that level or another.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><shortcut><keycap>S</keycap></shortcut> +<guimenu>Game</guimenu><guimenuitem>Save Game...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Saves the current game, level, lives and +score. The option will only save the position and score as at the start +of the current level. You can save when you are mid-way through a +level, but &kgoldrunner; will still save the position (and score) as it +was at the start of the level. You will receive a warning message about +that. Before using this option, you must press a Pause key +(<keycap>P</keycap> or &Esc;) to freeze the game as you move the mouse, +but it is much easier to use the <keycap>S</keycap> key as a +short-cut.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut><keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo></shortcut> +<guimenu>Game</guimenu><guimenuitem>Save Edits...</guimenuitem> +</menuchoice> +</term> +<listitem><para>This option is enabled only if you have been using +the Game Editor. It brings up the level selection dialog box and lets +you choose a level number and game in which to save your work. Its +action is exactly the same as the <guimenuitem>Save +Edits</guimenuitem> option on the <guimenu>Editor</guimenu> menu and +the <guiicon>disk</guiicon> icon on the Editor toolbar.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut><keycap>P or &Esc;</keycap></shortcut> +<guimenu>Game</guimenu><guimenuitem>Pause</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Stops or restarts the game action.</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>Shows a table of up to ten high scores for the currently selected +game. Each line shows the player's rank and name, the level reached, +the score achieved, the day of the week and the date.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Game</guimenu><guimenuitem>Get Hint</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>If the current level has a hint, this option pops it up. The +option is <quote>grayed out</quote> if there is no hint. The status bar +also has a section to show you whether there is a hint for the current +level. It is customary for championship and tutorial games to have a hint +on every level.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><shortcut><keycap>Q</keycap></shortcut> +<guimenu>Game</guimenu><guimenuitem>Kill Hero</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Kills the hero when he is in a position from which he cannot +escape.</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>Terminates &kgoldrunner; immediately. If a game is in +progress, it disappears forever (unless you have just saved it) and +there is no check for a high score. If you were editing a level, you +are given an opportunity to save your work.</para> +</listitem> +</varlistentry> + +</variablelist> + +</sect1> + +<sect1 id="editor-menu"> +<title>The <guimenu>Editor</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice> +<guimenu>Editor</guimenu><guimenuitem>Create Level</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Shows the Editor toolbar and a blank playing area +on which you can draw a new level. When done, use +<guimenuitem>Save Edits</guimenuitem> to assign the new level to a game +and level number.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Editor</guimenu><guimenuitem>Edit Any Level...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Shows the level selection dialog box, where +you choose a game and level to edit. You can choose a System game and +level, but you get a warning that you can only save the edited level +in one of your own games.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Editor</guimenu><guimenuitem>Edit Next Level...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Shows the level selection dialog box with the game +and level set to one more than current. You can then choose to edit +that level or another.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut><keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo></shortcut> +<guimenu>Editor</guimenu><guimenuitem>Save Edits...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Shows the level selection dialog box with +appropriate default settings for saving a new or edited level. You can +change the game and level number and achieve a <quote>Save As...</quote> +effect. This dialog box has a special button, <guibutton>Edit Level Name and +Hint</guibutton>, which shows a dialog box where you can add an optional +name and hint to your level.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Editor</guimenu><guimenuitem>Move Level...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>This is a two-part operation. Before using <guimenuitem>Move +Level</guimenuitem>, you must load a level to be moved by selecting it +for play or edit. The <guimenuitem>Move Level</guimenuitem> option +then shows the level selection dialog box, where you choose a new place +for the loaded level. You can change both the game and the level +number to move a level to another game or you can just change the level +number to re-order levels within a game. You cannot move a System +level.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Editor</guimenu><guimenuitem>Delete Level...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Shows the level selection dialog box, where you choose a level +to delete. You cannot delete a System level.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Editor</guimenu><guimenuitem>Create Game...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>You need to use this option before you start +creating your own &kgoldrunner; levels. It shows a dialog box where you +can enter the name of a new game, a 1-5 character prefix for +level-file names, the default rules for your game +(<quote>&kgoldrunner;</quote> or <quote>Traditional</quote>) and an +optional description or comment about the game.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Editor</guimenu><guimenuitem>Edit Game Info...</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Shows the level selection dialog box, where +you choose a game to be edited, then shows the game information in a +dialog box where you can edit the name, rules and description, but +not the file name prefix, in case you have saved some levels. That +is because the prefix is used in level-file names internally.</para> +</listitem> +</varlistentry> + +</variablelist> + +</sect1> + +<sect1 id="landscapes-menu"> +<title>The <guimenu>Landscapes</guimenu> Menu</title> + +<variablelist> + +<varlistentry> +<term><menuchoice> +<shortcut><keycombo action="simul">&Shift;<keycap>G</keycap></keycombo></shortcut> +<guimenu>Landscapes</guimenu><guimenuitem>&kgoldrunner;</guimenuitem> +</menuchoice></term> +<listitem> +<para>Gives you the default &kgoldrunner; landscape, with +red bricks and wooden ladders.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut><keycombo action="simul">&Shift;<keycap>A</keycap></keycombo></shortcut> +<guimenu>Landscapes</guimenu><guimenuitem>Apple II</guimenuitem> +</menuchoice></term> +<listitem> +<para>Gives you a nostalgic look at the original Apple II game, as it +was when you plugged your Apple II into your TV set — otherwise you had +a monochrome monitor.</para> + +<para>Actually, the hero was white, the enemies had white +pants and orange (flesh-tint) tops and the gold was white boxes with orange +panels. The whole effect was fuzzier (a sort of hardware anti-aliasing), +which made the bricks look almost three-dimensional — difficult to +recreate on today's pin-sharp monitors.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut><keycombo action="simul">&Shift;<keycap>I</keycap></keycombo></shortcut> +<guimenu>Landscapes</guimenu><guimenuitem>Ice Cave</guimenuitem> +</menuchoice></term> +<listitem> +<para>For fans of the movie <quote>Superman</quote> or the +James Bond movie <quote>Die Another Day</quote> — or you can +use it on a hot day.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut><keycombo action="simul">&Shift;<keycap>M</keycap></keycombo></shortcut> +<guimenu>Landscapes</guimenu><guimenuitem>Midnight</guimenuitem> +</menuchoice></term> +<listitem> +<para>For real &kgoldrunner; addicts, on those late-night sessions.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut><keycombo action="simul">&Shift;<keycap>K</keycap></keycombo></shortcut> +<guimenu>Landscapes</guimenu><guimenuitem>&kde; Kool</guimenuitem> +</menuchoice></term> +<listitem> +<para>Inspired by the icon colors on the &kde; desktop.</para> +</listitem> +</varlistentry> + +</variablelist> + +</sect1> + +<sect1 id="settings-menu"> +<title>The <guimenu>Settings</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu><guimenuitem>Mouse Controls Hero</guimenuitem> +</menuchoice></term> +<listitem> +<para>Sets mouse control of the hero +(see <link linkend="mouse-control">Moving Around</link>).</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu><guimenuitem>Keyboard Controls Hero</guimenuitem> +</menuchoice></term> +<listitem> +<para>Sets keyboard control of the hero +(see <link linkend="keyboard-control">Keyboard Control</link>).</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu><guimenuitem>Normal Speed</guimenuitem> +</menuchoice></term> +<listitem> +<para>Sets normal game speed (12 units).</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu><guimenuitem>Beginner Speed</guimenuitem> +</menuchoice></term> +<listitem> +<para>Sets beginner game speed (6 units, half of normal speed).</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu><guimenuitem>Champion Speed</guimenuitem> +</menuchoice></term> +<listitem> +<para>Sets champion game speed (18 units, 1.5 times normal speed).</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><shortcut><keycap>+</keycap></shortcut> +<guimenu>Settings</guimenu><guimenuitem>Increase Speed </guimenuitem> +</menuchoice></term> +<listitem> +<para>Increases the game speed by one unit, up to a maximum of 24 +units (twice normal speed). You can use the <keycap>+</keycap> key +as a shortcut.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut><keycap>-</keycap></shortcut> +<guimenu>Settings</guimenu><guimenuitem>Decrease Speed</guimenuitem> +</menuchoice></term> +<listitem> +<para>Decreases the game speed by one unit, down to a minimum of 3 +units (a quarter of normal speed). You can use the <keycap>-</keycap> key +as a shortcut.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu><guimenuitem>Traditional Rules</guimenuitem> +</menuchoice></term> +<listitem> +<para>Sets Traditional default playing rules +(see <link linkend="choice-of-rules">Choice of Rules</link>).</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu><guimenuitem>&kgoldrunner; Rules</guimenuitem> +</menuchoice></term> +<listitem> +<para>Sets &kgoldrunner; default playing rules +(see <link linkend="choice-of-rules">Choice of Rules</link>).</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu><guimenuitem>Larger Playing Area</guimenuitem> +</menuchoice></term> +<listitem> +<para>When &kgoldrunner; starts, it chooses the size of the playing area +(in pixels), based on your screen's resolution (e.g. 1024x768). This +option allows you to expand the playing area, up to a maximum, and +enlarge all the corresponding graphics.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu><guimenuitem>Smaller Playing Area</guimenuitem> +</menuchoice></term> +<listitem> +<para>When &kgoldrunner; starts, it chooses the size of the playing area +(in pixels), based on your screen's resolution (e.g. 1024x768). This +option allows you to reduce the size of the playing area, down to a minimum, +and shrink all the corresponding graphics.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu><guimenuitem>Configure Shortcuts...</guimenuitem> +</menuchoice></term> +<listitem> +<para>In the &kde; version only, this item allows you to change the keyboard +assignments (⪚ for keyboard control of the hero) or to assign your own +shortcut keys for menu items.</para> +</listitem> +</varlistentry> + +</variablelist> +</sect1> + +<sect1 id="help-menu"> +<title>The <guimenu>Help</guimenu> Menu</title> + +<para>In addition to the standard items listed below, &kgoldrunner; has +the following special entry:</para> + +<variablelist> + +<varlistentry> +<term><menuchoice> +<guimenu>Help</guimenu><guimenuitem>Get Hint</guimenuitem></menuchoice></term> +<listitem> +<para>If the current level has a hint, this option pops it up. The +option is <quote>grayed out</quote> if there is no hint. The status bar +also has a section to show you whether there is a hint for the current +level. It is customary for championship and tutorial games to have a hint +on every level.</para> +</listitem> +</varlistentry> + +</variablelist> + +<para>The following are standard items:</para> + +&help.menu.documentation; + +</sect1> + +</chapter> + +<chapter id="game-editor"> +<title>The Game Editor</title> + +<sect1 id="editor-start"> +<title>Getting Started with the Editor</title> + +<sect2 id="creating-a-game"> +<title>Creating a Game</title> + +<para>Before you create or edit a &kgoldrunner; level, you must create +a game in which to save it. Use <guimenuitem>Create Game</guimenuitem> +on the <guimenu>Editor</guimenu> menu. If you +forget, you will be reminded. </para> + +<para>The most important decisions to make when creating a game are to +choose the rules you are going to follow (<quote>Traditional</quote> +or <quote>&kgoldrunner;</quote>, see <link +linkend="choice-of-rules">Choice of Rules</link>) and to choose a +unique 1-5 character file name prefix for your game and levels. You +also need a name and description for your game, but those can easily +be changed later.</para> + +<para>The prefix is used internally by &kgoldrunner; to identify level +files, high score files and saved games. You can use your initials as +a prefix provided they are not the same as a &kgoldrunner; prefix. So +far, the prefixes <quote>level</quote>, <quote>plws</quote>, +<quote>wad</quote>, <quote>plwv</quote>, <quote>tute</quote> and +<quote>tutea</quote> have been used and <quote>trad</quote> and +<quote>chmp</quote> are reserved for future use. </para> + +<para>The four-letter <quote>tute</quote> prefix is reserved for +tutorial games, which show the game description and hints on levels as +they play. If you compose your own Tutorial game you could use the +prefix <quote>tutex</quote>, to make it run as a tutorial but not get +its files confused with those of the basic Tutorial or Advanced Tutorial +(prefixes <quote>tute</quote> and <quote>tutea</quote>). </para> + +</sect2> + +<sect2 id="creating-a-level"> +<title>Creating a Level</title> + +<para>When you have a game set up, use <guimenuitem>Create +Level</guimenuitem> on the <guimenu>Editor</guimenu> menu to start +creating a level. It provides you with a blank playing area of 28x20 +squares, with the hero at the top left. You can put the hero somewhere +else if you prefer and you do not have to use the whole 28x20 +area. Lots of interesting levels use smaller areas. </para> + +<para>The minimum requirement for a level to be playable is to have a +hero, a gold nugget he can get to and a visible or hidden ladder +leading to the top of the playing area. You do not have to have +enemies, bars or even bricks. There are many challenging levels that +have no enemies or no bricks.</para> + +</sect2> +</sect1> + +<sect1 id="editing-and-testing"> +<title>Editing and Testing</title> + +<sect2 id="editing-a-level"> +<title>Editing a Level</title> + +<para>Use <guimenuitem>Edit Any Level</guimenuitem> or +<guimenuitem>Edit Next Level</guimenuitem> on the +<guimenu>Editor</guimenu> menu to start editing an existing level or use +<guimenuitem>Create Level</guimenuitem> to start editing a new level.</para> + +<para>If you choose +a System level, you are warned that you will have to save it in one of +your own games. Otherwise, the default is to save the level back where +it came from, but you can vary that.</para> + +</sect2> + +<sect2 id="painting-objects"> +<title>Painting Objects in a Level</title> + +<para>The picture below shows the menubar and the edit toolbar, which +appears when you first choose <guimenuitem>Create +Level</guimenuitem>, <guimenuitem>Edit Any Level</guimenuitem> or +<guimenuitem>Edit Next Level</guimenuitem> from the +<guimenu>Editor</guimenu> menu and so change from Play to Edit +mode. It disappears when you go back to Play mode. Note also that, in +Edit mode, false bricks and hidden ladders are made visible in the +playing area.</para> + +<para>The three icons on the left of the edit toolbar have the same +actions as the menu options <guimenuitem>Create Level</guimenuitem>, +<guimenuitem>Edit Any Level</guimenuitem> and <guimenuitem>Save +Edits</guimenuitem>. The other eleven icons are for editing and +painting objects in your level. </para> + + +<para>From left to right the other eleven icons are <guiicon>Edit Name/Hint +</guiicon> (light bulb), <guiicon>Empty space</guiicon> (background), +<guiicon>Hero</guiicon>, +<guiicon>Enemy</guiicon>, <guiicon>Brick (can dig)</guiicon>, +<guiicon>Concrete (cannot dig)</guiicon>, <guiicon>Trap +(can fall through)</guiicon>, <guiicon>Ladder</guiicon>, +<guiicon>Hidden ladder</guiicon>, <guiicon>Pole (or bar)</guiicon> and +<guiicon>Gold nugget</guiicon>.</para> + +<screenshot> +<screeninfo>Editing a level</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="editbar.png" format="PNG" /> +</imageobject> +<textobject><phrase>Editing a level</phrase></textobject> +</mediaobject> +</screenshot> + +<para>The <guiicon>Edit Name/Hint</guiicon> icon pops up a dialog in which +you can create or edit your level's name and hint. Both are optional, +but they are essential for tutorial levels and it is usual to provide +them with very difficult levels (see the <quote>Vengeance of Peter +W</quote> game).</para> + +<para>When you click on one of the other 10 icons, the mouse becomes a +<quote>brush</quote> that paints that icon. Initially the brush is set +to <quote>brick</quote>.</para> + +<para>You paint either by pointing and clicking the &LMB;, to place a +single object in a square, or by holding the &LMB; down and dragging +the mouse, to fill a line or area, such as a long ladder, a large +block of bricks or a concrete floor. Painting stops wherever you +release the mouse button. If you make a mistake, you can use the +<guiicon>Empty space</guiicon> icon to erase it.</para> + +<para>The hero icon works differently, because there can be only one +hero. When you paint the hero, he moves from his previous position to +wherever you release the mouse button.</para> + +</sect2> + +<sect2 id="saving-your-work"> +<title>Saving Your Work</title> + +<para>When you have finished painting, save your work using the +<guiicon>disk</guiicon> icon or <guimenuitem>Save Edits</guimenuitem> +in the <guimenu>Editor</guimenu> menu or <guimenuitem>Save +Edits</guimenuitem> in the <guimenu>Game</guimenu> menu. You must +always save into your own games, never into the System games.</para> + +<para>If you are creating a level, you use the Level Selection Dialog +to assign it to a game and level number. You use the same dialog if +you have been editing a level, but the default is to save it where it +came from. You can change the game and level, to get a <quote>Save +as...</quote> effect. If you have been editing a System level you must +save it as a copy in one of your own games.</para> + +</sect2> + +<sect2 id="adding-name-and-hint"> +<title>Adding a Level Name and Hint</title> + +<para>On the Save version of the Level Selection Dialog box is a +button marked <guibutton>Edit Level Name & Hint</guibutton>. You can use +this to put the finishing touches on your level by adding a name and +hint. Both are optional, but they are essential for tutorial levels +and it is usual to provide them with very difficult levels (see the +<quote>Vengeance of Peter W</quote> game). Of course you can also use +the <guiicon>Edit Name/Hint</guiicon> icon, at any time, to add or edit a +name and hint. </para> + +</sect2> + +<sect2 id="testing-a-level"> +<title>Testing a Level</title> + +<para>After saving an edited level, you can test it by using +<guimenuitem>Play Any Level</guimenuitem> in the +<guimenu>Game</guimenu> menu. By default the game and level number are +remembered and you can get straight into the level with just a few +clicks. If you then want to edit some more, the same is true when you +use <guimenuitem>Edit Any Level</guimenuitem> again. </para> + +</sect2> +</sect1> + +<sect1 id="reorganizing-games"> +<title>Reorganizing Games and Levels</title> + +<sect2 id="moving-a-level"> +<title>Moving a Level</title> + +<para>You can use <guimenuitem>Move Level</guimenuitem> on the +<guimenu>Editor</guimenu> menu to re-order or re-number the levels in +a game or to move a level from one game to another. <guimenuitem>Move +Level</guimenuitem> is a two-part operation. You must first load a +level by selecting it for editing or play, then when you use +<guimenuitem>Move Level</guimenuitem>, the Level Selection Dialog box +appears and you can select the new level number and game (as +required).</para> + +<para>Moves leave no gaps in the sequence of level numbers in a +game. For example, if you move level 10 of game A to level 3 of game +B, levels 11 and above in game A are re-numbered down by one (to close +the gap) and levels 3 and above in game B are re-numbered up by one +(to make room for the newcomer).</para> + +</sect2> + +<sect2 id="deleting-a-level"> +<title>Deleting a Level</title> + +<para>You can use <guimenuitem>Delete Level</guimenuitem> on the +<guimenu>Editor</guimenu> menu to remove an unwanted level. The other +levels are re-numbered so as to close the gap in the sequence. </para> + +</sect2> +</sect1> + +</chapter> + +<chapter id="questions-answers-and-tips"> +<title>Questions, Answers, and Tips</title> + +<sect1 id="hints-overview"> +<title>Overview</title> + +<para>This chapter presents some general hints for playing &kgoldrunner;, +as opposed to the specific hints you will find on the levels in tutorial and +championship games (see <link linkend="help-menu">The Help Menu</link>). +The hints are grouped as follows:</para> + +<itemizedlist> + +<listitem> +<para><link linkend="hints-dealing-with-enemies"> +Dealing with Enemies</link></para> +</listitem> + +<listitem> +<para><link linkend="hints-digging-puzzles"> +Digging Puzzles</link></para> +</listitem> + +<listitem> +<para><link linkend="hints-tricks-with-gold"> +Tricks with Gold</link></para> +</listitem> + +<listitem> +<para><link linkend="hints-solving-difficult-levels"> +Solving Difficult Levels</link></para> +</listitem> + +</itemizedlist> +</sect1> + +<sect1 id="hints-dealing-with-enemies"> +<title>Dealing with Enemies</title> + +<itemizedlist> +<listitem> +<para>You can always trap a single oncoming enemy in one hole, get his +gold and run on over him without killing him. It is often a good idea +to dig behind you and delay him further, but that might kill him. In +some levels it is not a good idea to kill enemies.</para> +</listitem> +<listitem> +<para>You can usually trap two oncoming enemies in two holes, get +their gold and run on over them, but this is dangerous if the enemies +are separated by two or three spaces. Sometimes two holes kill one of +the enemies and the other escapes and sometimes both escape.</para> +</listitem> +<listitem> +<para>It is nearly always impossible to trap three oncoming enemies +and run on over them. You will have to kill them, dig and drop through +the floor or simply run away.</para> +</listitem> +<listitem> +<para>Try to get all the enemies running together in one group. That +way you will not get surrounded and you can do such fun things as +collect gold while they run along behind you.</para> +</listitem> +<listitem> +<para>Sometimes you can kill an enemy with two holes, but it often +takes three to nine holes to kill one to five enemies.</para> +</listitem> +<listitem> +<para>It is possible to kill an enemy with one hole if he is far +enough away when you dig it.</para> +</listitem> +<listitem> +<para>In the <quote>Traditional</quote> game, you can trap an enemy +permanently in a pit of brick or concrete. Stand near the edge of the +pit on the opposite side to the enemy. As he approaches the pit, move +down one square (to the level of the floor of the pit) and the enemy +will usually run into the pit.</para> +</listitem> +<listitem> +<para>In some levels in the <quote>Traditional</quote> game, you can +force an enemy to climb a ladder ahead of you if you stand somewhere +above the bottom of the ladder.</para> +</listitem> +</itemizedlist> + +</sect1> + +<sect1 id="hints-digging-puzzles"> +<title>Digging Puzzles</title> + +<itemizedlist> +<listitem> +<para>To dig through more than one layer of bricks, start by digging +as many bricks as there are layers, jump in, dig one brick less and so +on.</para> +</listitem> +<listitem> +<para>If you dig next to a ladder or a succession of bars, you can dig +down through any number of layers and up to five or six bricks +horizontally. Just return to the ladder or bars after digging each +layer, then move down one square, run out and dig the next +layer.</para> +</listitem> +<listitem> +<para>If a digging puzzle looks impossible, consider that there might +be some false bricks in it. Maybe the bottom layer is false or maybe +you can stand in a false brick and dig next to it.</para> +</listitem> +<listitem> +<para>Think about the order in which you will collect the gold. If you +pick the right order, the digging might be easier.</para> +</listitem> +<listitem> +<para>Some levels require you to dig away a brick walll, run in, +collect some gold and run out again before the bricks close up and +trap you.</para> +</listitem> +</itemizedlist> + +</sect1> + +<sect1 id="hints-tricks-with-gold"> +<title>Tricks with Gold</title> + +<itemizedlist> +<listitem> +<para>If you cannot get to a piece of gold, think about getting an +enemy to go there and get it. Even think about using an enemy's head +as a bridge to get across a pit or precipice.</para> +</listitem> +<listitem> +<para>In some levels there is a nugget that must be collected last of +all, because you will need the hidden ladders to get away from that +position.</para> +</listitem> +<listitem> +<para>In some situations an enemy can be killed without giving up the +gold he is carrying. The gold becomes a <quote>lost +nugget</quote>. You score no points for making an enemy lose a nugget, +but at least you can finish the level.</para> +</listitem> +<listitem> +<para>If there is nowhere to dig, keep the enemies running over +concrete and the tops of ladders and so make them release their gold +at random.</para> +</listitem> +</itemizedlist> + +</sect1> + +<sect1 id="hints-solving-difficult-levels"> +<title>Solving Difficult Levels</title> + +<itemizedlist> +<listitem> +<para>Try changing the speed settings to Beginner or even +lower.</para> +</listitem> +<listitem> +<para>Use the Editor feature to <quote>peek</quote> at where the false +bricks and hidden ladders are.</para> +</listitem> +<listitem> +<para>Use the Editor feature to save the level in one of your own +games, then you can edit it so that you do not always have to start at +the beginning when you die. This allows you to develop the solution in +easier stages.</para> +</listitem> +<listitem> +<para>In digging puzzles, look for false bricks you can fall into and +thus have one less brick to dig. Or consider using an enemy to go +ahead of you, so that you can stand on his head and dig.</para> +</listitem> +<listitem> +<para>Look for a theme or trick in the level, such as riding down on +an enemy's head, trapping all the enemies in a pit, luring the enemies +to a corner where they will stay and not chase you, luring the enemies +into pits you must cross to get to some gold, getting the enemies to +fetch gold for you or finding spots where you can stand and make an +enemy move to where you want him.</para> +</listitem> +</itemizedlist> +</sect1> + +<!-- This is the place for a FAQ section, if required. +<sect1 id="hints-faq"> +<title>FAQ</title> + +<qandaset id="faq"> + +<qandaentry> +<question> +<para>Question 1</para> +</question> +<answer> +<para>The answer</para> +</answer> +</qandaentry> + +</qandaset> +</sect1> +--> + +</chapter> + +<chapter id="credits-and-licenses"> +<title>Credits and Licenses</title> + +<para>&kgoldrunner; copyright 2003 Ian Wadham and Marco Krüger.</para> + +<para>&kgoldrunner; is inspired by an early computer game called +<trademark>Lode Runner</trademark> which was written in the USA +by <trademark class="copyright">Doug Smith</trademark> and first released +in 1983 by <trademark class="copyright">Broderbund Software</trademark>. It +appeared originally on the Apple II and Commodore 64 computers, which was +where the Wadham family and Marco Krüger got hooked. It was a major +best-seller in its day and is one of the all-time great computer games.</para> + +<para>You can find out more about <trademark>Lode Runner</trademark> and +the various versions that have come out since 1983, on the +website <ulink url="http://entropymine.com/jason/lr">Jason's Lode Runner +Archive</ulink> (http://entropymine.com/jason/lr/). +That site also has the story of the game's original development, in the file +<ulink url="http://entropymine.com/jason/lr/misc/ldhist.html"> +misc/ldhist.html</ulink>.</para> + +<para>&kgoldrunner; is an attempt to preserve the spirit of the original +classic game on a platform that will be portable and will last more than +a few years. It is available as free software in source code form. Copies +of the original game are unobtainable now and the machines it ran on are +going into museums.</para> + +<para>Marco Krüger developed &kgoldrunner; as far as v0.3, out of +nostalgia for the original Commodore 64 game. Ian Wadham added +several features and levels and created the current version. Ian's +elder son Peter composed the 100 levels in the "Initiation" game and +the 20 tricky levels in "Vengeance of Peter W". The other levels +were composed by Ian, Peter, Marco Krüger and friends and Ian's other +children, Simon and Genevieve.</para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> +&underFDL; +&underGPL; + +</chapter> + +<appendix id="installation"> +<title>Installation</title> + +<sect1 id="how-to-obtain-kgoldrunner"> +<title>How to Obtain &kgoldrunner;</title> +&install.intro.documentation; +</sect1> + +<sect1 id="compilation-and-installation"> +<title>Compilation and Installation</title> +&install.compile.documentation; +</sect1> + +</appendix> + +<appendix id="porting-kgoldrunner"> +<title>Porting &kgoldrunner; to Other Platforms</title> + +<para>&kgoldrunner; is written in C++, using &Linux; and the free-software +version of the portable &Qt; object and &GUI; library. The current version +can be compiled and run either with &kde; 3 and &Qt; 3 or with &Qt; 3 alone.</para> + +<para>The &Qt;-only version of &kgoldrunner; is intended to be almost +independent of &Linux; and the &kde; desktop. That means it should be +fairly easy to port to other operating systems, such as &Windows; +and Macintosh, because the &Qt; library and C++ language are portable +to other operating systems and the &kgoldrunner; source code is +available as free software.</para> + +<para>If you would like to port &kgoldrunner;, please email +Ian Wadham at <emphasis>ianw@netspace.net.au</emphasis>, to obtain +the latest version of the &Qt;-only code and the Technical Details +document. Of course, you must have your own C++ development +setup on your target machine. Also, the &Qt; library is +<emphasis>not</emphasis> free software on &Windows; and Macintosh, +so you will need to have access to a system with a paid +&Qt; Development licence.</para> + +</appendix> + +</book> + +<!-- +Local Variables: +mode: sgml +sgml-omittag: nil +sgml-shorttag: t +sgml-general-insert-case: lower +End: +--> diff --git a/doc/kgoldrunner/kgoldrunner.png b/doc/kgoldrunner/kgoldrunner.png Binary files differnew file mode 100644 index 00000000..23429eb4 --- /dev/null +++ b/doc/kgoldrunner/kgoldrunner.png diff --git a/doc/kgoldrunner/level010.png b/doc/kgoldrunner/level010.png Binary files differnew file mode 100644 index 00000000..06126f83 --- /dev/null +++ b/doc/kgoldrunner/level010.png diff --git a/doc/kgoldrunner/select.png b/doc/kgoldrunner/select.png Binary files differnew file mode 100644 index 00000000..b2c50766 --- /dev/null +++ b/doc/kgoldrunner/select.png diff --git a/doc/kgoldrunner/tute008.png b/doc/kgoldrunner/tute008.png Binary files differnew file mode 100644 index 00000000..ee5b5c8b --- /dev/null +++ b/doc/kgoldrunner/tute008.png diff --git a/doc/kjumpingcube/Makefile.am b/doc/kjumpingcube/Makefile.am new file mode 100644 index 00000000..368fc0da --- /dev/null +++ b/doc/kjumpingcube/Makefile.am @@ -0,0 +1,4 @@ + +KDE_DOCS = AUTO +KDE_LANG = en + diff --git a/doc/kjumpingcube/index.docbook b/doc/kjumpingcube/index.docbook new file mode 100644 index 00000000..55810a5a --- /dev/null +++ b/doc/kjumpingcube/index.docbook @@ -0,0 +1,368 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY kappname "&kjumpingcube;"> + <!ENTITY package "kdegames"> + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE" > <!-- change language only here --> +]> +<book lang="&language;"> + +<bookinfo> +<title>The &kjumpingcube; Handbook</title> + +<authorgroup> +<author> +<firstname>Matthias</firstname> +<surname>Kiefer</surname> +<affiliation> +<address>&Matthias.Kiefer.mail;</address> +</affiliation> +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<copyright> +<year>1999</year> +<year>2000</year> +<holder>&Matthias.Kiefer;</holder> +</copyright> + + +<legalnotice>&FDLNotice;</legalnotice> + +<date>2005-12-10</date> +<releaseinfo>1.1</releaseinfo> + +<abstract><para>&kjumpingcube; is a simple tactical game you can play against a friend +or the computer.</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KJumpingCube</keyword> +<keyword>kdegames</keyword> +<keyword>game</keyword> +<keyword>strategy</keyword> +</keywordset> + +</bookinfo> + + +<chapter id="introduction"> +<title>Introduction</title> + +<para>&kjumpingcube; is a simple tactical game. You can play it against the computer +or against a friend. The playing field consists of squares that contains +points. By clicking on the squares you can increase the points, and if the +points reach a maximum the points will jump to the squares neighbors and take +them over. The winner is the one who owns all squares.</para> + +</chapter> + + +<chapter id="playing-kjumpingcube"> +<title>Playing &kjumpingcube;</title> + +<sect1 id="rules"> +<title>Rules</title> + +<orderedlist> +<listitem><para>A move consists of increasing the points of a square by clicking +on it. You can only increase a square that doesn't belong to your opponent. By +clicking a square that has no owner, you become the owner. </para></listitem> +<listitem><para>If a square has more points than it has neighbors, the points +jump to its neighbors and take them over. </para></listitem> +<listitem><para>Neighbor-Fields are only direct neighbors, not the diagonal +neighbors.</para></listitem> +<listitem><para>The winner is the one who owns all squares.</para></listitem> +</orderedlist> + +</sect1> + +</chapter> + +<chapter id="menu-reference"> +<title>Command Reference</title> + +<sect1 id="menus"> +<title>The Menu Bar</title> + +<sect2 id="game-menu"> +<title>The <guimenu>Game</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term> +<menuchoice> +<shortcut><keycombo +action="simul">&Ctrl;<keycap>N</keycap></keycombo></shortcut> +<guimenu>Game</guimenu><guimenuitem>New</guimenuitem></menuchoice> +</term> +<listitem><para><action>Start a new game.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut><keycombo +action="simul">&Ctrl;<keycap>O</keycap></keycombo></shortcut> +<guimenu>Game</guimenu><guimenuitem>Load...</guimenuitem></menuchoice> +</term> +<listitem><para><action>Open a previously saved game.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut><keycombo +action="simul">&Ctrl;<keycap>S</keycap></keycombo></shortcut> +<guimenu>Game</guimenu><guimenuitem>Save</guimenuitem></menuchoice> +</term> +<listitem><para><action>Save the current game.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Game</guimenu><guimenuitem>Save As...</guimenuitem> +</menuchoice> +</term> +<listitem><para><action>Save the current game with a different +name.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut><keycap>Escape</keycap></shortcut> +<guimenu>Game</guimenu><guimenuitem>Stop Thinking</guimenuitem></menuchoice></term> +<listitem><para><action>Stop the computer opponent thinking about its next +move.</action> The computer opponent will then make the best move it has found +up to the moment you told it to stop.</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><action>Quits</action> &kjumpingcube;.</para></listitem> +</varlistentry> +</variablelist> + +</sect2> + +<sect2 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"> +<keycap>H</keycap></keycombo></shortcut> +<guimenu>Move</guimenu><guimenuitem>Hint</guimenuitem></menuchoice></term> +<listitem><para><action>Get a hint as to the best next +move.</action></para></listitem> +</varlistentry> + +</variablelist> + +</sect2> + +<sect2 id="settings-menu"> +<title>The <guimenu>Settings</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice><guimenu>Settings</guimenu><guimenuitem>Show +Toolbar</guimenuitem></menuchoice></term> +<listitem><para><action>Toggle the display of the toolbar.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenu>Settings</guimenu><guimenuitem>Show + Statusbar</guimenuitem></menuchoice></term> +<listitem><para><action>Toggle the display of the statusbar.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure Shortcuts...</guimenuitem></menuchoice></term> +<listitem><para><action>Open a dialog where you can configure the +shortcuts</action> for &kjumpingcube;</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure Toolbars...</guimenuitem></menuchoice></term> +<listitem><para><action>Open a dialog where you can configure the toolbars</action> for &kjumpingcube;</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenu>Settings</guimenu> +<guimenuitem>Configure &kjumpingcube;...</guimenuitem></menuchoice> +</term> +<listitem> +<para>Open a dialog where you can configure the following items:</para> + +<variablelist> +<varlistentry> +<term><guilabel>Computer Skill</guilabel></term> +<listitem><para><action>Lets you choose your playing skill from a +slider.</action> This decides how clever your computer opponent is, if you are +playing against the computer.</para> +<para>You can choose from:</para> +<simplelist> +<member><guimenuitem>Beginner</guimenuitem></member> +<member><guimenuitem>Average</guimenuitem></member> +<member><guimenuitem>Expert</guimenuitem></member> +</simplelist></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Board Size</guilabel></term> +<listitem><para><action>Lets you choose the playfield +sizes.</action></para> +<para>Use the slider to select a value between +<guilabel>5x5</guilabel> squares and <guilabel>10x10</guilabel> +squares in size.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Computer Plays As</guilabel></term> +<listitem><para>Sets the computer opponent to be <guilabel>Player +1</guilabel>, <guilabel>Player 2</guilabel> or both. Normally you +would set the computer to play one player, and you would play the +other. Player 1 always starts first.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Board Color</guilabel></term> +<listitem><para>Choose a color for each player</para></listitem> +</varlistentry> +</variablelist> +</listitem> +</varlistentry> + +</variablelist> +</sect2> + +<sect2 id="help-menu"> +<title>The <guimenu>Help</guimenu> Menu</title> + +&help.menu.documentation; + +</sect2> +</sect1> + +<sect1 id="toolbars"> +<title>The &kjumpingcube; Toolbar</title> + +<variablelist> +<varlistentry> +<term><guiicon>New</guiicon></term> +<listitem><para><action>Starts a new game</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><guiicon>Save</guiicon></term> +<listitem><para><action>Save the current game.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><guiicon>Stop Thinking</guiicon></term> +<listitem><para><action>Stop the computer opponent thinking about it's next +move.</action> The computer opponent will then make the best move it has found +up to the moment you told it to stop.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guiicon>Undo</guiicon></term> +<listitem><para><action>Undo the last move you made.</action></para></listitem> +</varlistentry> +</variablelist> + +</sect1> + +</chapter> + +<chapter id="questions-answers-tips"> +<title>Questions, Answers, and Tips</title> + +<sect1 id="strategy-tips"> +<title>Strategy tips</title> + +<itemizedlist> +<listitem><para>Try to avoid increasing a square when your opponent owns a +neighbor square, that reaches its maximum earlier than your +square.</para></listitem> +</itemizedlist> + +</sect1> + +</chapter> + +<chapter id="credits"> +<title>Credits and License</title> + +<para>&kjumpingcube; is Copyright 1998,1999 &Matthias.Kiefer; +&Matthias.Kiefer.mail;</para> + +<para>&kjumpingcube; was inspired by a game that came out for the Commodore64 and for +other home computers, too. Sorry, that I don't know the original author's +name.</para> + +<para>Documentation Copyright 1999 &Matthias.Kiefer; +&Matthias.Kiefer.mail;</para> + +<para>Documentation updated for &kde; 2 and 3 by &Lauri.Watts; +&Lauri.Watts.mail;</para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +&underFDL; +&underGPL; + +</chapter> + +<appendix id="installation"> +<title>Installation</title> + +<sect1 id="getting-kjumpingcube"> +<title>How to obtain &kjumpingcube;</title> + +&install.intro.documentation; + +</sect1> + +<sect1 id="requirements"> +<title>Requirements</title> + +<para>In order to successfully compile &kjumpingcube;, you need &kde; 2.0. +All required libraries as well as &kjumpingcube; itself can be found on +&kde-ftp;. +</para> + +</sect1> + +<sect1 id="compilation"> +<title>Compilation and Installation</title> + +&install.compile.documentation; + +<para>That should do it! Should you run into any problems, please report them +to the author, at &Matthias.Kiefer.mail;</para> + +</sect1> +</appendix> + +</book> +<!-- +Local Variables: +mode: sgml +sgml-omittag: nil +sgml-shorttag: t +End: +--> + diff --git a/doc/klickety/Makefile.am b/doc/klickety/Makefile.am new file mode 100644 index 00000000..085981d9 --- /dev/null +++ b/doc/klickety/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/klickety/index.docbook b/doc/klickety/index.docbook new file mode 100644 index 00000000..b38f81c6 --- /dev/null +++ b/doc/klickety/index.docbook @@ -0,0 +1,425 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ +<!ENTITY % imageobjectco.module "INCLUDE"> + <!ENTITY klickety "<application>Klickety</application>"> + <!ENTITY kappname "&klickety;"> + <!ENTITY package "kdegames"> + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE"> +]> + +<book lang="&language;"> + +<bookinfo> +<title>The &klickety; Handbook</title> + +<authorgroup> +<author> +<personname> +<firstname>Thomas</firstname> +<surname>Davey</surname> +</personname> +<email>thomas.davey@gmail.com</email> +</author> +<othercredit role="reviewer"> +&Philip.Rodrigues; +&Philip.Rodrigues.mail; +</othercredit> +</authorgroup> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> + +<copyright> +<year>2005</year> +<holder>Thomas Davey</holder> +</copyright> +<legalnotice>&FDLNotice;</legalnotice> + +<date>2006-01-21</date> +<releaseinfo>3.5</releaseinfo> + +<abstract> +<para> +&klickety; is a strategy game for &kde;, an adaption of the <application>Clickomania</application> game. +</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>kdegames</keyword> +</keywordset> + +</bookinfo> + + +<chapter id="introduction"> +<title>Introduction</title> + +<para>The objective of &klickety; is to clear the game board of all +the colored blocks in the least possible time (although having a short time is +only a secondary objective). The overall aim is to get the lowest score +possible. It will provide entertainment for all abilities, but a +challenge in logical thought if you want to get a really low score.</para> + +</chapter> + +<chapter id="the-game-screen"> +<title>The Game Screen</title> + +<screenshot> +<mediaobjectco> +<imageobjectco> +<areaspec units="calspair"> +<area id="play-game" coords="1 1"/> +<area id="game-board" coords="1 1"/> +<area id="game-timer" coords="1 1"/> +<area id="block-counter" coords="1 1"/> +</areaspec> +<imageobject> +<imagedata fileref="screenshot.png" format="PNG"/> +</imageobject> +</imageobjectco> +</mediaobjectco> +</screenshot> + +<calloutlist> +<callout arearefs="play-game"> +<para>This is a colored block, you click on these to play the game.</para> +</callout> + +<callout arearefs="game-board"> +<para>This is what was referred to in the introduction as the <quote>game +board</quote>, this is where the game actually takes place.</para> +</callout> + +<callout arearefs="game-timer"> + +<para>This is the game timer, it starts the first time that you click on a +removable block.</para> +</callout> + +<callout arearefs="block-counter"> + +<para>This the remaining block counter, which also doubles up the score +counter. It is usually black at the start of a game, it changes to +blue if the score is good enough to get onto your local highscore +table, and red if it would make the top spot. +</para> +</callout> +</calloutlist> +</chapter> + +<chapter id="playing-the-game"> +<title>Playing the game</title> + +<para>When you start the program you will get a screen that looks +something like the screenshot in the previous section. The idea of the +game is to remove blocks, which you do by clicking on them.</para> + +<para>However, you can only remove a block if it is adjacent to one or +more other blocks of the same color on one or more of its +sides. Diagonal connections do not count. You get a random board every +time you start a new game.</para> + +<para>If you click on a block which is connected as described, it will +disappear. Any adjacent blocks of the same color will also disappear, +along with all of the same color adjacent to <emphasis>them</emphasis>, and so +on. Any blocks above them drop down to fill the gaps left by the +disappeared pieces. If you clear an entire column, all the columns to +the right move across to fill the gap.</para> + + +<para>The game ends when there are no blocks adjacent to other blocks +of the same colour</para> +</chapter> + +<chapter id="scoring"> +<title>Scoring</title> + +<para>Scoring is very simple. Your score is the number of remaining +blocks when the game ends. In the case of having two high scores of +the same score, the one completed in the shortest time is listed in +the higher position.</para> +</chapter> + + +<chapter id="menu-reference"> +<title>Menu Reference</title> + +<sect1 id="the-game-menu"> +<title>The <guimenu>Game</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice><guimenu>Game</guimenu><guimenuitem>New Game</guimenuitem> +</menuchoice> (<keycombo action="simul">&Ctrl;<keycap>N</keycap> +</keycombo>)</term> +<listitem><para>Starts a new game before the previous one has finished +(once you end a game, a button appears on the game board labeled +'start' which does the same thing).</para> +</listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice><guimenu>Game</guimenu><guimenuitem>Pause</guimenuitem> +</menuchoice> (<keycombo><keycap>P</keycap> +</keycombo>)</term> +<listitem><para>Not yet implemented.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenu>Game</guimenu><guimenuitem>Show +Highscores</guimenuitem> </menuchoice> (<keycombo +action="simul">&Ctrl;<keycap>H</keycap> </keycombo>)</term> + +<listitem><para>Shows the Highscore Table for checking a target or for +bragging purposes. (This is the same highscore table as is displayed +if you get a new highscore at the end of a game.) There are also tabs +for seeing all the players who have turned in scores and for looking +at some statistical analysis of the performance of individual +players. There are also links to the worldwide highscore and player +lists on the web.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenu>Game</guimenu><guimenuitem>Quit</guimenuitem> </menuchoice> (<keycombo +action="simul">&Ctrl;<keycap>Q</keycap> </keycombo>)</term> + +<listitem><para>Ends the program.</para> +</listitem> +</varlistentry> + +</variablelist> +</sect1> + +<sect1 id="the-view-menu"> +<title>The <guimenu>View</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice><guimenu>View</guimenu><guimenuitem>Zoom In</guimenuitem> +</menuchoice> (<keycombo action="simul">&Ctrl;<keycap>+</keycap> +</keycombo>)</term> + +<listitem><para>Zooms the game board in, increases the window size as +necessary.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenu>View</guimenu><guimenuitem>Zoom Out</guimenuitem> +</menuchoice> (<keycombo action="simul">&Ctrl;<keycap>-</keycap> +</keycombo>)</term> +<listitem><para>Zooms the game board out. Window size will decrease around it.</para> +</listitem> +</varlistentry> +</variablelist> +</sect1> + +<sect1 id="the-settings-menu"> +<title>The <guimenu>Settings</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice><guimenu>Settings</guimenu><guimenuitem>Hide Menu Bar</guimenuitem> +</menuchoice> (<keycombo action="simul">&Ctrl;<keycap>M</keycap> +</keycombo>)</term> + +<listitem><para>Hides the menu bar. It can be brought back with the +right-click menu or by pressing <keycombo +action="simul">&Ctrl;<keycap>M</keycap> </keycombo>.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure Shortcuts...</guimenuitem> +</menuchoice></term> +<listitem><para>Allows you to change the shortcut keys listed above.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure Notifications...</guimenuitem> +</menuchoice></term> + +<listitem><para>Allows you to change the notifications for <guilabel>Game +over</guilabel> and the removal of a column (listed as <guilabel>Line +removed</guilabel>), such as playing a sound when you remove a column, or +starting your favorite IRC client when you finish the game so that you +can tell all your friends about your &klickety; skills.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure Highscores...</guimenuitem> +</menuchoice></term> +<listitem><para> +Displays the highscores configuration dialog, which has two +tabs:</para> + +<para>On the <guilabel>Main</guilabel> tab, you can change the default +nickname that is entered onto the highscore table if you get a +highscore, add a comment to go with your entry on the players tab of +the highscore table. You can also activate the <guilabel>World-wide highscores +enabled</guilabel> feature so that you can compare scores with players +from around the globe. If you are connected to the +Internet, &klickety; will send your score automatically at the end of the +game to the highscore web server (klickety.sf.net).</para> + +<para>The <guilabel>Advanced</guilabel> tab displays your <guilabel>Registration Data</guilabel> +on klickety.sf.net. If worldwide highscores have been activated, +this tab shows the <guilabel>Nickname:</guilabel> from the <guilabel>Main</guilabel> +tab with which you are registered and the cryptographic <guilabel>Key:</guilabel> +used to prevent any attempts at cheating. This key was generated when you +registered on klickety.sf.net by selecting +<guilabel>World-wide highscores enabled</guilabel> the first time. +The registration key is used in conjunction with the +nickname to identify uniquely users, but users cannot have the same nickname. +Click on the <guibutton>Remove</guibutton> button to delete you from the world highscores +list.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure &klickety;...</guimenuitem> +</menuchoice></term> + +<listitem><para>Brings up the main configuration dialog, this will be +dealt with in the next chapter.</para> +</listitem> +</varlistentry> + +</variablelist> + +</sect1> + +<sect1 id="the-help-menu"> +<title>The <guimenu>Help</guimenu> Menu</title> + +&help.menu.documentation; + +</sect1> +</chapter> + +<chapter id="configuring-klickety"> +<title>Configuring &klickety;</title> + +<para>Each page of the &klickety; configuration dialog has buttons +labeled <guibutton>Help</guibutton> and +<guibutton>Defaults</guibutton>.The <guibutton>Help</guibutton> button +brings up this handbook, and the <guibutton>Defaults</guibutton> +button restores all the settings to their default values.</para> + +<para>The individual options are as follows:</para> + +<sect1 id="the-appearance-tab"> +<title>The <guilabel>Appearance</guilabel> tab</title> + +<variablelist> +<varlistentry> +<term><guilabel>Enable Animations</guilabel></term> +<listitem><para>If checked, pieces are shown with an +animation (a small rebound effect), when they touch the bottom.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Background</guilabel></term> + +<listitem><para>Allows you to change the background color and change +its opacity. Trivia: if it has some transparency it doesn't actually +show what's directly beneath &klickety;, but rather it shows the +desktop wallpaper.</para> +</listitem> +</varlistentry> + +</variablelist> + +</sect1> + +<sect1 id="the-colors-tab"> +<title>The <guimenu>Colors</guimenu> tab</title> + +<para>Colors #1 through #5 Allow you to change the colors of the +colored blocks. For an extra challenge, make them all the same +color. N.B. You must restart &klickety; for these changes to take +effect.</para> + +</sect1> +</chapter> + +<chapter id="tips"> +<title>Tips</title> + +<itemizedlist> +<listitem><para>Try to remove sets of two blocks to allow single blocks to join +up with other ones of the same color, it's your only way to get rid of +them.</para></listitem> + +<listitem><para>Spend time thinking about your move: you primarily get higher places on the highscore table by getting rid of more pieces than doing it quickly.</para></listitem> + +</itemizedlist> +</chapter> + + +<chapter id="credits"> + +<title>Credits and License</title> + +<para>&klickety; Program Copyright 1995 Eirik Eng and 1996-2004 Nicolas Hadacek</para> + +<para>&klickety; is based on clickomania.</para> + +<para>The &klickety; website can be found at <ulink +url="http://klickety.sourceforge.net">http://klickety.sourceforge.net</ulink>.</para> + +<para>First version of documentation by Thomas Davey, Copyright 2005.</para> + +<para>Reviewed by &Philip.Rodrigues; &Philip.Rodrigues.mail;.</para> + +<para>Further markup and reviewing by &Francis.Giannaros; +&Francis.Giannaros.mail;.</para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +&underFDL; + +&underGPL; + +</chapter> + +<appendix id="installation"> +<title>Installation</title> + +<sect1 id="getting-kapp"> +<title>How to obtain &klickety;</title> + +&install.intro.documentation; + +</sect1> + +<sect1 id="compilation"> +<title>Compilation and Installation</title> + +&install.compile.documentation; + +</sect1> + +</appendix> + +&documentation.index; +</book> + +<!-- +Local Variables: +mode: xml +sgml-minimize-attributes:nil +sgml-general-insert-case:lower +sgml-indent-step:0 +sgml-indent-data:nil +End: + +--> diff --git a/doc/klickety/screenshot.png b/doc/klickety/screenshot.png Binary files differnew file mode 100644 index 00000000..c59d09f9 --- /dev/null +++ b/doc/klickety/screenshot.png diff --git a/doc/klines/Makefile.am b/doc/klines/Makefile.am new file mode 100644 index 00000000..8c761fb4 --- /dev/null +++ b/doc/klines/Makefile.am @@ -0,0 +1,5 @@ + +KDE_LANG = en +KDE_DOCS = klines + + diff --git a/doc/klines/index.docbook b/doc/klines/index.docbook new file mode 100644 index 00000000..d86d25bf --- /dev/null +++ b/doc/klines/index.docbook @@ -0,0 +1,328 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY kappname "&kolorlines;"> + <!ENTITY package "kdegames"> + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE"> +]> + +<book lang="&language;"> + +<bookinfo> +<title>The &kolorlines; Handbook</title> + +<authorgroup> +<author> +<firstname>Roman</firstname> +<surname>Razilov</surname> +<affiliation> +<address><email>Roman.Razilov@gmx.de</email></address> +</affiliation> +</author> +<author> +<firstname>Roman</firstname> +<surname>Merzlyakov</surname> +<affiliation> +<address><email>roman@sbrf.barrt.ru</email></address> +</affiliation> +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> + +</authorgroup> + +<copyright> +<year>2000</year> +<year>2001</year> +<holder>Roman Razilov,</holder> +<holder>Roman Merzlyakov</holder> +</copyright> +<legalnotice>&FDLNotice;</legalnotice> + +<date>2001-05-20</date> +<releaseinfo>1.00.00</releaseinfo> + +<abstract><para>&kolorlines; is a nice little game meant to amuse you for +anywhere from 3 minutes to 6 days(straight).</para></abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>kdegames</keyword> +<keyword>klines</keyword> +</keywordset> + +</bookinfo> + +<chapter id="introduction"> +<title>Introduction</title> + +<para>&kolorlines; is a simple game. It is played by one player, so there is +only one winner :-) You play for fun and against the high score. It has +been inspired by well known game - <application>Color +lines</application>, written for DOS by Olga Demina, Igor Ivkin and +Gennady Denisov back at 1992.</para> + +<para>In 2000 Roman Merzlyakov wrote a original version for &kde;. Roman +Roazilov added to it a cool <application>povray</application> generated +animation. Later in 2001 he ported it to &kde; 2 and made it conform to +the &kde; games standard.</para> + +</chapter> + + +<chapter id="using-klines"> +<title>Using &kolorlines;</title> + +<para>The main rules of game is as simple as possible: you move (using +mouse) marbles from cell to cell and build lines (horizontal, vertical +or diagonal). When a line contains 5 or more marbles - they are removed +from the field and your score grows. After each of your turns computer +drops three more marbles onto the field.</para> + +<para> The increase in score depends on the amount of erased marbles +and if &kolorlines; shows the next balls. The increase will be smaller if +you use the information of what's next.</para> + +<sect1 id="klines-features"> +<title>More &kolorlines; features</title> + +<para>&kolorlines; is wonderful in that it will allow you to kill 5 minutes +while you wait for that program to compile.</para> <para>Or, if nothing +else, it will allow you to kill 5 minutes.</para> + +</sect1> +</chapter> + +<chapter id="commands"> +<title>Command Reference</title> + +<sect1 id="klines-mainwindow"> +<title>The main &kolorlines; window</title> + +<para>There is a large area with marbles. At the right side a bar +showing the next three marbles to be dropped on the field. Underneath +the field is the status bar. Above it is the menu bar.</para> + +<sect2> +<title>The <guimenu>Game</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo> +</shortcut> +<guimenu>Game</guimenu> +<guimenuitem>New game</guimenuitem> +</menuchoice></term> +<listitem><para><action>Starts a new game</action></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><action>Displays the high score table</action></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><action>Quits</action> &kolorlines;</para></listitem> +</varlistentry> +</variablelist> + +</sect2> + +<sect2> +<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>This will undo the last move.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Move</guimenu><guimenuitem>End Turn</guimenuitem></menuchoice> +</term> +<listitem> +<para>Skip your move, immediately play the next marbles without you moving +any.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut><keycap>D</keycap></shortcut> +<guimenu>Move</guimenu> +<guimenuitem>Start Tutorial</guimenuitem> +</menuchoice></term> +<listitem><para>Show a short, animated, non-interactive demonstration of how +to play the game. If the tutorial is running, the statusbar will show +<guilabel>Level: Tutorial</guilabel>, and this menu entry will now show +<guimenuitem>Stop Tutorial</guimenuitem>.</para></listitem> +</varlistentry> +</variablelist> + +</sect2> + +<sect2> +<title>The <guimenu>Settings</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Show Statusbar</guimenuitem> +</menuchoice></term> +<listitem><para><action>Toggles the display of the statusbar.</action></para></listitem> +</varlistentry> +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>P</keycap></keycombo> +</shortcut> +<guimenu>Settings</guimenu> +<guimenuitem>Show Next</guimenuitem> +</menuchoice></term> +<listitem><para><action>Toggles the information on next +marbles.</action></para></listitem> +</varlistentry> +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu><guimenuitem>Use Numbered Balls</guimenuitem> +</menuchoice></term> +<listitem> +<para>Number the balls according to color. This may be of assistance to +players who are color blind, have other vision impairments that make the +colors hard to distinguish, or those of you who simply like the look.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><menuchoice><guimenu>Settings</guimenu><guisubmenu>Choose Game +Type</guisubmenu></menuchoice></term> +<listitem> +<para>Choose a difficulty level, from <guimenuitem>Very Easy</guimenuitem> +through <guimenuitem>Very Hard</guimenuitem>.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure +Shortcuts</guimenuitem></menuchoice></term> +<listitem> +<para>Displays a standard &kde; shortcut configuration dialog, allowing you +to customize the keys used in the game.</para></listitem> +</varlistentry> +</variablelist> +</sect2> + +<sect2> +<title>The <guimenu>Help</guimenu> Menu</title> + +&help.menu.documentation; + +</sect2> +</sect1> + +</chapter> + +<chapter id="credits"> + +<title>Credits and License</title> + +<para>&kolorlines;</para> + +<para>Program copyright 2000 Roman Merzlyakov +<email>roman@sbrf.barrt.ru</email></para> +<para>Contributors:</para> +<itemizedlist> +<listitem><para>Roman Razilov <email>Roman.Razilov@gmx.de</email> +Redesign, Graphik, animation, partial re-write. Special thanks to my wife Larissa Juschkin for +testing and discussions.</para> +</listitem> + +</itemizedlist> + +<para>Documentation copyright 2001 Roman Razilov +<email>Roman.Razilov@gmx.de</email></para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +&underFDL; <!-- FDL: do not remove --> + + +&underGPL; <!-- GPL License --> + +</chapter> + +<appendix id="installation"> +<title>Installation</title> + +<sect1 id="getting-klines"> +<title>How to obtain &kolorlines;</title> + +&install.intro.documentation; + +</sect1> + +<sect1 id="compilation"> +<title>Compilation and Installation</title> + +&install.compile.documentation; + +</sect1> + +<sect1 id="customize"> +<title>Generating marbles with <application>Povray</application></title> + +<para>All pictures (<filename>klines/*.jpg</filename>) are +rendered with <application>Povray</application> 3.0 and manipulated +with <application>ImageMagick</application>. +Povray & bash scripts are in the folder <filename class="directory">>klines/povray</filename>. +Customize <filename>balls.pov</filename> as you want, +render and install it.</para> + +<note><para>You need Povray 3.0 to render. In newer Versions &ie; 3.1 +<quote>halo</quote> is suppressed. </para></note> + +<para>In order to generate marbles on your system, type the following +in the base folder of the &package; distribution:</para> + +<screen width="40"> + +<prompt>%</prompt> <userinput><command>cd</command> klines</userinput> +<prompt>%</prompt> <userinput><command>make</command> install</userinput> +</screen> + +</sect1> + +</appendix> + +&documentation.index; + +</book> +<!-- +Local Variables: +sgml-minimize-attributes: nil +sgml-general-insert-case: lower +End: +--> + diff --git a/doc/kmahjongg/Makefile.am b/doc/kmahjongg/Makefile.am new file mode 100644 index 00000000..085981d9 --- /dev/null +++ b/doc/kmahjongg/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/kmahjongg/background.png b/doc/kmahjongg/background.png Binary files differnew file mode 100644 index 00000000..f4ba2700 --- /dev/null +++ b/doc/kmahjongg/background.png diff --git a/doc/kmahjongg/boardeditor.png b/doc/kmahjongg/boardeditor.png Binary files differnew file mode 100644 index 00000000..bd146782 --- /dev/null +++ b/doc/kmahjongg/boardeditor.png diff --git a/doc/kmahjongg/config.png b/doc/kmahjongg/config.png Binary files differnew file mode 100644 index 00000000..d6923171 --- /dev/null +++ b/doc/kmahjongg/config.png diff --git a/doc/kmahjongg/gamescreen.png b/doc/kmahjongg/gamescreen.png Binary files differnew file mode 100644 index 00000000..22d6c603 --- /dev/null +++ b/doc/kmahjongg/gamescreen.png diff --git a/doc/kmahjongg/highscore.png b/doc/kmahjongg/highscore.png Binary files differnew file mode 100644 index 00000000..4d5667d2 --- /dev/null +++ b/doc/kmahjongg/highscore.png diff --git a/doc/kmahjongg/index.docbook b/doc/kmahjongg/index.docbook new file mode 100644 index 00000000..37173b49 --- /dev/null +++ b/doc/kmahjongg/index.docbook @@ -0,0 +1,1012 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!-- Define an entity for your application if it is not part of KDE + CVS --> + <!ENTITY kappname "&kmahjongg;"> + <!ENTITY package "kdegames"> + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE"> + + <!ENTITY John.Hayes '<personname><firstname>John</firstname><surname>Hayes</surname></personname>'> + <!ENTITY John.Hayes.mail '<email>justlinux@bellsouth.net</email>'> + + <!ENTITY Mathias.Mueller '<personname><firstname>Mathias</firstname><surname>Mueller</surname></personname>'> + <!ENTITY Mathias.Mueller.mail '<email>in5y158@public.uni-hamburg.de</email>'> + <!ENTITY Albert.Astals.Cid '<personname><firstname>Albert</firstname><othername>Astals</othername><surname>Cid</surname></personname>'> + <!ENTITY Albert.Astals.Cid.mail '<email>astals11@terra.es</email>'> + <!ENTITY David.Black '<personname><firstname>David</firstname><surname>Black</surname></personname>'> + <!ENTITY David.Black.mail '<email>david.black@lutris.com</email>'> + <!ENTITY Michael.Haertjens '<personname><firstname>Michael</firstname><surname>Haertjens</surname></personname>'> + <!ENTITY Michael.Haertjens.mail '<email>mhaertjens@modusoperandi.com</email>'> + <!ENTITY Osvaldo.Stark '<personname><firstname>Osvaldo</firstname><surname>Stark</surname></personname>'> + <!ENTITY Osvaldo.Stark.mail '<email>starko@dnet.it</email>'> + <!ENTITY Benjamin.Meyer '<personname><firstname>Benjamin</firstname><surname>Meyer</surname></personname>'> + <!ENTITY Benjamin.Meyer.mail '<email>ben+kmahjongg@meyerhome.net</email>'> + +]> + + +<book lang="&language;"> + +<bookinfo> +<title>The &kmahjongg; Handbook</title> + +<authorgroup> +<author> +&John.Hayes; +&John.Hayes.mail; +</author> + +<othercredit role="developer"> +&Mathias.Mueller; &Mathias.Mueller.mail; +</othercredit> + +<othercredit role="developer"> +&Albert.Astals.Cid; &Albert.Astals.Cid.mail; +</othercredit> + +<othercredit role="developer"> +&David.Black; &David.Black.mail; +</othercredit> + +<othercredit role="developer"> +&Michael.Haertjens; &Michael.Haertjens.mail; +</othercredit> + +<othercredit role="developer"> +&Osvaldo.Stark; &Osvaldo.Stark.mail; +</othercredit> + +<othercredit role="developer"> +&Benjamin.Meyer; &Benjamin.Meyer.mail; +</othercredit> + +</authorgroup> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> + +<copyright> +<year>2005</year> +<holder>John Hayes</holder> +</copyright> + +<legalnotice>&FDLNotice;</legalnotice> + +<date>2006-01-23</date> +<releaseinfo>0.7.6</releaseinfo> + + +<abstract> +<para> +&kmahjongg; is a game similar to famous oriental game <trademark>Mahjongg</trademark>. +</para> +</abstract> + + +<keywordset> +<keyword>KDE</keyword> +<keyword>kdegames</keyword> +<keyword>KMahjongg</keyword> +<keyword>Mahjongg</keyword> +</keywordset> + +</bookinfo> + +<chapter id="introduction"> +<title>Introduction</title> + +<para> +&kmahjongg; is a game similar to the famous oriental game <trademark>Mahjongg</trademark>. The purpose of the game +is to remove all of the tiles from the gameboard. Tiles are removed by matching tiles in +pairs. The matched tiles must have a free side on the left or on the right. Please report +any problems or feature requests to the &kde; mailing lists. +</para> +</chapter> + +<chapter id="gameplay"> +<title>Gameplay</title> + +<!-- This chapter should tell the user how to use your app. You should use as +many sections (Chapter, Sect1, Sect3, etc...) as is necessary to fully document +your application. --> + +<sect1 id="start-new-game"> +<title>Starting a New Game</title> + +<para>When &kmahjongg; is started, the board is setup and the game timer is started, waiting +for your first move. A new game can be started from selecting +<menuchoice> +<guimenu>Game</guimenu><guimenuitem>New</guimenuitem> + +</menuchoice> or pressing +<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo> +. +</para> + +<para> +There is also the option of starting a specific number games. All of the games are numbered and they are randomly selected from +<menuchoice> +<guimenu>Game</guimenu><guimenuitem>New</guimenuitem> + +</menuchoice>. + +A specific number game can be started by selecting +<menuchoice> +<guimenu>Game</guimenu><guimenuitem>New Numbered Game</guimenuitem> +</menuchoice> +</para> + +</sect1> + +<sect1 id="aim-of-game"> +<title>Aim of the Game</title> + +<para>The purpose of the game is to remove all of the tiles from the gameboard. Tiles are +removed by matching tiles in pairs, which then disappear. The matched tiles must have a +free side on the left or on the right. +</para> + +</sect1> + +<sect1 id="playing-the-game"> +<title>Playing the Game</title> + +<para> +Locate and select with the mouse, matching tiles that have a free side on the left or right side. +The tiles disappear as they are selected and matched. +</para> + +<para> +There are two options to help find matching tiles that have a free side. +One option is to get a hint by selecting +<menuchoice> +<guimenu>Move</guimenu><guimenuitem>Hint</guimenuitem> + +</menuchoice> or pressing <keycap>H</keycap> +which will flash a pair of matching tiles. +The second option is to activate +<menuchoice> +<guimenu>Settings</guimenu><guimenuitem>Show Matching Tiles</guimenuitem> +</menuchoice>, +which will highlight the selected tile and flash any matching tiles that have a free side +with each move. No additional tiles will be highlighted if there are no matching tiles with a free side. +</para> + +</sect1> + +<sect1 id="game-screen"> +<title>The Game Screen</title> + +<para> + +<screenshot> +<screeninfo>A screenshot of &kmahjongg;</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="gamescreen.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Screenshot</phrase> + </textobject> + </mediaobject> +</screenshot> + +A quick explanation of the parts of the game screen... +</para> + +<variablelist> + +<varlistentry> +<term>Game Screen</term> +<listitem> +<para> +The Game screen is in the center of the screen and is the largest section of the window. +The background is populated with the game tiles. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>Game Timer</term> +<listitem> +<para> +The Game Timer is located on the top right of the screen. The timer keeps track of the +elapsed time from the start of the game until the game is finished. +</para> +</listitem> + +</varlistentry> + +<varlistentry> +<term>Statusbar</term> +<listitem> +<para> +The Statusbar is located at the bottom of the screen, and contains three panes. The first +pane lists the removed/total tiles and the number of matching tiles that have free sides. +The second pane gives the sequence number of the game you are playing. In the last pane +lets the player know when the game is ready. +</para> +</listitem> +</varlistentry> + +</variablelist> + +</sect1> + +</chapter> + +<chapter id="game-configuration"> +<title>Configuration and Default Keybindings</title> + +<para>The configuration options are as follows:</para> + + +<sect1 id="configure"> +<title>Configure &kmahjongg;</title> + +<!-- +<variablelist> + +<varlistentry> +<term><menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure KMahjong...</guimenuitem></menuchoice></term> +<listitem> +<para>Opens the Configure dialog. +--> +<screenshot> +<screeninfo>Configure Dialog</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="config.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Configure Dialog</phrase> + </textobject> + </mediaobject> +</screenshot> +<!-- +</para> +</listitem> +</varlistentry> + +</variablelist> +--> + +<para><menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure &kmahjongg;...</guimenuitem></menuchoice> +opens the Configure &kmahjongg; Dialog.</para> + +<sect2 id="general-options"><title><guilabel>General</guilabel> options</title> +<variablelist> + +<varlistentry> +<term><guilabel>Show removed tiles</guilabel></term> +<listitem> +<para> +Places a grid to the right of the gameboard where matching tiles are stacked after being removed from the gameboard. +<screenshot> +<screeninfo>Here's a screenshot of &kmahjongg; showing removed tiles.</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="showremoved.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Removed tiles.</phrase> + </textobject> + </mediaobject> +</screenshot> +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Generate solvable games</guilabel></term> +<listitem> +<para> +Selects only games that can be solved when you start a new game. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Play winning animation</guilabel></term> +<listitem> +<para> +Shows a replay of all moves when you win a game. +</para> +</listitem> +</varlistentry> + +</variablelist> +</sect2> + +<sect2 id="tiles-options"><title><guilabel>Tiles</guilabel> options</title> + +<variablelist> + +<varlistentry> +<term><guilabel>Draw shadows</guilabel></term> +<listitem> +<para> +Draws shadows on the tiles to give a 3D appearance. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Use mini-tiles</guilabel></term> +<listitem> +<para> +Sets the tile size to small. +</para> +</listitem> +</varlistentry> + +</variablelist> +</sect2> + +<sect2 id="background-options"><title><guilabel>Background</guilabel> options</title> + +<variablelist> + +<varlistentry> +<term><guilabel>Scaled</guilabel></term> +<listitem> +<para> +Scales the background image. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Tiled</guilabel></term> +<listitem> +<para> +Tiles the background image. +</para> +</listitem> +</varlistentry> + +</variablelist> + +</sect2> + +</sect1> + + + +<sect1 id="default-keybindings"> +<title>Default Keybindings</title> + +<para><menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure Shortcuts...</guimenuitem></menuchoice> allows you to change the default keyboard bindings.</para> + +<screenshot> +<screeninfo>Keybindings Configure Dialog</screeninfo> + <mediaobject> + + <imageobject> + <imagedata fileref="shortcuts.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Keybindings Configure Dialog</phrase> + </textobject> + </mediaobject> +</screenshot> + +<para> +The default kebindings are as follows: +</para> + +<para> +<variablelist> + +<varlistentry> +<term><keysym>D</keysym></term> +<listitem> +<para> +Playes the game in Demo mode. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><keysym>H</keysym></term> +<listitem> +<para> +Gives you a hint by flashing two matching tiles. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><keysym>F1</keysym></term> +<listitem> +<para> +Displays this handbook. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo></term> +<listitem> +<para> +Loads a previously saved game. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo></term> +<listitem> +<para> +Starts a new game. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><keysym>P</keysym></term> +<listitem> +<para> +Pauses or resumes a game. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo></term> +<listitem> +<para> +Quits the game. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><keycombo action="simul">&Ctrl;&Shift;<keycap>Z</keycap></keycombo></term> +<listitem> +<para> +Move redo. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><keysym>F5</keysym></term> +<listitem> +<para> +Restart the game. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo></term> +<listitem> +<para> +Saves the game. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><keycombo action="simul">&Ctrl;<keycap>H</keycap></keycombo></term> +<listitem> +<para> +Show the highscores. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><keycombo action="simul">&Ctrl;<keycap>Z</keycap></keycombo></term> +<listitem> +<para> +Move undo. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><keycombo action="simul">&Shift;<keycap>F1</keycap></keycombo></term> +<listitem> +<para> +What's this? Help +</para> +</listitem> +</varlistentry> + +</variablelist> +</para> + +</sect1> + +</chapter> + +<chapter id="commands"> +<title>Command Reference</title> + +<!-- (OPTIONAL, BUT RECOMMENDED) This chapter should list all of the +application windows and their menubar and toolbar commands for easy reference. +Also include any keys that have a special function but have no equivalent in the +menus or toolbars. This may not be necessary for small apps or apps with no tool +or menu bars. --> + +<sect1 id="kapp-mainwindow"> +<title>The main &kmahjongg; window</title> + +<screenshot> +<screeninfo>A screenshot of &kmahjongg;</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="gamescreen.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Screenshot</phrase> + </textobject> + </mediaobject> +</screenshot> + +<sect2 id="game-menu"> +<title>The <guimenu>Game</guimenu> Menu</title> + +<para> + +<variablelist> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo> +</shortcut> +<guimenu>Game</guimenu> +<guimenuitem>New</guimenuitem> +</menuchoice></term> +<listitem><para><action>Starts a new game.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo> +</shortcut> +<guimenu>Game</guimenu> +<guimenuitem>Load...</guimenuitem> +</menuchoice></term> +<listitem><para><action>Loads a saved game.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keysym>F5</keysym> +</shortcut> +<guimenu>Game</guimenu> +<guimenuitem>Restart Game</guimenuitem> +</menuchoice></term> +<listitem><para><action>Restarts the numbered game being played.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Game</guimenu> +<guimenuitem>New Numbered Game...</guimenuitem> +</menuchoice></term> +<listitem><para><action>Starts a specific numbered game.</action> +<screenshot> +<screeninfo>Start a Numbered Game Dialog</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="numbered.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Start a Numbered Game Dialog</phrase> + </textobject> + </mediaobject> +</screenshot> +</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Game</guimenu> +<guimenuitem>Open Theme...</guimenuitem> +</menuchoice></term> +<listitem><para><action>Allows you to load a theme with different backgrounds and tile styles.</action> +<screenshot> +<screeninfo>Load Theme Dialog</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="theme.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Load Theme Dialog</phrase> + </textobject> + </mediaobject> +</screenshot> +</para> +<para> +The available options: +<itemizedlist> +<listitem><para>default (shown)</para></listitem> +<listitem><para>pirates</para></listitem> +</itemizedlist> +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Game</guimenu> +<guimenuitem>Open Tileset...</guimenuitem> +</menuchoice></term> +<listitem><para><action>Allows you to load a different tileset.</action> +<screenshot> +<screeninfo>Open Tileset Dialog</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="tileset.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Open Tileset Dialog</phrase> + </textobject> + </mediaobject> +</screenshot> +</para> +<para> +The available options: +<itemizedlist> +<listitem><para>default (shown)</para></listitem> +<listitem><para>pirates</para></listitem> +<listitem><para>traditional</para></listitem> +</itemizedlist> +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Game</guimenu> +<guimenuitem>Open Background...</guimenuitem> +</menuchoice></term> +<listitem><para><action>Allows you to load a different background image.</action> +<screenshot> +<screeninfo>Load Background Dialog</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="background.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Load Background Dialog</phrase> + </textobject> + </mediaobject> +</screenshot> +</para> +<para> +The available options: +<itemizedlist> +<listitem><para>default (shown)</para></listitem> +<listitem><para>haze</para></listitem> +<listitem><para>pirates</para></listitem> +<listitem><para>slate</para></listitem> +<listitem><para>wood</para></listitem> +</itemizedlist> +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Game</guimenu> +<guimenuitem>Open Layout...</guimenuitem> +</menuchoice></term> +<listitem><para><action>Allows you to load a different tile layout.</action> +<screenshot> +<screeninfo>Load Layout Dialog</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="layout.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Load Layout Dialog</phrase> + </textobject> + </mediaobject> +</screenshot> +</para> +<para> +The available options: +<itemizedlist> +<listitem><para>default (shown)</para></listitem> +<listitem><para>cross</para></listitem> +<listitem><para>pirates</para></listitem> +<listitem><para>pyramid</para></listitem> +<listitem><para>stax</para></listitem> +<listitem><para>tower</para></listitem> +<listitem><para>triangle</para></listitem> +</itemizedlist> +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo> +</shortcut> +<guimenu>Game</guimenu> +<guimenuitem>Save</guimenuitem> +</menuchoice></term> +<listitem><para><action>Saves</action> the current game.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Game</guimenu> +<guimenuitem>Save Theme...</guimenuitem> +</menuchoice></term> +<listitem><para><action>Saves the current theme.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keysym>P</keysym> +</shortcut> +<guimenu>Game</guimenu> +<guimenuitem>Pause</guimenuitem> +</menuchoice></term> +<listitem><para><action>Pauses or resumes the game. While the game is paused, all tiles are hidden.</action></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><action>Shows the highscore list.</action> +<screenshot> +<screeninfo>Show Highscores</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="highscore.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Show Highscores</phrase> + </textobject> + </mediaobject> +</screenshot> +</para> +<para> +When your game scores exceed the top ten scores listed, you are prompted to enter your name. +</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><action>Quits</action> &kmahjongg;.</para></listitem> +</varlistentry> + +</variablelist> +</para> + +</sect2> + +<sect2 id="edit-menu"> +<title><guimenu>Edit</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice> +<guimenu>Edit</guimenu> +<guimenuitem>Board Editor</guimenuitem> +</menuchoice></term> +<listitem><para><action>Opens the gameboard editor.</action> +<screenshot> +<screeninfo>Gameboard Editor</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="boardeditor.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Gameboard Editor</phrase> + </textobject> + </mediaobject> +</screenshot> +</para> +<para> +The gameboard editor lets you create your own tile layouts for gameplay. +</para> +</listitem> +</varlistentry> + +</variablelist> + +</sect2> + +<sect2 id="move-menu"> +<title><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</action> your last move.</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>Redo</action> a move the was undone.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keysym>H</keysym> +</shortcut> +<guimenu>Move</guimenu> +<guimenuitem>Hint</guimenuitem> +</menuchoice></term> +<listitem><para><action>Gives a Hint</action> by flashing a matching pair of tiles.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keysym>D</keysym> +</shortcut> +<guimenu>Move</guimenu> +<guimenuitem>Demo</guimenuitem> +</menuchoice></term> +<listitem><para><action>Starts the game Demo</action> mode.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Move</guimenu> +<guimenuitem>Shuffle</guimenuitem> +</menuchoice></term> +<listitem><para><action>Shuffles the tiles</action> on the board.</para></listitem> +</varlistentry> + + +</variablelist> + +</sect2> + +<sect2 id="settings-menu"> +<title><guimenu>Settings</guimenu> Menu</title> + +<variablelist> + +<varlistentry> +<term><menuchoice><guimenu>Settings</guimenu><guimenuitem>Show/Hide Toolbar</guimenuitem></menuchoice></term> +<listitem> +<para>Shows or hides the Toolbar.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenu>Settings</guimenu><guimenuitem>Show/Hide Statusbar</guimenuitem></menuchoice></term> +<listitem> +<para>Shows or hides the Statusbar.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenu>Settings</guimenu><guimenuitem>Show/Hide Matching Tiles</guimenuitem></menuchoice></term> +<listitem> +<para>Shows or hides matching tiles by not flashing the matching free tiles when a tile is selected.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure Shortcuts...</guimenuitem></menuchoice></term> +<listitem> +<para><action>Displays a standard &kde; shortcut configuration dialog</action> to change the +<link linkend="default-keybindings">keyboard shortcuts</link> for &kmahjongg;.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure Toolbars...</guimenuitem></menuchoice></term> +<listitem> +<para>Displays a standard &kde; dialog where you can configure the toolbar icons.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure &kmahjongg;...</guimenuitem></menuchoice></term> +<listitem> +<para><action>Opens a dialog to configure &kmahjongg;.</action> For details, +see <link linkend="game-configuration">here</link>.</para> +</listitem> +</varlistentry> + + +</variablelist> + + +</sect2> + +<sect2 id="help-menu"> +<title>The <guimenu>Help</guimenu> Menu</title> + +<!-- Assuming you have a standard help menu (help, what's this, about --> +<!-- &kmahjongg;, about KDE) then the documentation is already written. --> +<!-- The following entity is valid anywhere that a variablelist is --> +<!-- valid. --> + +&help.menu.documentation; + +</sect2> + +</sect1> +</chapter> + + + +<chapter id="credits"> + +<!-- Include credits for the programmers, documentation writers, and +contributors here. The license for your software should then be included below +the credits with a reference to the appropriate license file included in the KDE +distribution. --> + +<title>Credits and License</title> + +<para> +&kmahjongg; for KDE +</para> + +<para> +Program Copyright © 1997 &Mathias.Mueller; &Mathias.Mueller.mail; +</para> + +<para> +Contributors: +<itemizedlist> +<listitem><para>&David.Black; &David.Black.mail;</para></listitem> +<listitem><para>&Michael.Haertjens; &Michael.Haertjens.mail;</para></listitem> +<listitem><para>&Osvaldo.Stark; &Osvaldo.Stark.mail;</para></listitem> +<listitem><para>&Benjamin.Meyer; &Benjamin.Meyer.mail;</para></listitem> +<listitem><para>&Albert.Astals.Cid; &Albert.Astals.Cid.mail;</para></listitem> +</itemizedlist> +</para> + +<para> +Documentation Copyright © 2005 &John.Hayes; &John.Hayes.mail; +</para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +&underFDL; + +&underGPL; + +</chapter> + +</book> + diff --git a/doc/kmahjongg/layout.png b/doc/kmahjongg/layout.png Binary files differnew file mode 100644 index 00000000..38be51e4 --- /dev/null +++ b/doc/kmahjongg/layout.png diff --git a/doc/kmahjongg/numbered.png b/doc/kmahjongg/numbered.png Binary files differnew file mode 100644 index 00000000..142d402e --- /dev/null +++ b/doc/kmahjongg/numbered.png diff --git a/doc/kmahjongg/shortcuts.png b/doc/kmahjongg/shortcuts.png Binary files differnew file mode 100644 index 00000000..32a941cf --- /dev/null +++ b/doc/kmahjongg/shortcuts.png diff --git a/doc/kmahjongg/showremoved.png b/doc/kmahjongg/showremoved.png Binary files differnew file mode 100644 index 00000000..33b49957 --- /dev/null +++ b/doc/kmahjongg/showremoved.png diff --git a/doc/kmahjongg/theme.png b/doc/kmahjongg/theme.png Binary files differnew file mode 100644 index 00000000..693373ca --- /dev/null +++ b/doc/kmahjongg/theme.png diff --git a/doc/kmahjongg/tileset.png b/doc/kmahjongg/tileset.png Binary files differnew file mode 100644 index 00000000..b2ff3854 --- /dev/null +++ b/doc/kmahjongg/tileset.png diff --git a/doc/kmines/Makefile.am b/doc/kmines/Makefile.am new file mode 100644 index 00000000..368fc0da --- /dev/null +++ b/doc/kmines/Makefile.am @@ -0,0 +1,4 @@ + +KDE_DOCS = AUTO +KDE_LANG = en + diff --git a/doc/kmines/index.docbook b/doc/kmines/index.docbook new file mode 100644 index 00000000..423a60a8 --- /dev/null +++ b/doc/kmines/index.docbook @@ -0,0 +1,617 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY kappname "&kmines;"> + <!ENTITY package "kdegames"> + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE" > <!-- change language only here --> +]> + +<book lang="&language;"> + +<bookinfo> +<title>The &kmines; Handbook</title> + +<authorgroup> +<author> +<firstname>Nicolas</firstname> +<surname>Hadacek</surname> +<affiliation> +<address>&Nicolas.Hadacek.mail;</address> +</affiliation> +</author> +<author> +<firstname>Michael</firstname> +<surname>McBride</surname> +<affiliation><address><email>mmcbride@ematic.org</email></address></affiliation> +</author> +<othercredit role="developer"> +<firstname>Nicolas</firstname> +<surname>Hadacek</surname> +<affiliation> +<address>&Nicolas.Hadacek.mail;</address> +</affiliation> +<contrib>Developer</contrib> +</othercredit> +<othercredit role="reviewer"> +<firstname>Lauri</firstname> +<surname>Watts</surname> +<affiliation><address>&Lauri.Watts.mail;</address></affiliation> +<contrib>Reviewer</contrib> +</othercredit> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<copyright> +<year>2000</year> +<holder>&Nicolas.Hadacek;, Michael McBride</holder> +</copyright> + +<legalnotice>&FDLNotice;</legalnotice> + +<date>2005-12-28</date> +<releaseinfo>2.1.10</releaseinfo> + +<abstract><para>&kmines; is the &kde; version of the classic minesweeper +game.</para></abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>game</keyword> +<keyword>minesweeper</keyword> +</keywordset> + +</bookinfo> + +<chapter id="introduction"> +<title>Introduction</title> + +<para>&kmines; is the classic Minesweeper game. You must uncover all the empty +squares without blowing up a mine.</para> + +<para>When you uncover a square, a number appears: it indicates how many mines +surround this square. If there is no number the neighboring squares are automatically +uncovered. When you find a square that you are sure contains a mine, it is +<emphasis>very</emphasis> useful to put a flag on it (by right-clicking).</para> + +</chapter> + +<chapter id="how-to-play"> +<title>How to Play</title> + +<para>You have to use the mouse and its three buttons to uncover or to flag the +squares (with two-buttoned mice, clicking the +<mousebutton>middle</mousebutton> button is generally achieved by +simultaneously pressing the <mousebutton>left</mousebutton> and the +<mousebutton>right</mousebutton> buttons). Here are the details:</para> + +<itemizedlist> +<listitem><para>The <mousebutton>left</mousebutton> button will +uncover a square. If there is a bomb below that square, the bomb will +explode, and the game will be over.</para> +<para>If there is not a bomb under the square, a number will appear. +That is the number of neighboring squares that contain bombs. +<quote>Which ones?</quote> you ask: That's the point of the game.</para> +<para>For each square (excluding edge and corner squares), there are 8 +neighboring squares.</para> +<para>If none of the neighboring squares has a bomb, then a blank will +be shown under the square, and all neighboring squares will be +automatically uncovered.</para> +<note><para><mousebutton>Left</mousebutton> clicking a flagged square is +safe and does nothing.</para></note></listitem> +<listitem><para>The <mousebutton>right</mousebutton> button will mark +a square as containing a mine (by drawing a red flag on it) or, if the option is +set, as being uncertain (by drawing a question mark on it). The uncertain tag can +be useful when you are puzzled about the positions of +mines.</para></listitem> +<listitem><para>The <mousebutton>middle</mousebutton> button will +clear the surrounding squares if the right number of squares is +already flagged. It is very useful since it is much quicker than +uncovering all individual squares.</para> +<warning><para>If your flags are not properly positioned, you will +explode a bomb.</para></warning></listitem> +<listitem><para>Pressing the <guiicon>yellow smiley</guiicon> will start a new +game.</para></listitem> +</itemizedlist> + +<note><para>These are the default settings. The mouse buttons can be +reprogrammed. For more information, see the section entitled <link +linkend="prefs">Game Options</link>.</para></note> + +<sect1 id="screen"><title>The &kmines; Screen</title> + +<screenshot> +<screeninfo>The &kmines; Screen</screeninfo> +<mediaobject> +<imageobject><imagedata fileref="kmines1.png" + format="PNG"/></imageobject> +<textobject><phrase>The &kmines; Screen</phrase></textobject> +</mediaobject> +</screenshot> + +<para>The &kmines; screen consists of:</para> + +<itemizedlist> +<listitem><para>A Box showing you the number of mines still left to be marked. +Every time you flag a bomb site, this number will decrease by one.</para> +<note><para>This box does not determine if you are right or wrong, but only how +many mines you need to theoretically mark before you are done with this +game.</para></note> +<para>In this example, there are 40 mines to be marked.</para></listitem> +<listitem><para>A Yellow Smiley Face. Clicking this will start a new game. If +you lose the game, it will become a frown.</para></listitem> +<listitem><para>The box on the right shows how much time this round has taken. +The shortest time for each level is listed as the high +score.</para></listitem> +<listitem><para>The playing area. This will vary in size depending on the +difficulty level of the game. In this example, it consists of 256 squares. This is where you play the game.</para></listitem> +<!-- This doesn't seem to be there any more. +<listitem><para>A status line at the bottom of the window. In this example, it +simply says <guilabel>Game stopped</guilabel>.</para></listitem> +--> +</itemizedlist> +</sect1> +</chapter> + +<chapter id="prefs"><title>Game Options</title> +<para>The options to &kmines; are set by selecting <menuchoice> +<guimenu>Settings</guimenu> <guimenuitem>Configure &kmines;</guimenuitem> +</menuchoice> from the menubar. This will bring up a dialog box.</para> + +<screenshot> +<screeninfo>&kmines; Preferences</screeninfo> +<mediaobject> +<imageobject><imagedata fileref="kmines2.png" format="PNG"/></imageobject> +<textobject><phrase>&kmines; Preferences</phrase></textobject> +</mediaobject> +</screenshot> + +<para>This dialog box is divided into three sections.</para> + +<variablelist> +<varlistentry> +<term><guilabel>Game</guilabel></term> +<listitem> +<para>The first option, labeled <guilabel>Enable ? mark</guilabel>, +determines whether you can mark squares as +<quote>questionable</quote>. If this option is checked, then right clicking the mouse will first cause a square to be +flagged. If you right click again on the same square, the flag will change to +a <guiicon>?</guiicon>, to indicate you don't know if there is a bomb +there or not. If you click again, the square will change back to +blank.</para> + +<para>If there is not a mark in front of this option, the first +<mousebutton>right</mousebutton> mouse click will change the square to a +red flag. The second will make it blank again, thus skipping the <guiicon>?</guiicon> +symbol.</para> + +<para>The next option down, labeled <guilabel>Enable +keyboard</guilabel>, determines if the keyboard shortcuts will work +while playing the game. The default keyboard shortcuts are given in <xref +linkend="keys"/>, and can be changed by selecting +<menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure Shortcuts...</guimenuitem></menuchoice>.</para> + +<note><para>The only keyboard shortcuts affected are those +responsible for playing the game. Keyboard commands such as +<guimenuitem>New Game</guimenuitem> and +<guimenuitem>Quit</guimenuitem>, still work, regardless of this +option.</para></note> + +<para>The <guilabel>Pause if windows loses focus</guilabel> option will +automatically pause the game if the &kmines; window loses focus. When the game +is paused, the gameboard disappears, so you cannot use pausing the game as a way +to cheat!</para> + +<para>The <guilabel>"Magic" reveal</guilabel> option switches on <quote>Magic +reveal</quote> mode. In this mode, &kmines; does most of the gameplay for you: +If you have uncovered enough squares to be able to tell with certainty that a +square contains a mine, &kmines; will automatically mark it as a mine, and +perform an autoreveal on squares for which it has marked the correct number of +mines. Note that when you have this mode switched on, your scores do not count +as highscores.</para> + + +<para>The last section of this tab allows you to change the action of each of +the three mouse buttons. Your options are:</para> + +<variablelist> +<varlistentry> +<term>Reveal</term> +<listitem><para>This will reveal the contents of the square. If there is no bomb, +then a number will appear. If there is a bomb under that square, then the bomb +will explode, and the game will be over.</para></listitem> +</varlistentry> +<!-- <varlistentry> +<term>Toggle Mark</term> +<listitem><para>Clicking with this button on a square will mark/unmark with a red flag.</para></listitem> +</varlistentry> --> +<varlistentry> +<term>Autoreveal</term> +<listitem><para>Clicking on a square with this button will automatically reveal +all neighboring squares that are not marked with red flags. If one of those +neighboring squares has a bomb under it, the bomb will explode, and the game will +be over.</para></listitem> +</varlistentry> + +<varlistentry> +<term>Toggle Flag</term> +<listitem><para>Clicking with this button on a square will cycle through blank, +red flag, and question mark.</para></listitem> +</varlistentry> + +<varlistentry> +<term>Toggle ? Flag</term> +<listitem><para>Clicking with this button on a square will mark/unmark with a +question mark.</para></listitem> +</varlistentry> +</variablelist> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Appearance</guilabel></term> +<listitem> +<para>The top three color buttons determine the +<guilabel>Flag Color</guilabel>, <guilabel>Explosion Color</guilabel> +and <guilabel>Error Color</guilabel>.</para> + +<para>The rest of this page is concerned with mines colors. To adjust, +simply click the color button beside each description, and select the +new color.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Custom Game</guilabel></term> +<listitem> +<para>Finally, if you are not finding the existing configurations +challenging enough, you can set up a custom game here. Use the +sliders to change the <guilabel>Width</guilabel>, +<guilabel>Height</guilabel>, and the percentage of the board covered +with <guilabel>Mines</guilabel>. The default game has 15 percent of +the board covered, so there is plenty of room to make the game +harder.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>Saving your changes</term> +<listitem><para>Once your changes are complete, click +<guibutton>OK</guibutton> to make them permanent.</para> + +<para>If you want to abandon your changes, click +<guibutton>Cancel</guibutton> to abort the changes.</para> + +<para>If you click on <guilabel>Defaults</guilabel>, the default +settings will be restored. Click <guilabel>OK</guilabel> to make +these default changes permanent, or edit the settings some +more.</para> +</listitem> +</varlistentry> +</variablelist> + +</chapter> + +<chapter id="command"> +<title>Commands/Keyboard Shortcuts</title> + +<para>The following sections briefly describe each menubar option.</para> + +<sect1 id="game-menu"> +<title><guimenu>Game</guimenu> Menu</title> + +<para>The <guimenu>Game</guimenu> menu consists of 4 options.</para> + +<variablelist> +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo> +</shortcut> +<guimenu>Game</guimenu> +<guimenuitem>New</guimenuitem> </menuchoice></term> +<listitem><para>Starts a new game.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycap>P</keycap> +</shortcut> +<guimenu>Game</guimenu> +<guimenuitem>Pause</guimenuitem> </menuchoice></term> +<listitem><para>Pauses or resumes the game. This will hide the board (no cheating), and +give you a button to press when you want to continue this +game.</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 shows you the high score (the shortest time) for each +difficulty 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><action>Quits</action> &kmines;</para></listitem> +</varlistentry> +</variablelist> +</sect1> + +<sect1 id="move-menu"><title><guimenu>Move</guimenu> Menu</title> +<variablelist> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycap>H</keycap> +</shortcut> +<guimenu>Move</guimenu> +<guimenuitem>Hint</guimenuitem> </menuchoice></term> +<listitem><para>If you use this item, you will get a hint about where +you should click next. If you do that your score will not be added to the high-scores.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Move</guimenu> +<guimenuitem>Solve</guimenuitem> </menuchoice></term> +<listitem><para>This item tries to solve the current game.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Move</guimenu> +<guimenuitem>Solving Rate...</guimenuitem> </menuchoice></term> +<listitem><para>This item shows a dialog that calculates the solving rate for the current game type.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Move</guimenu> +<guimenuitem>View Log</guimenuitem> </menuchoice></term> +<listitem><para>This item shows a dialog with the log of the last game.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Move</guimenu> +<guimenuitem>Replay Log</guimenuitem> </menuchoice></term> +<listitem><para>This item replays the current log.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Move</guimenu> +<guimenuitem>Save Log...</guimenuitem> </menuchoice></term> +<listitem><para>This item shows a dialog to save the current log.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Move</guimenu> +<guimenuitem>Load Log...</guimenuitem> </menuchoice></term> +<listitem><para>This item shows a dialog to load a log.</para> +</listitem> +</varlistentry> + +</variablelist> +</sect1> + +<sect1 id="view-menu"><title><guimenu>View</guimenu> Menu</title> +<variablelist> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>+</keycap></keycombo> +</shortcut> +<guimenu>View</guimenu> +<guimenuitem>Zoom In</guimenuitem></menuchoice></term> +<listitem><para>Increase the size of the gameplay canvas.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>-</keycap></keycombo> +</shortcut> +<guimenu>View</guimenu> +<guimenuitem>Zoom Out</guimenuitem></menuchoice></term> +<listitem><para>Decrease the size of the gameplay canvas.</para> +</listitem> +</varlistentry> + +</variablelist> +</sect1> + +<sect1 id="settings-menu"><title><guimenu>Settings</guimenu> Menu</title> +<variablelist> +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Show Menubar</guimenuitem> </menuchoice></term> +<listitem><para>If there is a check in front of this option, then the menubar +will be visible. Selecting this option, hides the menubar.</para> +<note><para>To restore a hidden menubar, click outside the game play area, with +the right mouse button. This will bring up a small sub-menu. Simply select +<guimenuitem>Show Menubar</guimenuitem> from this sub-menu, and the menubar +will be visible again.</para></note></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guisubmenu>Choose Game Type</guisubmenu> +</menuchoice></term> +<listitem> +<para>Lets you set the difficulty level from a sub-menu.</para> +<para>There are three default levels of difficulty: +<guimenuitem>Easy</guimenuitem> (64 squares, 10 mines), +<guimenuitem>Normal</guimenuitem> (256 squares, 40 mines), and +<guimenuitem>Expert</guimenuitem> (480 squares, 99 mines). There is also a +<guimenuitem>Custom...</guimenuitem> level settings.</para> +<para>If you select <guimenuitem>Custom...</guimenuitem>, then the +settings you have configured in the <guimenuitem>Configure +&kmines;</guimenuitem> dialog will be used.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure +Shortcuts...</guimenuitem></menuchoice></term> +<listitem><para>This item lets you change the keyboard shortcuts used by &kmines;.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure +Notifications...</guimenuitem></menuchoice></term> +<listitem><para>This item displays a standard &kde; notifications configuration +dialog, where you can change the notifications (sounds, visible messages, +&etc;) used by &kmines;.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure +Highscores...</guimenuitem></menuchoice></term> +<listitem><para>On the <guilabel>Main</guilabel> tab you can change your +<guilabel>Nickname</guilabel> and add a +cute <guilabel>Comment</guilabel> about yourself, to show in the high +score table. You can also activate the <guilabel>World-wide highscores +enabled</guilabel> checkbox, and share your skill at &kmines; across +the world with an online highscore server. If you are connected to the +Internet, &kmines; will send your score automatically at the end of the +game to the highscore web server (kmines.sf.net).</para> +<para>The <guilabel>Advanced</guilabel> tab displays your <guilabel>Registration Data</guilabel> +on kmines.sf.net: Your <guilabel>Nickname:</guilabel> from the <guilabel>Main</guilabel> +tab and the <guilabel>Key:</guilabel>. This key was generated when you registered on kmines.sf.net by +selecting <guilabel>World-wide highscores enabled</guilabel> the first time. +The registration key is used in conjunction with the +nickname to identify uniquely users, but users cannot have the same nickname. +Click on the <guibutton>Remove</guibutton> button to delete you from the world highscores +list.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure &kmines;...</guimenuitem> </menuchoice></term> +<listitem><para>Allows you to adjust game options. For more detailed +information, see the section entitled <link linkend="prefs">Game +Options</link>.</para></listitem> +</varlistentry> + +</variablelist> +</sect1> + +<sect1 id="help-menu"> +<title><guimenu>Help</guimenu> Menu</title> + +&help.menu.documentation; + +</sect1> + +<sect1 id="keys"><title>Default Keyboard Shortcuts</title> +<para>The following table shows you the default keyboard shortcuts.</para> + + +<table> +<title>Keyboard Shortcuts</title> +<tgroup cols="2"> +<thead><row><entry>Key Combo</entry><entry>Action</entry></row></thead> +<tbody> +<row><entry><keycap>Arrows</keycap></entry><entry>Move cursor in playing area.</entry></row> +<row><entry><keycap>PageDown</keycap></entry><entry>Move to bottom +edge</entry></row> +<row><entry><keycap>PageUp</keycap></entry><entry>Move to top +edge</entry></row> +<row><entry><keycap>Home</keycap></entry><entry>Move to left edge</entry></row> +<row><entry><keycap>End</keycap></entry><entry>Move to right edge</entry></row> +<row><entry><keycap>Space</keycap></entry><entry>Reveal square.</entry></row> +<row><entry><keycap>W</keycap></entry><entry>Mark square as mine</entry></row> +<row><entry><keycap>Return</keycap></entry><entry>Automatically reveal all +surrounding squares not marked by a flag.</entry></row> +<row><entry><keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo></entry><entry>New Game</entry></row> +<row><entry><keycap>P</keycap></entry><entry>Pause Game</entry></row> +<row><entry><keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo></entry><entry>Quit &kmines;</entry></row> +<row><entry><keycap>F1</keycap></entry><entry>&kmines; Handbook</entry></row> +<row><entry><keycombo action="simul">&Shift;<keycap>F1</keycap></keycombo></entry><entry>What's This Help</entry></row> +<row><entry><keycombo action="simul">&Ctrl;<keycap>H</keycap></keycombo></entry><entry>Show Highscores</entry></row> +<row><entry><keycombo action="simul">&Ctrl;<keycap>M</keycap></keycombo></entry><entry>Show Menubar</entry></row> +<row><entry><keycombo action="simul">&Ctrl;<keycap>+</keycap></keycombo></entry><entry>Zoom In</entry></row> +<row><entry><keycombo action="simul">&Ctrl;<keycap>-</keycap></keycombo></entry><entry>Zoom Out</entry></row> + +</tbody> +</tgroup> +</table> + +<para>These shortcuts can be changed by selecting <menuchoice> +<guimenu>Settings</guimenu> <guimenuitem>Configure +Shortcuts...</guimenuitem> </menuchoice> from the menubar.</para> + +</sect1> + +</chapter> + +<chapter id="credits"><title>Credits and License</title> + +<para> +&kmines; +</para> +<para> +Program copyright 1996-2000 &Nicolas.Hadacek; &Nicolas.Hadacek.mail;</para> +<para>Documentation copyright 2000 &Nicolas.Hadacek; &Nicolas.Hadacek.mail;</para> +<para>Documentation updated for &kde; 2.0 by &Mike.McBride; +&Mike.McBride.mail;</para> +<para>Some changes for &kde; 3.2 by &Philip.Rodrigues; &Philip.Rodrigues.mail;</para> +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +&underFDL; +&underGPL; + +</chapter> + +<appendix id="installation"> +<title>Installation</title> + +<sect1 id="getting-kmines"> +<title>How to obtain &kmines;</title> + +&install.intro.documentation; + +</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: +--> + + diff --git a/doc/kmines/kmines1.png b/doc/kmines/kmines1.png Binary files differnew file mode 100644 index 00000000..d872f735 --- /dev/null +++ b/doc/kmines/kmines1.png diff --git a/doc/kmines/kmines2.png b/doc/kmines/kmines2.png Binary files differnew file mode 100644 index 00000000..961acdbd --- /dev/null +++ b/doc/kmines/kmines2.png diff --git a/doc/kolf/Makefile.am b/doc/kolf/Makefile.am new file mode 100644 index 00000000..171f575c --- /dev/null +++ b/doc/kolf/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = AUTO diff --git a/doc/kolf/index.docbook b/doc/kolf/index.docbook new file mode 100644 index 00000000..9da81ae3 --- /dev/null +++ b/doc/kolf/index.docbook @@ -0,0 +1,833 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY kappname "&kolf;"> + <!ENTITY package "kdegames"> + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE"> +]> + +<book lang="&language;"> + +<bookinfo> +<title>The &kolf; Handbook</title> + +<authorgroup> +<author> +<firstname>Jason</firstname> +<surname>Katz-Brown</surname> +<affiliation> +<address><email>jasonkb@mit.edu</email></address> +</affiliation> +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<legalnotice>&FDLNotice;</legalnotice> + +<date>2005-12-18</date> +<releaseinfo>1.1</releaseinfo> + +<abstract> +<para> +&kolf; is a miniature golf game for &kde;. +</para> +</abstract> + + +<keywordset> +<keyword>KDE</keyword> +<keyword>golf</keyword> +<keyword>miniature</keyword> +<keyword>arcade</keyword> +</keywordset> + +</bookinfo> + +<chapter id="introduction"> <title>Introduction</title> +<para>&kolf; is a miniature golf game with block graphics and a 2d top-down view. Courses are dynamic, and up to 10 people can play at once in competition.</para> +<para>&kolf; comes with a tutorial course. <link linkend="tutorial">Playing this course</link> is the easiest way to get started.</para> + +</chapter> + +<chapter id="tutorial"> +<title>Tutorial</title> + +<para>&kolf;'s game-play is simple. It is easiest to learn how to play hands-on, and thus a tutorial course is included to guide you through the basics. This chapter will guide you through this tutorial. To start the tutorial, choose <menuchoice><guimenu>Help</guimenu><guimenuitem>Tutorial</guimenuitem></menuchoice>.</para> + +<sect1 id="hitting"> +<title>Hitting the Ball</title> +<para>To aim the ball, either line up the mouse behind the ball so the +putter aims in the direction you want to hit it or press one of the +<keycap>Left Arrow</keycap> (counterclockwise) or <keycap>Right Arrow</keycap> (clockwise) keys, to rotate the putter.</para> +<tip> +<para>To rotate the putter more quickly with the keyboard, hold down <keycap>Shift</keycap> while pressing or holding the arrow keys. To rotate more slowly, hold down <keycap>Control</keycap>.</para> +</tip> +<para>To hit the ball, press and hold either the &LMB; or <keycap>Down +Arrow</keycap> key. The longer you hold down the key or button, the +more strength the putt will have. It will take practice to get a good +feel for speed.</para> +<tip> +<para>To stop abort the putt while you are still holding moving the putter back in your stroke, press <keycap>Escape</keycap>.</para> +</tip> + +<para>Hit the ball into the hole (gray circle) to move on the next.</para> +</sect1> + +<sect1 id="slopes"> +<title>Slopes</title> +<para>Slopes are areas of slanted down that the golf ball rolls down in an expected manner. The light of the golf course is from the upper-left, so the brightest slopes will push the ball towards the upper-left corner of the hole. Choose <menuchoice><guimenu>Hole</guimenu><guimenuitem>Show Info</guimenuitem></menuchoice> to see an arrow that points in the direction the slope will roll the ball.</para> +<para>On this tutorial hole, hit the ball onto the upward-pointing +slope and let it roll into the cup to move onto the next hole.</para> + +<sect2> <title>Directions</title> +<para>On the next hole, experiment with the other kinds of slopes. There are elliptical, vertical, horizontal, and diagonal slopes in &kolf;. Hit the ball into the hole.</para> +</sect2> +<sect2> <title>Steepness</title> +<para>The next tutorial hole has two slopes of differing steepness. If you choose <menuchoice><guimenu>Hole</guimenu><guimenuitem>Show Info</guimenuitem></menuchoice>, the steepness of the slope will appear as a number from 1-8, where 8 is steepest and 1 is shallowest. Also, the more extreme shading the slope has, the steeper it is. Hit the ball into the hole and continue to the next hole.</para> +</sect2> +</sect1> + +<sect1 id="walls"> <title>Walls</title> +<para>Balls bounce of walls as one would expect them to, with a little bit of dampening. Deflect the ball off the walls and into the cup to advance to the next hole.</para> +</sect1> + +<sect1 id="puddles-sand"> <title>Puddles and Sand</title> +<sect2> <title>Puddles</title> +<para>Puddles are blue. When your ball rolls into a puddle, a penalty stroke is added to your score and your ball is placed outside the puddle.</para> +</sect2> +<sect2> <title>Sand</title> +<para>Sand is yellow. Balls roll through sand very slowly.</para> +<para>Hit the ball around the puddles and through the sand into the hole to continue to the next tutorial hole.</para> +</sect2> +</sect1> + +<sect1 id="windmills"> <title>Windmills</title> +<para>Windmills are compound objects with brown border walls and a moving arm at either the top or bottom of the object. Half-walls create the opening to the windmill, which a black arm swings across. It takes practice to be able to time stroke of the ball to pass through the opening. Hit the ball through the windmill into the hole to continue.</para> +</sect1> + +<sect1 id="black-holes"> <title>Black Holes</title> +<para>When you hit your ball into a black hole, it is transported to the exit and ejected at the angle of the exit at a speed directly relational to the speed your ball was going. Choose <menuchoice><guimenu>Hole</guimenu><guimenuitem>Show Info</guimenuitem></menuchoice> to see which Black Hole goes to which exit and which direction the ball will come out of the exit. The rim around Black Holes and their corresponding exits are also the same color. Hit the ball into the black hole, which will then eject the ball into the cup so you can go to the next hole.</para> +</sect1> + +<sect1 id="floaters"> <title>Floaters</title> +<para>Floaters are moving platforms that carry a ball that lands on it. Floaters' speeds vary. This one is a pretty slow floater, but you still must time your shot so you can go over the wall and into the cup.</para> +</sect1> + +<sect1 id="bridges"> <title>Bridges</title> +<para>Bridges are simple - they just lift the ball above the things below them, like slopes, sand, and puddles. They can have brown walls on their perimeter.</para> +</sect1> +</chapter> + +<chapter id="basics"> <title>Basics</title> +<para>Here's in-depth description of &kolf;'s basic features.</para> + +<sect1 id="starting"> +<title>Starting a Game</title> + +<para>To start a game, choose +<menuchoice><guimenu>Game</guimenu><guimenuitem>New</guimenuitem></menuchoice>. +This opens a dialog where you can configure your new game.</para> + +<tip> +<para>More third-party &kolf; courses are available at the &kolf; website. See <ulink +url="http://web.mit.edu/jasonkb/www/kolf/">the &kolf; user-uploaded courses page</ulink>.</para> +</tip> + +<sect2> +<title><guilabel>Players</guilabel> Page</title> +<para>To add a player to your game, click the <guibutton>New +Player</guibutton> button.</para> + +<para>The text boxes in the grass area are the names of the players in +this game. To change the name of the players, change the text in the +text boxes. To change the ball color of the players' balls, click the +middle button that has a color rectangle, and a dialog will open where +you can select the new ball color. The rectangle on the button is the +current player's ball color.</para> + +<para>To remove a player, click the <guibutton>Remove</guibutton> +button next to the player's name.</para> + +</sect2> + +<sect2> <title><guilabel>Course</guilabel> Page</title> +<para>To choose the course that you want to play, click it's entry in the list box on the left of this page. &kolf; comes with many built-in courses that you can play.</para> +<para>To add a course that you have downloaded or made, click on the <guibutton>Add...</guibutton> button on the bottom of this page, and choose the course file in the file dialog.</para> +</sect2> +<sect2> <title><guilabel>Options</guilabel> Page</title> +<para>On this page you can choose whether or not this game will be played in <guilabel>Strict mode</guilabel>. In strict mode, there is no undo, moving holes, or editing of the course. This mode is generally for competition. Only in strict mode are high scores kept.</para> +</sect2> +</sect1> + +<sect1 id="saved-games"> <title>Saved Games</title> +<para>&kolf; can keep a history of your rounds that are still in progress and save them to disk so you can load them and play them later. Saved games include the current hole, names and colors of all players in game, and the scores of the players.</para> +<sect2> <title>Saving Your Game</title> +<para>To save your game while still playing, choose <menuchoice><guimenu>Game</guimenu><guimenuitem>Save Game</guimenuitem> +</menuchoice>. If you have not saved a game on this game before, you will be prompted for the file to save to.</para> +</sect2> +<sect2> <title>Loading Your Game</title> +<para>To load the game that you saved, choose <menuchoice><guimenu>Game</guimenu><guimenuitem>Load Saved Game...</guimenuitem> +</menuchoice>. You can then choose the saved game to open.</para> +</sect2> +</sect1> + +<sect1 id="practicing"> <title>Practicing</title> +<para>There are a few features that make practicing your golf easier. These features are not enabled during strict mode.</para> +<sect2> <title>Undo</title> +<para>To undo a bad shot, choose <menuchoice><guimenu>Hole</guimenu><guimenuitem>Undo Shot</guimenuitem></menuchoice>.</para> +</sect2> +<sect2> <title>Switching Holes</title> +<para>The <guimenu>Go</guimenu> menu contains many menu items for switching to different holes that are quite self explanatory. See the <link linkend="go-menu"><guimenu>Go</guimenu> menu reference</link>.</para> +</sect2> +</sect1> + +<sect1 id="putting-options"> <title>Putting Options</title> +<para>&kolf; has a few ways to putt. The basic putting method is <link linkend="hitting">described above</link>.</para> +<para>The mouse is enabled by default. This means that whenever the mouse is moved, the putter aligns to the line between the mouse and ball.</para> +<para>If you prefer to only use the keyboard and arrow keys, you can disable mouse putting by unchecking <menuchoice><guimenu>Settings</guimenu><guimenuitem>Enable Mouse for Moving Putter</guimenuitem></menuchoice>.</para> + +<sect2 id="advanced-putting"> <title>Advanced Putting</title> +<para>Advanced putting can be enabled by checking <menuchoice><guimenu>Settings</guimenu><guimenuitem>Enable Advanced Putting</guimenuitem></menuchoice>. This putting mode is slightly more challenging than the regular click-and-hold mode, and can be used with either the mouse or keyboard.</para> + +<para>To putt in this mode:</para> +<procedure> +<step> +<para>Click or press the <keycap>Down Arrow</keycap> key once to begin the swing. The putting indicator will appear, and the strength gauge will start filling up with a color, which changes as the gauge fills up.</para> +</step> +<step> +<para>Click or press the <keycap>Down Arrow</keycap> key when the strength gauge has filled up the amount that you want. The farther around the circle the strength gauge has filled up, the stronger the putt will be. It takes practice to be able to get the correct strength on putts.</para> +<para>After this, the color in the putting indicator will start to wind down back to where it started.</para> +</step> +<step> +<para>Click or press the <keycap>Down Arrow</keycap> key again when the strength-indicator is as close as possible to the center line of the putting indicator.</para> +</step> +</procedure> +<para>The closer the final click (or key press) is, the more true the putt is to the original line.</para> +</sect2> +</sect1> +</chapter> + +<chapter id="editing"> <title>Editing Courses</title> +<para>&kolf; comes with a versatile editor for its course file format. Courses can have any number of holes, and there is no limiting the creativity of the course designer.</para> + +<sect1 id="creating"> <title>Creating a New Course</title> +<para>To create a new course, choose <menuchoice><guimenu>Game</guimenu><guimenuitem>New</guimenuitem></menuchoice>. Go to the <guilabel>Course</guilabel> page of the dialog, and choose the <guilabel>Create New</guilabel> course. Make sure that, under the <guilabel>Options</guilabel> page of the dialog, <guilabel>Strict mode</guilabel> is unchecked.</para> + +<note> +<para>To play this new course later, click the <guibutton>Add...</guibutton> button to add the course to your list of courses.</para> +</note> +</sect1> + +<sect1 id="adding-holes"> <title>Adding Holes</title> +<para>Choose <menuchoice><guimenu>Hole</guimenu><guimenuitem>New</guimenuitem></menuchoice> to add a new hole at the end of the course.</para> +<tip> +<para>You can restore a hole to a blank state, similar to when it was first created, by choosing <menuchoice><guimenu>Hole</guimenu><guimenuitem>Clear</guimenuitem></menuchoice>.</para> +</tip> +<para>Two items will appear on new holes: a cup, and a white ball. The white ball marks where players' balls start the hole.</para> +</sect1> + +<sect1 id="editing-basics"> <title>Editing Basics</title> +<para>The basic building block of &kolf; courses is the <quote>object</quote>. Holes are made up of a bunch of objects. Objects can be moved to any location, and the different kinds of objects each have different properties you can set.</para> +<para>To start editing a hole, toggle the <menuchoice><guimenu>Hole</guimenu><guimenuitem>Edit</guimenuitem></menuchoice> menu item, or press the pencil icon on the toolbar. To leave editing mode, uncheck this menu item (or the toolbar icon).</para> + +<sect2> <title>Adding Objects</title> +<para>To add a new object to the course, choose it's name in the list box labeled <guilabel>Add object:</guilabel>. The object will appear in the center of the course.</para> +<caution> +<para>Bridges and signs will cover up new objects if they were already in the center of the hole.</para> +</caution> +<tip> +<para>You can add more than one cup to a hole! Doing so can create interesting hole designs.</para> +</tip> +<para>Some &kolf; objects are available as plugins. If you add these objects to your course, course players will need to download the plugin.</para> +<para>Third-party &kolf; plugins are available at the &kolf; website. See <ulink url="http://web.mit.edu/jasonkb/www/kolf/">the &kolf; plugins download page</ulink>.</para> +</sect2> + +<sect2> <title>Moving and Resizing Objects</title> +<para>Move your mouse cursor over the object that you want to move, and the mouse cursor will change to a hand cursor. Then click and drag the object to where you want it.</para> +<para>Puddles, sand, floaters, bridges, and signs can be resized by dragging the small circle at their lower-right corner.</para> + +<note> +<para>Walls can be moved by clicking and dragging their endpoints, or you can move the whole wall by clicking and dragging on the middle part of the wall as normal.</para> +</note> +</sect2> + +<sect2> <title>Objects' Settings</title> +<para>Objects' properties can be changed in the area at the lower-right corner of the &kolf; window. To edit an object, move your mouse cursor over it until the cursor changes to the hand cursor. Then click. Various controls for that object will appear in the lower-right corner of the &kolf; window.</para> +<sect3> <title>General Hole Settings</title> +<para>To edit general hole settings, click an area of the hole that is not covered by an object. When this is possible, the cursor will be the normal pointer cursor.</para> + +<variablelist> +<varlistentry> <term><guilabel>Course name:</guilabel></term> +<listitem> +<para>This is the name that is shown in the new game dialog and in the <guimenuitem>About Course</guimenuitem> dialog.</para> +</listitem> +</varlistentry> +<varlistentry> <term><guilabel>Course author:</guilabel></term> +<listitem> +<para>This is the author name that is shown in the <guimenuitem>About Course</guimenuitem> dialog.</para> +</listitem> +</varlistentry> +<varlistentry> <term><guilabel>Par:</guilabel></term> +<listitem> +<para>The par of the hole.</para> +</listitem> +</varlistentry> +<varlistentry> <term><guilabel>Maximum:</guilabel></term> +<listitem> +<para>The maximum number of strokes a player can take on the hole.</para> +</listitem> +</varlistentry> +<varlistentry> <term><guilabel>Show border walls</guilabel></term> +<listitem> +<para>Whether or not to show walls around the border of the hole.</para> +</listitem> +</varlistentry> +</variablelist> + +</sect3> +<sect3> <title>Slopes</title> + +<variablelist> +<varlistentry> <term>Type</term> +<listitem> +<para>Choose the type of the slope - <guilabel>Vertical</guilabel>, <guilabel>Horizontal</guilabel>, <guilabel>Diagonal</guilabel>, <guilabel>Opposite Diagonal</guilabel>, <guilabel>Circular</guilabel>. Diagonal and opposite diagonal slopes are triangles, while circular slopes are circles. Vertical and horizontal slopes are rectangles of course.</para> +</listitem> +</varlistentry> +<varlistentry> <term><guilabel>Reverse direction</guilabel></term> +<listitem> +<para>Whether or not to reverse the slant of the slope. For example, consider an elliptical slope (a circular slope). When it is not reversed, it pushes balls outward like a mound. When it is reversed, it sucks balls inward like a hole.</para> +</listitem> +</varlistentry> +<varlistentry> <term><guilabel>Grade:</guilabel></term> +<listitem> +<para>Choose the grade (steepness) of the slope by moving the slider so the grade moves towards 0 or 8, where 8 is steepest and 0 is flat. Steeper slopes push the ball more.</para> +</listitem> +</varlistentry> +<varlistentry> <term><guilabel>Unmovable</guilabel></term> +<listitem> +<para>Whether or not this can be moved by other objects, like floaters.</para> +<caution> +<para>If a floater overlaps with this object at any point on this path, and the slope is large and thus won't move the floater, you <emphasis>must</emphasis> make the slope <guilabel>Unmovable</guilabel>, or &kolf; will suffer poor performance!</para> +</caution> +</listitem> +</varlistentry> +</variablelist> + +</sect3> +<sect3> <title>Puddles and Sand</title> +<para>Puddles and Sand have the same configuration options as each other.</para> + +<variablelist> +<varlistentry> <term><guilabel>Enable show/hide</guilabel></term> +<listitem> +<para>Checking this enables the flashing of this puddle or sand.</para> +</listitem> +</varlistentry> +<varlistentry> <term>Show/Hide speed</term> +<listitem> +<para>The more towards <guilabel>Fast</guilabel> the slider is, the faster the puddle or sand flashes.</para> +</listitem> +</varlistentry> +</variablelist> + +</sect3> +<sect3> <title>Bridges, Windmills, Floaters, and Signs</title> +<para>Bridges, windmills, floaters, and signs all have similar settings for configuring on which sides there are border walls. To show the wall on a side, check the check box for that side.</para> +<para>There are also some more specific options for windmills, floaters, and signs.</para> + +<sect4> <title>Windmills</title> +<variablelist> +<varlistentry> <term><guilabel>Windmill on bottom</guilabel></term> +<listitem> +<para>Whether or not the black windmill arm is on bottom or top - the default is that it is on the bottom. The two half-walls will always be with the arm. Note that you cannot enable a border wall on the side that the arm is.</para> +</listitem> +</varlistentry> +<varlistentry> <term>Speed</term> +<listitem> +<para>The more towards <guilabel>Fast</guilabel> the slider is, the faster the black windmill arm moves.</para> +</listitem> +</varlistentry> +</variablelist> +</sect4> + +<sect4> <title>Floaters</title> +<para>The path the floater moves along is shown by the wall it's connected to.</para> +<variablelist> +<varlistentry> <term><guilabel>Moving speed</guilabel></term> +<listitem> +<para>The more towards <guilabel>Fast</guilabel> the slider is, the faster the floater moves. If the slider is all the way at the <guilabel>Slow</guilabel> end, the floater will stop.</para> +</listitem> +</varlistentry> +</variablelist> +</sect4> + +<sect4> <title>Signs</title> +<variablelist> +<varlistentry> <term><guilabel>Sign HTML:</guilabel></term> +<listitem> +<para>You can enter any valid &HTML; here. For example, entering <markup>Hit it <i>softly</i> towards the slope!</markup> will create the text <quote>Hit it <emphasis>softly</emphasis> towards the slope!</quote>.</para> +</listitem> +</varlistentry> +</variablelist> +</sect4> + +</sect3> +</sect2> +</sect1> +</chapter> + +<chapter id="command-reference"> +<title>Command and Menu Reference</title> + +<sect1 id="game-menu"> +<title>The <guimenu>Game</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice><shortcut> +<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo> +</shortcut> +<guimenu>Game</guimenu> +<guimenuitem>New...</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Start a new game</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><shortcut> +<keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo> +</shortcut> +<guimenu>Game</guimenu> +<guimenuitem>Load Saved Game...</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Load a previously saved game.</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><shortcut> +<keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo> +</shortcut> +<guimenu>Game</guimenu> +<guimenuitem>Save Course</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Save the current course using it's current file +name.</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Game</guimenu><guimenuitem>Save Course As...</guimenuitem> +</menuchoice></term> +<listitem> +<para>Open a file dialog allowing you to <action>save the current +course using a new file name.</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Game</guimenu><guimenuitem>Save Game</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Save the current game</action> with the last saved game filename, or under a filename you specify if you have not saved the game yet.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Game</guimenu> +<guimenuitem>Save Game As...</guimenuitem> +</menuchoice></term> +<listitem> +<para>Opens a file dialog allowing you to <action>save the current +game with a filename of your choice.</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><shortcut> +<keycombo action="simul">&Ctrl;<keycap>End</keycap> +</keycombo></shortcut> +<guimenu>Game</guimenu> +<guimenuitem>End Game</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>End the current game, without closing</action> &kolf;</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><action>Display the high score table.</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><shortcut> +<keycombo action="simul">&Ctrl;<keycap>P</keycap></keycombo> +</shortcut> +<guimenu>Game</guimenu><guimenuitem>Print...</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Print the current screen.</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Game</guimenu><guimenuitem>About Course</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Show name, author, and par of course.</action></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><action>Quit</action> &kolf;</para></listitem> +</varlistentry> +</variablelist> + +</sect1> + +<sect1 id="hole-menu"> +<title>The <guimenu>Hole</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice><shortcut> +<keycombo action="simul">&Ctrl;<keycap>E</keycap> +</keycombo></shortcut> +<guimenu>Hole</guimenu> +<guimenuitem>Edit</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Switch to editing mode</action> to edit the current hole.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><shortcut> +<keycombo action="simul">&Ctrl;&Shift;<keycap>N</keycap></keycombo> +</shortcut> +<guimenu>Hole</guimenu> +<guimenuitem>New</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Create a new hole.</action> (Only while editing.)</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><shortcut> +<keycombo action="simul">&Ctrl;<keycap>Delete</keycap> +</keycombo></shortcut> +<guimenu>Hole</guimenu> +<guimenuitem>Clear</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Remove all objects from the current +hole.</action> (Only while editing.)</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><shortcut> +<keycombo +action="simul">&Ctrl;<keycap>R</keycap></keycombo></shortcut> +<guimenu>Hole</guimenu> +<guimenuitem>Reset</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Reset the current hole to it's starting +position</action>, so that you can start over.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><shortcut> +<keycombo action="simul">&Ctrl;<keycap>I</keycap></keycombo> +</shortcut> +<guimenu>Hole</guimenu> +<guimenuitem>Show Info</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Show information about objects on the current hole.</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><shortcut> +<keycombo action="simul">&Ctrl;<keycap>Z</keycap></keycombo> +</shortcut> +<guimenu>Hole</guimenu> +<guimenuitem>Undo Shot</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Undo the last shot you made.</action></para> +</listitem> +</varlistentry> +</variablelist> + +</sect1> + +<sect1 id="go-menu"> +<title>The <guimenu>Go</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice> +<guimenu>Go</guimenu> +<guisubmenu>Switch to Hole</guisubmenu> +</menuchoice></term> +<listitem> +<para><action>Go directly to another hole within the +course.</action> A list of the hole numbers allows you to choose +which hole you wish to go to.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><shortcut><keycombo action="simul"> +&Alt;<keycap>Right Arrow</keycap></keycombo></shortcut> +<guimenu>Go</guimenu> +<guimenuitem>Next Hole</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Go the the next hole.</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><shortcut><keycombo action="simul"> +&Alt;<keycap>Left Arrow</keycap></keycombo></shortcut> +<guimenu>Go</guimenu> +<guimenuitem>Previous Hole</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Go to the previous hole.</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><shortcut><keycombo action="simul"> +&Ctrl;<keycap>Home</keycap></keycombo></shortcut> +<guimenu>Go</guimenu> +<guimenuitem>First Hole</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Go to the first hole in the course.</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;&Shift;<keycap>End</keycap> +</keycombo> +</shortcut> +<guimenu>Go</guimenu> +<guimenuitem>Last Hole</guimenuitem> +</menuchoice> +</term> +<listitem> +<para><action>Go to the last hole in the course.</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Go</guimenu> +<guimenuitem>Random Hole</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Go to a random hole from the current course.</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>Show Toolbar</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Toggle on and off the main toolbar.</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Show Statusbar</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Toggle on and off the statusbar.</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Enable Mouse for Moving Putter</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Allow the use of the mouse to move the +putter.</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Enable Advanced Putting</guimenuitem> +</menuchoice></term> +<listitem><para><action>Enable the advanced putting mode</action>, as +described in <link linkend="advanced-putting">its own +section</link>.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Show Putter Guideline</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Toggle on and off the putter guideline.</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Play Sounds</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Toggle on and off the sound effects.</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Enable All Dialog Boxes</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Re-enables any dialog boxes that you disabled by clicking on +<guilabel>Do not show this message again</guilabel> or similar</action>.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Reload Plugins</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Reload plugins.</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Show Plugins</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Display the currently loaded plugins.</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Shortcuts...</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Customize the keyboard shortcuts.</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Toolbars...</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Open a dialog where you can configure the toolbars</action> for &kolf;.</para> +</listitem> +</varlistentry> + +</variablelist> +</sect1> + +<sect1 id="help-menu"> +<title>The <guimenu>Help</guimenu> Menu</title> + +&help.menu.documentation; + +</sect1> +</chapter> +<chapter id="credits-and-license"> +<title>Credits and Licenses</title> + +<para>&kolf; copyright 2001, 2002 &Jason.Katz-Brown;</para> + +<itemizedlist> +<title>Developers</title> +<listitem> +<para>&Jason.Katz-Brown; <email>jasonkb@mit.edu</email></para> +</listitem> +<listitem> +<para>Niklas Knutsson</para> +</listitem> +<listitem> +<para>Ryan Cumming</para> +</listitem> +<listitem> +<para>Daniel Matza-Brown</para> +</listitem> +</itemizedlist> + +<para>Documentation copyright 2002, &Jason.Katz-Brown;</para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +&underFDL; +&underGPL; + +</chapter> + +<appendix id="installation"> +<title>Installation</title> + +&install.intro.documentation; +&install.compile.documentation; + +</appendix> + +&documentation.index; + +</book> diff --git a/doc/konquest/Makefile.am b/doc/konquest/Makefile.am new file mode 100644 index 00000000..368fc0da --- /dev/null +++ b/doc/konquest/Makefile.am @@ -0,0 +1,4 @@ + +KDE_DOCS = AUTO +KDE_LANG = en + diff --git a/doc/konquest/index.docbook b/doc/konquest/index.docbook new file mode 100644 index 00000000..34a70b66 --- /dev/null +++ b/doc/konquest/index.docbook @@ -0,0 +1,295 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY kappname "&konquest;"> + <!ENTITY package "kdegames"> + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE" > <!-- change language only here --> +]> + +<book lang="&language;"> + +<bookinfo> +<title>The &konquest; Handbook</title> + +<authorgroup> +<author> +<firstname>Nicholas</firstname> +<surname>Robbins</surname> +<affiliation> +<address>&Nicholas.Robbins.mail;</address> +</affiliation> +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<othercredit role="developer"> +<firstname>Russ</firstname> +<surname>Steffen</surname> +<affiliation> +<address>&Russ.Steffen.mail;</address></affiliation> +<contrib>Developer</contrib> +</othercredit> + +<othercredit role="reviewer"> +<firstname>Lauri</firstname> +<surname>Watts</surname> +<affiliation> +<address>&Lauri.Watts.mail;</address> +</affiliation> +<contrib>Reviewer</contrib> +</othercredit> + +<copyright> +<year>2000</year> +<holder>Nicholas Robbins</holder> +</copyright> + +<legalnotice>&FDLNotice;</legalnotice> + +<date>2005-12-16</date> +<releaseinfo>1.1</releaseinfo> + +<abstract><para>&konquest; is a wonderfully complex game for universal +domination, or konquest, if you like. :)</para></abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>Konquest</keyword> +<keyword>kdegames</keyword> +</keywordset> + +</bookinfo> + +<chapter id="introduction"> +<title>Introduction</title> + +<para>This the &kde; version of <application>Gnu-Lactic +&konquest;</application>, a multi-player strategy game. The goal of the +game is to expand your interstellar empire across the galaxy and of +course, crush your rivals in the process.</para> + +</chapter> + +<chapter id="using-konquest"> +<title>Using &konquest;</title> + +<sect1 id="konquest-features"> +<title>More &konquest; features</title> + +<para>A really entertaining game of universal domination. +</para> + +</sect1> + +<sect1 id="configuration"> +<title>Configuration</title> + +<para>When you start a &konquest; game, a settings window pops up. +From here you need to enter player names, decide the number of +planets, and how many turns are allowed. (Don't worry, you can add +more later) You can also reject the map, until a you find a galaxy +layout you like. After this, just click <guibutton>OK</guibutton> +to start the game.</para> + +</sect1> + +</chapter> + +<chapter id="commands"> +<title>Command Reference</title> + +<sect1 id="konquest-mainwindow"> +<title>The Main &konquest; Window</title> + +<para>The Planet Status indicator on the right is +your source for intelligence on the state of the Galaxy. Your spies +will report on the status of your rivals, but not on the +native-controlled planets. The information present in the display is: +<guilabel>Planet name</guilabel>, <guilabel>Owner</guilabel>, +<guilabel>Production</guilabel> rate, fleet strength +(<guilabel>Ships</guilabel> and <guilabel>Kill +percent</guilabel>).</para> + +<para>The <guilabel>Production</guilabel> rate is the number of ships +that planet will construct in one turn. The fleet strength is the +number of <guilabel>Ships</guilabel> currently in place at the +planet. And, the <guilabel>Kill percent</guilabel> is a measure of the +effectiveness of the ships produced at that planet. Attack fleets take +the kill percentage of their planet of departure, and defense fleets +use the kill percentage of the planet they are defending.</para> + +<sect2> +<title>The <guimenu>Game</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo> +</shortcut> +<guimenu>Game</guimenu> +<guimenuitem>New</guimenuitem> +</menuchoice></term> +<listitem><para><action>Starts a new game.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>End</keycap></keycombo> +</shortcut> +<guimenu>Game</guimenu> +<guimenuitem>End Game</guimenuitem> +</menuchoice></term> +<listitem><para><action>End the current game, without closing</action> &konquest;</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Game</guimenu> +<guimenuitem>Measure Distance</guimenuitem> +</menuchoice></term> +<listitem><para>Click with the &LMB; on two planets to see their distance.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Game</guimenu> +<guimenuitem>Show Standings</guimenuitem> +</menuchoice></term> +<listitem><para><action>Opens</action> a window to display the detailed current +standings for all players</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Game</guimenu> +<guimenuitem>Fleet Overview</guimenuitem> +</menuchoice></term> +<listitem><para><action>Opens</action> a window to display detailed informations +for all fleets</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><action>Quits the game.</action></para></listitem> +</varlistentry> +</variablelist> +</sect2> + +<sect2 id="settings-menu"> +<title>The <guimenu>Settings</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Show Toolbar</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Toggle</action> the toolbar display on and off.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Shortcuts...</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Opens</action> a standard &kde; shortcut configuration dialog to +change the keyboard shortcuts used by &konquest;.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Toolbars...</guimenuitem> +</menuchoice></term> +<listitem> +<para>Brings up the standard &kde; toolbar configuration dialog to customize the &konquest; toolbar icons.</para> +</listitem> +</varlistentry> + +</variablelist> +</sect2> + + +<sect2> +<title>The <guimenu>Help</guimenu> Menu</title> + +&help.menu.documentation; + +</sect2> +</sect1> +</chapter> + +<chapter id="credits"> + + +<title>Credits and License</title> + +<para>&konquest;</para> + +<para>&GNU;-Lactic Conquest Project, &kde; version by &Russ.Steffen;, +&Russ.Steffen.mail;.</para> + +<para>Copyright © 1998 by the &GNU;-Lactic Conquest Project </para> + +<para>Documentation copyright 2000 Nicholas Robbins +&Nicholas.Robbins.mail;</para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +&underFDL; <!-- FDL: do not remove --> + +&underGPL; <!-- GPL License --> + +</chapter> + +<appendix id="installation"> +<title>Installation</title> + +<sect1 id="getting-konquest"> +<title>How to obtain &konquest;</title> + +&install.intro.documentation; + +</sect1> + +<sect1 id="requirements"> +<title>Requirements</title> + +<para>In order to successfully use &konquest;, you need &kde; 3.0. It +is also reccomended that you have your X server set to over 8bpp, as +the plants are scanned and require a rather high color depth. </para> + +</sect1> + +<sect1 id="compilation"> +<title>Compilation and Installation</title> + +&install.compile.documentation; + +</sect1> + +</appendix> + +&documentation.index; + +</book> + +<!-- +Local Variables: +mode: sgml +sgml-omittag: nil +sgml-shorttag: t +End: +--> diff --git a/doc/kpat/Makefile.am b/doc/kpat/Makefile.am new file mode 100644 index 00000000..60062a5e --- /dev/null +++ b/doc/kpat/Makefile.am @@ -0,0 +1,5 @@ + +KDE_DOCS = AUTO +KDE_LANG = en + +KDE_MANS = AUTO diff --git a/doc/kpat/clubs.png b/doc/kpat/clubs.png Binary files differnew file mode 100644 index 00000000..55a6f6ed --- /dev/null +++ b/doc/kpat/clubs.png diff --git a/doc/kpat/diamonds.png b/doc/kpat/diamonds.png Binary files differnew file mode 100644 index 00000000..b57215a8 --- /dev/null +++ b/doc/kpat/diamonds.png diff --git a/doc/kpat/hearts.png b/doc/kpat/hearts.png Binary files differnew file mode 100644 index 00000000..9769cd2a --- /dev/null +++ b/doc/kpat/hearts.png diff --git a/doc/kpat/index.docbook b/doc/kpat/index.docbook new file mode 100644 index 00000000..3fcda113 --- /dev/null +++ b/doc/kpat/index.docbook @@ -0,0 +1,811 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY kappname "&kpatience;"> + <!ENTITY package "kdegames"> + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE" > <!-- change language only here --> +]> + +<book lang="&language;"> +<bookinfo> +<title>The &kpatience; Handbook</title> + +<authorgroup> +<author> +<firstname>Paul Olav</firstname> +<surname>Tvete</surname> +</author> +<author> +<firstname>Maren</firstname> +<surname>Pakura</surname> +</author> +<author> +<firstname>Stephan</firstname> +<surname>Kulow</surname> +</author> + +<othercredit role="reviewer"> +<firstname>Mike</firstname><surname>McBride</surname> +<contrib>Reviewer</contrib> +<affiliation><address><email>mpmcbride7@yahoo.com</email></address></affiliation> +</othercredit> + +<othercredit role="developer"> +<firstname>Paul Olav</firstname> +<surname>Tvete</surname> +<contrib>Developer</contrib> +</othercredit> + +<othercredit role="developer"> +<firstname>Stephan</firstname> +<surname>Kulow</surname> +<contrib>Developer</contrib> +</othercredit> +</authorgroup> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> + +<copyright> +<year>2000</year> +<holder>Paul Olav Tvete</holder> +</copyright> +<copyright> +<year>2001</year><year>2004</year> +<holder>Maren Pakura</holder> +</copyright> + +<legalnotice>&FDLNotice;</legalnotice> + +<date>2004-02-07</date> +<releaseinfo>3.2</releaseinfo> +<abstract> + +<para>&kpatience; is a highly addictive card game for &kde;</para> + +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>game</keyword> +<keyword>patience</keyword> +<keyword>solitaire</keyword> +</keywordset> +</bookinfo> + +<chapter id="introduction"> +<title>Introduction</title> + +<para> +To play a patience you need, as the name suggests, patience. For simple games, +where the way the game goes depends only on how the cards fall, your patience is +even the only thing you need. +</para> + +<para> +But there are also patience where you also need to plan your strategy and think +ahead to win. +</para> + +<para> +All the games have in common that you have to put the cards in a special order +in moving, turning and reordering them. +</para> + +</chapter> + +<chapter id="rules"> +<title>Rules</title> + +<para><indexterm><primary>suits</primary></indexterm> +A card game contains one or more card decks of 52 cards each. Each deck contains +the four suits: +</para> + +<informaltable pgwide="0" frame="none"> +<tgroup cols="2"> +<colspec/> +<colspec/> +<tbody> + +<row valign="middle"> +<entry> +<inlinemediaobject> +<imageobject> +<imagedata fileref="clubs.png"/> +</imageobject> +</inlinemediaobject> +</entry> +<entry> +Clubs +</entry> +</row> + +<row valign="middle"> +<entry> +<inlinemediaobject> +<imageobject> +<imagedata fileref="spades.png"/> +</imageobject> +</inlinemediaobject> +</entry> +<entry> +Spades +</entry> +</row> + +<row valign="middle"> +<entry> +<inlinemediaobject> +<imageobject> +<imagedata fileref="hearts.png"/> +</imageobject> +</inlinemediaobject> +</entry> +<entry> +Hearts +</entry> +</row> + +<row valign="middle"> +<entry> +<inlinemediaobject> +<imageobject> +<imagedata fileref="diamonds.png"/> +</imageobject> +</inlinemediaobject> +</entry> +<entry> +Diamonds +</entry> +</row> + +</tbody> +</tgroup> +</informaltable> + +<para> +Each of these suits contains itself the following cards types: ace, two, three, +four, five, six, seven, eight, nine, ten, jack, queen and king. +</para> + +<para><indexterm><primary>family</primary></indexterm> +This complete order of cards is called a family. There are real families and +alternating ones. The real families are all of one suit (⪚ Hearts) while the +alternating families the card color changes from one to another between a black +color (Clubs and Spades) and a red color (Hearts and Diamonds). +</para> + +<para> +If the family is not complete, it's called a sequence. +</para> + +<mediaobject> +<imageobject><imagedata fileref="playfield.png" format="PNG"/></imageobject> +<textobject> +<phrase>The game field of &kpatience;</phrase> +</textobject> +</mediaobject> + +<para> +There are only a few different elements in typical patience game. These should +be introduced in the following. +</para> + +<variablelist> +<varlistentry><term>1. Talon</term> +<listitem> +<para><indexterm><primary>talon</primary></indexterm> +In the beginning of each game all cards are mixed in the deck. But not in every +game all cards are dealt out, but some reside in the deck. These cards are put +down on the so called talon, which you can find quite easy as it is in most +games the only pile showing the reverse. +</para> + +<para> +If no card shows the reverse side, all cards are dealt out and there is no +talon. These card games are the hardest as there is no randomness involved after +the start of the game, so there is nothing to blame +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>2. Waste Pile</term> +<listitem> +<para><indexterm><primary>waste pile</primary></indexterm> +Many games put cards from the talon first on a waste pile when you click on the +reverse of the top card on the talon. +</para> + +<para> +From there you can take the card (which is then face up) and put +it into the game. +</para> + +</listitem> +</varlistentry> + +<varlistentry> +<term>3. Foundation</term> +<listitem> +<para><indexterm><primary>foundation</primary></indexterm> +The foundation piles is where you want to have your cards in the end. If all +cards end up there in the right order, you've won. +</para> + +<para> +In most card games these piles are empty in the beginning, but &kpatience; drops +cards there when it sees them fitting to save you this most often boring part. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>4. Playing Piles</term> +<listitem> +<para><indexterm><primary>playing piles</primary></indexterm> +These piles are the ones where the actual reordering happens. The rules for +these piles vary a lot between the games. Some show all cards on them, some +not. Some allow only card to be removed, some allow every card to be removed, +etc. See the following chapters for details. +</para> +</listitem> +</varlistentry> +</variablelist> + +<sect1 id="general-use"> +<title>General Use</title> + +<para> +Use of the menu is too easy to be described now. +</para> + +</sect1> + +<sect1 id="klondike"> +<title>Klondike</title> +<anchor id="game_klondike" /> + +<para><indexterm><primary>Klondike</primary></indexterm> +Klondike is the most famous patience - most likely because an often used +operating system comes with it. It is played with one deck. +</para> + +<para> +Goal of Klondike is to put all cards as real families ascending on the +foundation. This works usually pretty well as soon as all cards are lying face +up in the playing piles. +</para> + +<para> +The sequences on the playing piles have to be put there descending while the cards +should alternate in colors (red and black). You can move whole sequences or +parts of it if the first card fits on another pile. +</para> + +<para> +On a free pile you can put a king of any color or a sequence starting with a +king. +</para> + +<para> +When you click on the talon, one card from will be moved to the waste pile, +from where you can move it to the playing piles or the foundation. +Is the talon empty, you can move the complete waste pile on the talon +in clicking on the empty talon. +</para> + +<para> +You can look through the cards on the talon without any limit, but you should +learn fast that you've lost if you can't find one card to move and that a new +shift doesn't help you in finding new solutions. +</para> +</sect1> + +<sect1 id="grandfather"> +<title>Grandfather</title> +<anchor id="game_grandfather"/> + +<para><indexterm><primary>Grandfather</primary></indexterm> +This game has been introduced to Paul by his grandfather, so it got this +name. There aren't any other patience games known implementing this patience +game. +</para> + +<para> +Grandfather deals one deck to seven playing piles while some cards on each pile +are face down on initial deal. +</para> + +<para> +The goal is to put all cards as real families ascending on the foundations. +</para> + +<para> +You can move every card on every pile if it fits on another card to build a real +sequence with descending order. For example you can move the five of spades on +top of the six of spades, no matter how many cards on are on top of the five of +spades. Just the six of spades has to be on top of its pile. +</para> + +<para> +On a free pile you can place a king (again no matter how many cards are on top of +it) +</para> + +<para> +If no more cards can be moved, you can re-deal up to two times. All cards already +in the foundations stay there, but the cards in the playing piles are reordered +to give you a new chance to find a solution. +</para> + +<para> +Even though the rules are simple and allow quite some moves, the game is still +hard to win, but is still a joy to play (or because of that). +</para> +</sect1> + +<sect1 id="aces-up"> +<title>Aces Up</title > +<anchor id="game_aces_up"/> + +<para><indexterm><primary>Aces Up</primary></indexterm> +This patience has very simple rules, but is still hard to win. It is played +with one deck and the goal is to put all cards beside the aces to the +foundation. After that there should be an ace on every playing pile left. +</para> + +<para> +Each top card that is of the same suit (⪚ spades) and has a lower +value than another top card (⪚ six of spades and four of spades) can be +put on the foundation by clicking on it. +</para> + +<para> +If you can't move any more cards to the foundation, you can get a new card for +each playing pile in clicking on the talon. +</para> + +<para> +On a free pile you can move every other card on top of a pile. You should choose +these moves to free piles the way that new cards can be moved to the foundation +after that. +</para> + +<para> +The auto drop feature is disabled for this patience. +</para> + +</sect1> + +<sect1 id="freecell"> +<title>Freecell</title> +<anchor id="game_freecell"/> + +<para><indexterm><primary>Freecell</primary></indexterm> +Freecell is playing with one card deck. You have four free cells in the left top +corner. Beside that there are the four foundation piles and below it there are +eight playing piles. +</para> + +<para> +The goal of the game is to have all cards as real families ascending on the +foundation. This works quite often if you know how to play as Freecell is +solvable at a rate of 99.9% approximately (of the first 32000 deals there is only +one unsolvable - 11982 if you want to know). +</para> + +<para> +In the playing piles you have to build descending sequences, where red and black +cards alternate. In a free cell you can put any card. +</para> + +<para> +You can only move one single card that lays on top of a pile or a free cell. +Sequences can only be moved if you have enough free room (free cells or free +playing piles) to put the cards in between you move. +</para> + +<para> +The moving of sequences will be supported by &kpatience; if there is enough room. The +maximum of cards you can move is calculated by:</para> + +<sidebar><para> +(#{free cells} + 1) * 2<superscript>#{free piles}</superscript> +</para></sidebar> + +<para> +To solve this game it is recommended to grab the cards out of the playing +sequences in the same order they have to be put into the foundation (first the +aces, then the twos, &etc;) +</para> + +<para> +You should try to keep as many free cells and/or playing piles empty, so you can +build as long sequences as possible. +</para> + +</sect1> + +<sect1 id="napoleons-tomb"> +<title>Napoleon's Tomb</title> +<anchor id="game_napoleons_tomb"/> +<para><indexterm><primary>Napoleon's Tomb</primary></indexterm> +Napoleon's Tomb is played with one deck. Goal is to put all cards on the +foundations as ascending families without caring about the card colors or suits. +</para> + +<para> +The foundation is made out of five piles, that are put as an X. On the four +corners of this X you have to build sequences starting with seven and ending +with king. +</para> + +<para> +The pile in the middle takes four times the sequence from six down to ace. The +color doesn't matter for all five piles. +</para> + +<para> +The other four piles on the sides of the pile in the middle (or in between the X +- however you want to put it) can take one card each to place cards temporarily. +You can go through the talon only once. +</para> + +<para> +[auto drop] is disabled for this patience. +</para> +</sect1> + +<sect1 id="mod3"> +<title>Mod3</title> +<anchor id="game_mod3"/> + +<para><indexterm><primary>Mod3</primary></indexterm> +Mod-3 is played with two card decks. Goal of the game is to put all +cards on the top three rows. In those you have to build sequences of the same +color. In the first row you have to create the sequence 2-5-8-B, in the second +row the sequence 3-6-9-D and in the third row the sequence 4-7-10-K. The suit of +the cards has to be the same in each sequence, so you can put a five of hearts +only on top of a two of hearts. +</para> + +<para> +The fourth row is waste pile and playing pile at once. On an empty slot you can +put any card from the first three rows or one of top of the fourth row. +</para> + +<para> +Aces you can put on the aces piles on top of the talon. They are in the game +so you have a starting point for creating free slots. +</para> + +<para> +If you can't move any more cards, you can get new cards on the fourth row in +clicking on the talon. +</para> + +<para> +[auto drop] is disabled for this patience. +</para> +</sect1> + +<sect1 id="calculation"> +<title>Calculation</title> +<anchor id="game_calculation"/> + +<para><indexterm><primary>Calculation</primary></indexterm> +Calculation is surely a patience you have to get used to. It is played with one +card deck and the goal of the game is to put all cards in the four foundation +piles as ascending families without caring the color of the cards. +</para> + +<para> +For the foundation you have to follow these orders: +</para> + +<blockquote> +<informaltable pgwide="0"> +<tgroup cols="2"> +<tbody> + +<row> +<entry>1st pile</entry> +<entry>A-2-3-4-5-6-7-8-9-10-J-Q-K</entry> +</row> + +<row> +<entry>2nd pile</entry> +<entry>2-4-6-8-10-Q-A-3-5-7-9-J-K</entry> +</row> + +<row> +<entry>3rd pile</entry> +<entry>3-6-9-Q-2-5-8-J-A-4-7-10-K</entry> +</row> + +<row> +<entry>4th pile</entry> +<entry>4-8-Q-3-7-J-2-6-10-A-5-9-K</entry> +</row> +</tbody> +</tgroup> +</informaltable> +</blockquote> + +<para> +The card on top of the talon can be put on any of the four playing piles. +You should do this, so you can put following cards easier on the foundation. +</para> +</sect1> + +<sect1 id="gypsy"> +<title>Gypsy</title> +<anchor id="game_gypsy"/> +<para><indexterm><primary>Gypsy</primary></indexterm> +Gypsy is played with two card decks. Goal of the game is to put all cards in +real families ascending on the foundation. +</para> + +<para> +The playing piles have to be descending while red and black cards have to +alternate. You can only move sequences or single cards. On a free slot you can +put any card or sequence. +</para> + +<para> +If you can't move any more cards, you can click on the talon to get a new bunch +of cards on each playing pile. +</para> + +<para> +In using the undo feature you can ease the game quite a lot as you have to take +quite some decisions and some of them might turn out to be wrong after you +clicked the talon. +</para> + +</sect1> + +<sect1 id="forty-and-eight"> +<title>Forty And Eight</title> +<anchor id="game_forty_and_eight"/> + +<para><indexterm><primary>Forty And Eight</primary></indexterm> +Forty and Eight is played with two card decks. Goal of the game is to put all +cards as real families on the foundation. +</para> + +<para> +The playing piles have to be descending while you have to care about colors. So +you can only put a five of hearts on a six of hearts. +</para> + +<para> +You can only move one single card on top of a pile. In a free slot you can put +any card. +</para> + +<para> +In clicking on the talon you can put a card on the waste pile, from where you +can put it on a playing pile or the foundation (this &kpatience; will do for you). +Is the talon empty you can put all cards on the waste pile back on the talon. +This works only once, after the second time the talon empties, the game is over. +</para> + +<para> +This patience isn't really easy to solve, but with some experience, you can +solve many deals, especially if you use the undo feature from time to time to +correct your decisions, and the decisions &kpatience; does in putting cards on the +foundation. +</para> +</sect1> + +<sect1 id="simple-simon"> +<title>Simple Simon</title> +<anchor id="game_simple_simon"/> + +<para><indexterm><primary>Simple Simon</primary></indexterm> +Simple Simon is played with one card deck. Goal of the game is to put all cards +as real families on the foundation. +</para> + +<para> +In the playing piles you can build sequences. In general you don't have to care +about the suits of the cards, but sequences can only be moved if they are part +of a real sequence. (⪚ you can move the six of spades only if on top of it is +the five of spades and not move it if on top of it is the five of clubs). +</para> + +<para> +The cards can only be moved to the foundation if all 13 cards of one family lay +on top of each other in the playing piles. +</para> + +<tip> +<title>Suggestion</title> +<para> +You should try as soon as possible to move away the cards on the right piles to +get free piles to place cards temporarily as you can put on those any card. +</para> + +<para> +With enough free room you can build families on free slots independently of the +color. If you have all cards in such families you can sort them after their +color, so they can be moved to the foundation. +</para> +</tip> + +</sect1> + +<sect1 id="yukon"> +<title>Yukon</title> +<anchor id="game_yukon"/> + +<para><indexterm><primary>Yukon</primary></indexterm> +Yukon is played with one card deck. Goal of the game is to put all cards as real +families ascending on the foundation. +</para> + +<para> +The sequences on the playing piles have to be descending with alternating red and +black cards. You can move every face up card no matter how many cards are on top +of it. So you can put a five of hearts on a six of spades if this one is on top +of its pile. +</para> + +<para> +In a free slot you can put a king of any color (again, no matter how many cards are on top +of it) +</para> +</sect1> + +<sect1 id="grandfathers-clock"> +<title>Grandfather's Clock</title> + +<anchor id="game_grandfathers_clock"/> +<para><indexterm><primary>Grandfathers Clock</primary></indexterm> +Grandfather's clock is a simple patience and after some experiments you should +be able to solve most deals. It is played with one card deck and goal of the +game is put the cards as real ascending sequences on the foundation. +</para> + +<para> +The foundation is on the right side and consists of 12 piles that form the shape +of a clock. The ace is on one o'clock, jack is on 11 o'clock and queen on 12 +o'clock. +</para> + +<para> +There are 8 playing piles beside the clock and on each are 5 cards. On the +playing piles you can build descending sequences without caring on the color of the +cards. You can only move one single card at a time. +</para> + +<para>[auto drop] is disabled for this patience.</para> + +</sect1> + +<sect1 id="kings"> +<title>Kings</title> + +<anchor id="game_kings"/> + +<para><indexterm><primary>Kings</primary></indexterm> +The patience Kings is played with two card decks. The cards are dealt in a way +that below each playing pile is a king. The cards between two kings are put on +of them (the first cards are obviously put on the first king). This way you can +get piles with <emphasis>very</emphasis> different lengths. +</para> + +<para> +Goal of the game is to put all cards as real families ascending on the +foundation (on the right side of the playing piles). +</para> + +<para> +The sequences on the playing piles have to be descending while red and black +cards have to alternate. Several cards can only be moved when they are part of +an alternating sequence. +</para> + +<para> +In the 8 free cells on the top of the playing field you can put a single card +temporarily. On a free playing pile you can put any card or sequence. +</para> + +</sect1> + +<sect1 id="spider"> +<title>Spider</title> + +<anchor id="game_spider"/> +<para><indexterm><primary>Spider</primary></indexterm> +Spider is played with two card decks. The cards are dealt out into 10 playing +piles, 4 of 6 cards and 6 of 5 cards each. This leaves 50 cards that can be +dealt out 10 at a time, one on each playing pile. +</para> + +<para> +In the playing piles, a card can be placed on another card of any suit and +of one higher value. A sequence of ascending cards of the same suit may be +moved from one playing pile to another. +</para> + +<para> +The goal of spider is to put all cards as real families descending from +Kings anywhere in the playing piles. When such a family is built in a +playing pile, it is removed to the lower-left corner of the window. +</para> + +<para> +The different levels determine how many suits are dealt - Easy uses 1 suit, +Medium uses 2 suits, and Hard uses all 4 suits. The game is fairly easy to +win at Easy, and very difficult to win at Hard. +</para> + +</sect1> + +<sect1 id="golf"> +<title>Golf</title> + +<para><indexterm><primary>Golf</primary></indexterm> +Golf is played with one card deck. The goal of Golf is to move all the cards on the tableau to the foundation. </para> + +<para>The layout of golf solitare is straight forward. At the beginning of the game you will see, the tableau, on it are seven columns each containing five cards. Below that is the talon and the foundation. </para> + +<para>Playing golf solitare is simple, but does require strategy to win. The cards at the base of each column on the tableau are available for play. Available cards are built upon the top foundation card in ascending or descending sequence regardless of suit. If there are no moves available a card may be dealt from the talon to the foundation. A game is over when all the cards in the talon have been dealt and there are no more possible moves.</para> + +</sect1> + +</chapter> + +<chapter id="credits"> +<title>Credits and License</title> + +<para> +&kpatience; Copyright 1995-2000 Paul Olav Tvete +</para> + +<para> +&kpatience; Copyright 2001 Stephan Kulow +<email>coolo@kde.org</email> +</para> + +<para> +Freecell Solver by Shlomi Fish +<email>shlomif@vipe.technion.ac.il</email> +</para> + +<para> +Documentation Copyright 2000 Paul Olav Tvete +</para> + +<para> +Documentation updated for KDE 2.0 by Michael McBride +<email>mpmcbride7@yahoo.com</email> +</para> + +<para> +Documentation rewritten for &kpatience; 2.0 (KDE 2.1) by Maren Pakura +<email>maren@kde.org</email> +</para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +&underFDL; +&underX11License; + +</chapter> + +&documentation.index; + +</book> + +<!-- +Local Variables: +mode: sgml +sgml-omittag: nil +sgml-shorttag: t +End: +--> + diff --git a/doc/kpat/man-kpat.6.docbook b/doc/kpat/man-kpat.6.docbook new file mode 100644 index 00000000..7ea3ce27 --- /dev/null +++ b/doc/kpat/man-kpat.6.docbook @@ -0,0 +1,340 @@ +<?xml version="1.0" ?> +<!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.1-Based Variant V1.0//EN" "dtd/kdex.dtd" [ + <!ENTITY kappname "kpat"> + <!ENTITY % English "INCLUDE" > +]> + +<refentry id="kpat"> +<refmeta> +<refentrytitle>KPAT</refentrytitle> +<manvolnum>6</manvolnum> +<refmiscinfo class="date">January 24, 2002</refmiscinfo> +<refmiscinfo class="source">kde-games</refmiscinfo> +<refmiscinfo class="title">KDE User's Manual</refmiscinfo> +</refmeta> + +<refnamediv> +<refname>&kappname;</refname> +<refpurpose>A highly addictive &kde; card game.</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<cmdsynopsis> +<command>kpat</command> +<arg choice="opt" rep="repeat">Qt-option</arg> +<arg choice="opt" rep="repeat">KDE-option</arg> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1> +<title>DESCRIPTION</title> +<para> +&kpat; is a compendium of several well known patience card games, +ranging from the well known Klondike and Freecell, to lesser known +games such as Grandfather's Clock and Mod3. In all there are 13 +variations for you to while away time.</para> +</refsect1> + +<refsect1> +<title>OPTIONS</title> +<para> +This program follows the usual GNU command line syntax, +with long options starting with two dashes (`--'). A +summary of the options supported by <command>kpat</command> +is included below. </para> + + +<refsect2> +<title>Generic Options</title> +<variablelist> + +<varlistentry> +<term><option>--author</option></term> +<listitem> +<para>Show author information</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>--help</term> +<listitem> +<para>Show help about options</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><option>--help-qt</option></term> +<listitem> +<para>Show Qt specific options</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><option>--help-kde</option></term> +<listitem> +<para>Show &kde; specific options</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><option>--help-all</option></term> +<listitem> +<para>Show all options</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><option>--license</option></term> +<listitem> +<para>Show license information</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><option>-v</option>, <option>--version</option></term> +<listitem> +<para>Show version information and exit.</para> +</listitem> +</varlistentry> +</variablelist> + +</refsect2> + +<!-- Cut here: From here to the end of the KDE options will be entities --> +<refsect2> +<title>Qt Options</title> + +<variablelist> +<varlistentry> +<term><option>--display <replaceable>displayname</replaceable></option></term> +<listitem> +<para>Use the X-server display <emphasis>displayname</emphasis>.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><option>--session <replaceable>sessionId</replaceable></option></term> +<listitem> +<para> +Restore the application for the given <replaceable>sessionId</replaceable>. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><option>--cmap</option></term> +<listitem> +<para> +Causes the application to install a private +color map on an 8-bit display. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><option>--ncols <replaceable>count</replaceable></option></term> +<listitem> +<para> +Limits the number of colors allocated in the +color cube on a 8-bit display, if the application +is using the <methodname>QApplication::ManyColor</methodname> +color specification. +</para> +</listitem> +</varlistentry> +<varlistentry> +<term><option>--nograb</option></term> +<listitem> +<para>tells Qt to never grab the mouse or the keyboard.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><option>--dograb</option></term> +<listitem> +<para> +running under a debugger can cause an implicit +<option>-nograb</option>, use <option>-dograb</option> +to override. +</para> +</listitem> +</varlistentry> +<varlistentry> +<term><option>--sync</option></term> +<listitem> +<para>switches to synchronous mode for debugging.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><option>--fn</option>, <option>--font <replaceable>fontname</replaceable></option></term> +<listitem> +<para>defines the application font.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><option>--bg</option>, <option>--background <replaceable>color</replaceable></option></term> +<listitem> +<para> +sets the default background color and an +application palette (light and dark shades +are calculated). +</para> +</listitem> +</varlistentry> +<varlistentry> +<term><option>--fg</option>,<option>--foreground <replaceable>color</replaceable></option></term> +<listitem> +<para>sets the default foreground color.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><option>--btn</option>, <option>--button <replaceable>color</replaceable></option></term> +<listitem> +<para>sets the default button color.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><option>--name <replaceable>name</replaceable></option></term> +<listitem> +<para>sets the application name.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><option>--title <replaceable>title</replaceable></option></term> +<listitem> +<para>sets the application title (caption).</para> +</listitem> +</varlistentry> +<varlistentry> +<term><option>--visual <replaceable>TrueColor</replaceable></option></term> +<listitem> +<para> +forces the application to use a TrueColor +visual on an 8-bit display. +</para> +</listitem> +</varlistentry> +<varlistentry> +<term><option>--inputstyle</option></term> +<listitem> +<para> +sets XIM (X Input Method) input style. Possible +values are onthespot, overthespot, offthespot +and root. +</para> +</listitem> +</varlistentry> +<varlistentry> +<term><option>--im <replaceable>XIM server</replaceable></option></term> +<listitem> +<para>set XIM server.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><option>--noxim</option></term> +<listitem> +<para>disable XIM.</para> +</listitem> +</varlistentry> +</variablelist> +</refsect2> + +<refsect2> +<title>KDE Options</title> +<variablelist> +<varlistentry> +<term><option>--caption <replaceable>caption</replaceable></option></term> +<listitem> +<para>Use <emphasis>caption</emphasis> as name in the titlebar.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><option>--icon <replaceable>icon</replaceable></option></term> +<listitem> +<para>Use <emphasis>icon</emphasis> as the application icon.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><option>--miniicon <replaceable>icon</replaceable></option></term> +<listitem> +<para>Use <replaceable>icon</replaceable> as the icon in the titlebar.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><option>--dcopserver <replaceable>server</replaceable></option></term> +<listitem> +<para> +Use the DCOP Server specified by <emphasis>server</emphasis>. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><option>--nocrashhandler</option></term> +<listitem> +<para>Disable crash handler, to get core dumps.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><option>--waitforwm</option></term> +<listitem> +<para> +Waits for a WM_NET compatible windowmanager. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><option>--style <replaceable>style</replaceable></option></term> +<listitem> +<para>sets the application &GUI; style.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><option>--geometry <replaceable>geometry</replaceable></option></term> +<listitem> +<para> +sets the client geometry of the main widget. +</para> +</listitem> +</varlistentry> +</variablelist> +</refsect2> + +<!-- Stop cutting here: End of entity text --> + +</refsect1> + +<refsect1> +<title>SEE ALSO</title> +<para> +&kpat; is documented in detail in <emphasis>The &kpat; +Handbook</emphasis> +(<filename>$<envar>KDEDIR</envar>share/doc/HTML/en/kpat/index.html</filename> +or enter <userinput>help://kpat/index.html</userinput> in +&konqueror;).</para> + +<para>&kde-http;</para> +</refsect1> + +<refsect1> +<title>AUTHOR</title> + +<para>&kpat; is by:</para> +<simplelist type="vert"> +<member>Paul Olav Tvete</member> +<member>Mario Weilguni <email>mweilguni@kde.org</email></member> +<member>Matthias Ettrich <email>ettrich@kde.org</email></member> +<member>Rodolfo Borges <email>barrett@labma.ufrj.br</email></member> +<member>Peter H. Ruegg <email>kpat@incense.org</email></member> +<member>Michael Koch <email>koch@kde.org</email></member> +<member>Marcus Meissner <email>mm@caldera.de</email></member> +<member>Shlomi Fish <email>shlomif@vipe.technion.ac.il</email></member> +<member>Stephan Kulow <email>coolo@kde.org</email></member> +</simplelist> +</refsect1> +</refentry> diff --git a/doc/kpat/playfield.png b/doc/kpat/playfield.png Binary files differnew file mode 100644 index 00000000..ad16caab --- /dev/null +++ b/doc/kpat/playfield.png diff --git a/doc/kpat/spades.png b/doc/kpat/spades.png Binary files differnew file mode 100644 index 00000000..5f9dea1f --- /dev/null +++ b/doc/kpat/spades.png diff --git a/doc/kpoker/Makefile.am b/doc/kpoker/Makefile.am new file mode 100644 index 00000000..368fc0da --- /dev/null +++ b/doc/kpoker/Makefile.am @@ -0,0 +1,4 @@ + +KDE_DOCS = AUTO +KDE_LANG = en + diff --git a/doc/kpoker/index.docbook b/doc/kpoker/index.docbook new file mode 100644 index 00000000..d63af910 --- /dev/null +++ b/doc/kpoker/index.docbook @@ -0,0 +1,582 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY kappname "&kpoker;"> + <!ENTITY package "kdegames"> + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE" > <!-- change language only here --> +]> + +<book lang="&language;"> +<bookinfo> +<title>&kpoker; Handbook</title> +<authorgroup> +<author> +<firstname>Jochen</firstname> +<surname>Tuchbreiter</surname> +<affiliation> +<address>&Jochen.Tuchbreiter.mail;</address> +</affiliation> +</author> +<author> +<firstname>Andreas</firstname> +<surname>Beckermann</surname> +<affiliation> +<address>&Andreas.Beckermann.mail;</address> +</affiliation> +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<copyright> +<year>1997</year><year>2001</year> +<holder>&Jochen.Tuchbreiter;, &Andreas.Beckermann;</holder> +</copyright> + +<legalnotice>&FDLNotice;</legalnotice> + +<date>2005-12-14</date> +<releaseinfo>1.1</releaseinfo> +<abstract> + +<para>This is the helpfile of &kpoker;, a little poker game.</para> + +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>kpoker</keyword> +<keyword>kdegames</keyword> +<keyword>games</keyword> +<keyword>game</keyword> +<keyword>poker</keyword> +<keyword>play cards</keyword> +</keywordset> +</bookinfo> + +<chapter id="introduction"> +<title>Introduction</title> + +<sect1 id="what-is-kpoker"> +<title>What is &kpoker;?</title> + +<para>&kpoker; is a <ulink url="http://www.kde.org">&kde;</ulink> compliant clone +of those highly addictive pocket video poker games which are sometimes called +<quote>Videopoker</quote> as well.</para> +</sect1> + +<sect1 id="where-do-i-get-the-latest-version-of-kpoker"> +<title>Where do I get the latest version of &kpoker;?</title> + +<para>The latest version of &kpoker; is always available at</para> +<itemizedlist> +<listitem> +<para>The &kpoker; homepage: <ulink url="http://kpoker.sourceforge.net/">http://kpoker.sourceforge.net/</ulink></para> +</listitem> +<listitem> +<para>The &kde; homepage: &kde-http;</para> +</listitem> +</itemizedlist> + +</sect1> +</chapter> + + +<chapter id="new-game"> +<title>Starting a new game</title> + +<para>You can start a new game two ways:</para> + +<orderedlist> + +<listitem><para>By selecting <menuchoice> <guimenu>Game</guimenu> +<guimenuitem>New</guimenuitem></menuchoice> from the +menubar.</para></listitem> + +<listitem><para>Selecting <keycombo +action="simul">&Ctrl;<keycap>N</keycap></keycombo></para></listitem> +</orderedlist> + +<para>Either way, you will be presented with a dialog box.</para> + +<screenshot> +<screeninfo><acronym>AI</acronym> Configure Dialog</screeninfo> +<mediaobject> +<imageobject><imagedata fileref="kpoker2.png" format="PNG"/></imageobject> +<textobject><phrase><acronym>AI</acronym> Configure Dialog</phrase></textobject> +</mediaobject> +</screenshot> + +<variablelist> +<varlistentry> +<term><guilabel>How many players do you want?</guilabel></term> +<listitem><para>Will determine if you play a <link linkend="one-player-game">one +player game</link> (against the house), or a <link linkend="two-player-game">two +player game</link>.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Your name:</guilabel></term> +<listitem><para>Lets you personalize &kpoker; so that it calls you by name +(instead of <guilabel>You</guilabel>you>).</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Player's starting money:</guilabel></term> +<listitem><para>Lets you set the money you start each game +with.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>The names of your opponents:</guilabel></term> +<listitem><para> lets you set the name of the other player.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Show this dialog every time on +startup</guilabel></term> +<listitem><para>If this is checked, the first game after you start +&kpoker; will show this menu. If this option is not checked, then the +game will not show this menu for the first game.</para></listitem> +</varlistentry> +</variablelist> + +<para>When you are satisfied with your settings, click +<guibutton>OK</guibutton>, to start the game. Clicking +<guibutton>Cancel</guibutton>, will cancel the start of a new +game.</para> + +</chapter> + +<chapter id="one-player-game"> +<title>One player game</title> + +<sect1 id="how-do-i-play"> +<title>How do I play ?</title> + +<para>At the beginning of the game you get $100. You draw five cards +and decide which ones you want to keep. You indicate which cards you +want to keep by clicking on the face of the card. The word +<guilabel>Held</guilabel> will appear above the card.</para> + +<para>After doing this you draw new cards for those you did not want +to keep. This is accomplished by clicking on +<guibutton>Draw New Cards</guibutton>.</para> + +<para> The game now looks if you have any <link linkend="hands">poker +hand</link> and gives cash according to the kind of hand you got (see +<link linkend="scoring">scoring</link>). </para> + +<para>Now you start over, drawing five cards, deciding which ones you want to +keep ...</para> + +<para>The game ends if you can not pay for another round or if you close the +&kpoker; window.</para> + +</sect1> + +<sect1 id="hands"> +<title>What are possible poker hands ?</title> + +<para>Possible poker hands are:</para> + +<variablelist> +<varlistentry> +<term>Jacks or higher</term> +<listitem><para>Two cards of the same rank, both Jacks or +higher</para></listitem> +</varlistentry> + +<varlistentry> +<term>Two pairs</term> +<listitem><para>Two cards of one rank and two cards of another +rank</para></listitem> +</varlistentry> + +<varlistentry> +<term>Three of a kind</term> +<listitem><para>Three cards of the same rank</para></listitem> +</varlistentry> + +<varlistentry> +<term>Four of a kind</term> +<listitem><para>Four cards of the same rank</para></listitem> +</varlistentry> + +<varlistentry> +<term>Full House</term> +<listitem><para>Three cards of one rank and two cards of +another</para></listitem> +</varlistentry> + +<varlistentry> +<term>Straight</term> +<listitem><para>Five cards of consecutive rank including the combo +ace-2-3-4-5</para></listitem> +</varlistentry> + +<varlistentry> +<term>Flush</term> +<listitem><para>Five cards of the same suit</para></listitem> +</varlistentry> + +<varlistentry> +<term>Straight flush</term> +<listitem><para>Five cards of the same suit and of consecutive +rank</para></listitem> +</varlistentry> + +<varlistentry> +<term>Royal flush</term> +<listitem><para>Ace, king, queen, jack, and ten of the same +suit</para></listitem> +</varlistentry> +</variablelist> + +</sect1> + +<sect1 id="scoring"> + +<title>How many bucks do I get for what hand ? </title> + +<informaltable> +<tgroup cols="2"> +<tbody> + +<row> +<entry>A pair of Jacks or higher cards</entry><entry>$5</entry></row> +<row><entry> Two Pairs</entry><entry> $10</entry></row> +<row><entry> Three of a kind</entry><entry> $15</entry></row> +<row><entry> Straight</entry><entry> $20</entry></row> +<row><entry> Flush</entry><entry> $25</entry></row> +<row><entry> Full House</entry><entry> $40</entry></row> +<row><entry> Four of a kind</entry><entry> $125</entry></row> +<row><entry> Straight Flush</entry><entry> $250</entry></row> +<row><entry> Royal Flush</entry><entry>$2000</entry></row> +</tbody> +</tgroup> +</informaltable> + +</sect1> +</chapter> + +<chapter id="two-player-game"> +<title>Two player game</title> + +<para>The two player game is very different from a <link +linkend="one-player-game">one player game</link>.</para> + +<sect1 id="two-player"> +<title>Starting a two player game</title> + +<para>To start a two player game, select <menuchoice><guimenu>Game</guimenu> +<guimenuitem>New</guimenuitem> </menuchoice> on the menubar. This will +bring up a dialog. Simply select the number of players on the slider or +in the spinbox labeled <guilabel>How many players do you want?</guilabel>. +Then click <guibutton>OK</guibutton>.</para> +</sect1> + +<sect1 id="two-player-play"> +<title>Playing a two player game</title> + +<para>There are four phases to a two-player game:</para> + +<procedure> +<step><para>you begin to draw cards</para></step> +<step><para>then you bet some money</para></step> +<step><para>after that you exchange your cards</para></step> +<step><para>then you raise and finally you will see the cards of the other +player and the winner will get all the +money.</para></step></procedure> + +<variablelist> +<varlistentry> +<term>Draw</term> +<listitem><para>You will begin the game with $100. After clicking on the +<guibutton>Draw New Cards</guibutton> +button you will get five cards. That's all, here.</para></listitem> +</varlistentry> + +<varlistentry> +<term>Bet</term> +<listitem><para>Now you decide if your cards are good or +not. If they are, you bet some money - at least $5 and maximal $20. Just click +on the <guibutton>+$5</guibutton> and similar buttons.</para></listitem> +</varlistentry> + +<varlistentry><term>Exchange</term> +<listitem><para>Now you decide which cards you want to keep. Click on +them. If you have a royal flush then don't exchange any cards! When +you think you are ready then click again on the <guibutton>Draw New Cards</guibutton> +button - you will probably get new cards.</para> + +<para>Perhaps you do not get new cards - then the computer player has +quite good cards (or at least not very bad cards) and he has +raised. You have to decide to adjust your bet or to get out of the +round. By default you will adjust your bet. Click again on the +<guibutton>Draw New Cards</guibutton> button when ready.</para></listitem> +</varlistentry> + +<varlistentry> +<term>Raise</term> + +<listitem> <para>After you got new cards you are allowed to raise a +little bit. It is the same as the bet phase so I don't explain it +again. Click on the draw button (which is now labeled with +<guilabel>See!</guilabel>) when ready. </para></listitem> +</varlistentry> + +<varlistentry> +<term>See / Draw</term> +<listitem><para>I know I said there are four phases and this one is the +fifth. But it is nearly the same as the draw phase. You will also see the cards +of the computer player and the winning cards are blinking. The winner gets all +money. Click on draw to begin a new round!</para> + +<note><para>The blinking cards are not necessarily the best cards of +that player. Only the cards which caused the win are blinking. So if +you have two pairs (⪚ 2 * 2 and 2 * 3) and an ace, but only the ace +is blinking, then the computer player also has these two pairs (2 * 2 +and 2 * 3) but not an ace.</para></note></listitem> +</varlistentry> +</variablelist> + +</sect1> + +</chapter> + +<chapter id="command"> +<title>Commands and Keyboard Shortcuts</title> + +<para>The following sections briefly describe each menubar option.</para> + +<sect1 id="game-menu"> +<title><guimenu>Game</guimenu> Menu</title> + +<para>The <guimenu>Game</guimenu> menu consists of three options.</para> + +<variablelist> +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo> +</shortcut> +<guimenu>Game</guimenu> +<guimenuitem>New</guimenuitem> </menuchoice></term> +<listitem><para><action>Starts a new game</action> of &kpoker;. For more +information, see the section entitled <link linkend="new-game">Starting a new +game</link>.</para></listitem> +</varlistentry> +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo> +</shortcut> +<guimenu>Game</guimenu> +<guimenuitem>Save</guimenuitem> </menuchoice></term> +<listitem><para><action>Saves your current game</action> to disk. This will +replace any previously saved games.</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><action>Quits</action> &kpoker;</para></listitem> +</varlistentry> +</variablelist> +</sect1> + +<sect1 id="settings-menu"> +<title><guimenu>Settings</guimenu> Menu</title> + +<para>The settings menu is used to adjust the sound, look and behavior of &kpoker;.</para> + +<variablelist> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>M</keycap></keycombo> +</shortcut> +<guimenu>Settings</guimenu><guimenuitem>Show Menubar</guimenuitem></menuchoice></term> +<listitem><para>This toggles the menubar on or off. If it is off, and you need to use the menubar, you can right click in the playing area of &kpoker; and a menu will appear. You can then select <guilabel>Show Menubar</guilabel> to turn it back on.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu><guimenuitem>Show Statusbar</guimenuitem></menuchoice></term> +<listitem><para>This option will <action>toggle the status bar on or +off</action>. The status bar is located at the bottom of the &kpoker; window, and contains instructions for play, and how much you won on the previous hand.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu><guimenuitem>Sound</guimenuitem></menuchoice></term> +<listitem><para>This option will <action>toggle the sound on or +off</action>.</para></listitem> +</varlistentry> +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Blinking Cards</guimenuitem></menuchoice></term> +<listitem><para>If this option has a check beside it, then when you win a hand, +the <action>cards which won you the money will blink</action>. If this option +is not checked, no cards blink.</para></listitem> +</varlistentry> +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu><guimenuitem>Adjust Bet is +Default.</guimenuitem></menuchoice></term> +<listitem><para>If this option does not have a check in front of it, and you are +playing a 2 person game, you will be responsible for clicking <guibutton>Adjust +Bet</guibutton>, if your opponent raises the stakes, because the default action +will be to <quote>fold</quote> your hand in defeat.</para> +<para>If, on the other hand, the option does have a check in front of it, and +you are in the same situation, the default action of the game, is to match your +opponents bet, and you will be responsible for folding your +hand.</para></listitem> +</varlistentry> +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu><guimenuitem>Save +Settings</guimenuitem></menuchoice></term> +<listitem><para>This saves all your options to your hard drive. These options +will be restored automatically when you restart &kpoker;.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Shortcuts...</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Customize the keyboard shortcuts.</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu><guimenuitem>Configure Carddecks...</guimenuitem></menuchoice></term> +<listitem><para>This will open a new window where you can select the front and back of the cards for &kpoker;.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu><guimenuitem>Configure KPoker...</guimenuitem></menuchoice></term> +<listitem><para>This opens a dialog box.</para> +<screenshot> +<screeninfo>AI Configure Dialog</screeninfo> +<mediaobject> +<imageobject><imagedata fileref="kpoker1.png" format="PNG"/></imageobject> +</mediaobject> +</screenshot> +<para>There are either one or three options to adjust:</para> + +<para>The top text box determines in milliseconds how long to delay +before showing the next card. This can be used to speed up the deals, +if you are not interested in the more realistic default speed.</para> + +<para>The text box labeled <guilabel>Maximal bet:</guilabel>, +determines the maximum bet for each hand.</para> + +<para>The text box labeled <guilabel>Minimal bet:</guilabel> determines +the smallest allowable bet for each hand.</para> + +<note><para>The <guilabel>Maximal bet:</guilabel> and <guilabel>Minimal +bet:</guilabel> lines are not shown in one player mode. In single +player mode, only the card delay can be adjusted.</para></note> + +<para>As you can see, the changes will not go into effect until a new +round is started.</para> + +</listitem> +</varlistentry> +</variablelist> + +</sect1> + +<sect1 id="help-menu"> +<title><guimenu>Help</guimenu> Menu</title> + +&help.menu.documentation; + +</sect1> + +<sect1 id="keys"> +<title>Default Keyboard Shortcuts</title> + +<informaltable> +<tgroup cols="2"> +<thead><row><entry>Key Combo</entry><entry>Action</entry></row></thead> +<tbody> +<row><entry><keycap>&Enter;</keycap></entry><entry>Draw</entry></row> +<row><entry><keycap>1</keycap></entry><entry>Exchange Card 1</entry></row> +<row><entry><keycap>2</keycap></entry><entry>Exchange Card 2</entry></row> +<row><entry><keycap>3</keycap></entry><entry>Exchange Card 3</entry></row> +<row><entry><keycap>4</keycap></entry><entry>Exchange Card 4</entry></row> +<row><entry><keycap>5</keycap></entry><entry>Exchange Card 5</entry></row> +<row><entry><keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo></entry><entry>Quit &kpoker;</entry></row> +<row><entry><keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo></entry><entry>New Game</entry></row> +<row><entry><keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo></entry><entry>Save Game</entry></row> +<row><entry><keycombo action="simul">&Ctrl;<keycap>M</keycap></keycombo></entry><entry>Show Menubar</entry></row> +<row><entry><keycombo action="simul">&Ctrl;<keycap>F1</keycap></keycombo></entry><entry><quote>What's This</quote> Help</entry></row> +<row><entry><keycombo action="simul"><keycap>F1</keycap></keycombo></entry><entry>Help Contents</entry></row> +</tbody> +</tgroup> +</informaltable> +</sect1> +</chapter> +<chapter id="credits"><title>Credits and License</title> + +<para>&kpoker;</para> + +<para> +Program copyright 1997-2000 &Jochen.Tuchbreiter;&Jochen.Tuchbreiter.mail;, &Andreas.Beckermann; &Andreas.Beckermann.mail;</para> +<para>Persons helping me:</para> +<itemizedlist> +<listitem><para>Chris Holmes - idea of writing this game and for parts of the +visual appearance</para></listitem> +<listitem><para>John Fitzgibbon - provided the card images</para></listitem> +<listitem><para>Nico Schirwing - drew the backs of the cards</para></listitem> +<listitem><para>&Andreas.Beckermann; - currently maintaining the game</para></listitem> +</itemizedlist> + +<para>Documentation updated for &kde; 2.0 by &Mike.McBride; +&Mike.McBride.mail;</para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +&underFDL; +&underGPL; + +</chapter> + +<appendix id="installation"> +<title>Installation</title> + +<sect1 id="getting-kpoker"> +<title>How to obtain &kpoker;</title> + +&install.intro.documentation; + +</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: +--> + diff --git a/doc/kpoker/kpoker1.png b/doc/kpoker/kpoker1.png Binary files differnew file mode 100644 index 00000000..bd409a6e --- /dev/null +++ b/doc/kpoker/kpoker1.png diff --git a/doc/kpoker/kpoker2.png b/doc/kpoker/kpoker2.png Binary files differnew file mode 100644 index 00000000..c03cd62a --- /dev/null +++ b/doc/kpoker/kpoker2.png diff --git a/doc/kreversi/Makefile.am b/doc/kreversi/Makefile.am new file mode 100644 index 00000000..368fc0da --- /dev/null +++ b/doc/kreversi/Makefile.am @@ -0,0 +1,4 @@ + +KDE_DOCS = AUTO +KDE_LANG = en + diff --git a/doc/kreversi/index.docbook b/doc/kreversi/index.docbook new file mode 100644 index 00000000..90a8a77e --- /dev/null +++ b/doc/kreversi/index.docbook @@ -0,0 +1,533 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY kappname "&kreversi;"> + <!ENTITY package "kdegames"> + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE" > <!-- change language only here --> +]> + +<book lang="&language;"> +<bookinfo> +<title>The &kreversi; Handbook</title> + +<authorgroup> + +<author> +<firstname>Clay</firstname> +<surname>Pradarits</surname> +<affiliation> +<address>&Clay.Pradarits.mail;</address> +</affiliation> +</author> + +<othercredit role="developer"> +<firstname>Mario</firstname> +<surname>Weilguni</surname> +<affiliation> +<address>&Mario.Weilguni.mail;</address></affiliation> +<contrib>Developer</contrib> +</othercredit> + +<othercredit role="reviewer"> +<firstname>Lauri</firstname> +<surname>Watts</surname> +<contrib>Reviewer</contrib> +<affiliation><address> +&Lauri.Watts.mail; +</address></affiliation> +</othercredit> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> + +</authorgroup> + +<date>2005-12-14</date> +<releaseinfo>1.7</releaseinfo> + +<abstract><para>&kreversi; is a simple one player strategy game.</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>kdegames</keyword> +<keyword>game</keyword> +<keyword>KReversi</keyword> +</keywordset> +</bookinfo> + +<chapter id="Introduction"> +<title>Introduction</title> + +<sect1 id="what-is-kreversi"> +<title>What is &kreversi;?</title> + +<para>&kreversi; is a simple one player strategy game played against the +computer. The playing field is an 8 by 8 square board divided into 64 +squares. The game piece used is a colored stone - one side of it is red, the +other blue. If a piece is captured by an opposing player, that piece is turned +to reveal the color of that player. A winner is declared when one player has +more pieces of his own color on the board and if there are no more possible +moves.</para> + +</sect1> + +<sect1 id="object-of-the-game"> +<title>Object of the Game</title> + +<para>The object of the game is to control the majority of squares on the +board.</para> + +</sect1> +</chapter> + + + +<chapter id="Playing"> +<title>Playing</title> + +<sect1 id="basics"> +<title>Basics</title> + +<para>A move consists of outflanking your opponents disc(s), then flipping the +outflanked disc(s) to reveal your color. A move is performed by placing the +mouse pointer over the desired square then &LMB; click.</para> + +<para>To outflank means to place a disc on the board so that your opponent's +row(s) of disc(s) is bordered at each end by a disc of your color. A row may be +made up of one or more discs.</para> + +<para>The game starts with each player having two discs automatically placed +in the center four squares of the board in the following pattern:</para> + +<screenshot> +<screeninfo>&kreversi; opening position</screeninfo> +<mediaobject> +<imageobject><imagedata fileref="kreversi1.png" format="PNG"/></imageobject> +<textobject><phrase>&kreversi; opening position</phrase></textobject> +<caption><para>Board Layout</para></caption> +</mediaobject> +</screenshot> + +<variablelist> +<varlistentry> +<term><interface>Menu Bar</interface></term> +<listitem> +<para>The <interface>Menu Bar</interface> contains several choices of +drop-down menus. These are <link +linkend="game-menu"><guimenu>Game</guimenu></link>, <link +linkend="move-menu"><guimenu>Move</guimenu></link>, <link +linkend="view-menu"><guimenu>View</guimenu></link>, <link +linkend="settings-menu"><guimenu>Settings</guimenu></link>, and <link +linkend="help-menu"><guimenu>Help</guimenu></link>. Click with the &LMB; or +<keycombo action="simul">&Alt;<keycap>the underlined +letter</keycap></keycombo> to show the drop-down menu.</para> +</listitem> +</varlistentry> +</variablelist> + +<variablelist> +<varlistentry> +<term><interface>Toolbar</interface></term> +<listitem><para>Provides the player with icon shortcuts for commonly +used actions. These are <guiicon>New</guiicon>, +<guiicon>Stop Thinking</guiicon>, <guiicon>Continue Thinking</guiicon>, +<guiicon>Undo</guiicon>, <guiicon>Show Menubar</guiicon>, <guiicon>Hint</guiicon>, +<guiicon>Show Last Move</guiicon>, and <guiicon>Show Legal Moves</guiicon>. +Place the mouse pointer over any of these icons and click with the &LMB; to +activate.</para></listitem> +</varlistentry> +</variablelist> + +<variablelist> +<varlistentry> +<term><interface>Game Board</interface></term> +<listitem><para>The game board consists of a 8 by 8 square board +divided into 64 squares.</para></listitem> +</varlistentry> +</variablelist> + +<variablelist> +<varlistentry> +<term><interface>Status Bar</interface></term> +<listitem><para>The status bar displays whose turn it is.</para></listitem> +</varlistentry> +</variablelist> + +<para>The field on the right side of the game board contains useful information such as +which color represents each player, the number of +squares each player controls on the board and displays all moves in the current game.</para> +</sect1> + +<sect1 id="Rules"> +<title>Rules</title> + +<para>Blue always moves first.</para> + +<para>If on your turn you cannot outflank and flip at least one +opposing disc, your turn is forfeited and your opponent moves +again. However, if a move is available to you, you may not forfeit +your turn.</para> + +<para>A disc may outflank any number of discs in one or more rows in +any number of directions at the same time - horizontally, vertically +or diagonally. A row is defined as one or more discs in a continuous +straight line. </para> + +<para>You may not skip over your own color disc to outflank an +opposing disc.</para> + +<para>Discs may only be outflanked as a direct result of a move and +must fall in the direct line of the disc placed down.</para> + +<para>All discs outflanked in any one move must be flipped, even if it +is to the player's advantage not to flip them.</para> + +<para>Once a disc is placed on a square, it can never be moved to +another square later in the game.</para> + +<para>When it is no longer possible for either player to move, the +game is over. Discs are then counted and the player with the majority +of his or her color discs on the board is declared the winner.</para> + +<note><para>It is possible for a game to end before all 64 squares are +filled.</para></note> + +</sect1> + +<sect1 id="tips"> +<title>Tips</title> + +<para>Try to place pieces on the edges whenever possible. Your +opponent cannot outflank these pieces.</para> + +<para>Avoid placing pieces on one of the three neighbor fields of a +corner unless you are absolutely sure that your opponent will not be +able to put a piece on a corner.</para> + +<para>Sometimes it is better to offer some pieces to your +opponent</para> + +<para>Try to put pieces on fields which prevent your opponent from +moving.</para> + +<para>Try to force your opponent to put a piece in a neighboring field +of a corner.</para> + +</sect1> + +</chapter> + +<chapter id="user-interface"> +<title>User Interface</title> + +<sect1 id="game-menu"> +<title><guimenu>Game</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice><shortcut><keycombo +action="simul">&Ctrl;<keycap>N</keycap></keycombo></shortcut> +<guimenu>Game</guimenu><guimenuitem>New</guimenuitem></menuchoice></term> +<listitem><para>Starts a new game. +</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><shortcut><keycombo +action="simul">&Ctrl;<keycap>O</keycap></keycombo></shortcut> +<guimenu>Game</guimenu><guimenuitem>Load...</guimenuitem></menuchoice></term> +<listitem><para>Loads a saved game. +</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><shortcut><keycombo +action="simul">&Ctrl;<keycap>S</keycap></keycombo></shortcut> +<guimenu>Game</guimenu><guimenuitem>Save</guimenuitem></menuchoice></term> +<listitem><para>Saves the current game. +</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>Opens a dialog that displays different high score tables. +<guibutton>Export</guibutton> the high scores into a file or click on +<guibutton>Configure</guibutton> to open a dialog to customize your +Nickname and add a Comment.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><shortcut><keycombo +action="simul">&Ctrl;<keycap>Q</keycap></keycombo></shortcut> +<guimenu>File</guimenu><guimenuitem>Quit</guimenuitem></menuchoice></term> +<listitem><para>Quits &kreversi;.</para></listitem> +</varlistentry> +</variablelist> +</sect1> + +<sect1 id="move-menu"> +<title><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>Removes your last move as well as the computer's last +move from the board. +</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><shortcut><keycap>H</keycap></shortcut><guimenu>Move</guimenu><guimenuitem>Hint</guimenuitem> +</menuchoice></term> +<listitem><para>The computer will provide a hint for your next +move.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenu>Move</guimenu><guimenuitem>Switch +Sides</guimenuitem></menuchoice></term> +<listitem><para>Will make you the opposite color.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><shortcut><keycap>Escape</keycap></shortcut> +<guimenu>Move</guimenu><guimenuitem>Stop +Thinking</guimenuitem></menuchoice></term> +<listitem><para>Stops the computer's depth search, then you choose the +computer's next move, or select the <guimenuitem>Continue Thinking</guimenuitem> +menu item to continue the computer's thinking process.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenu>Move</guimenu> +<guimenuitem>Continue Thinking</guimenuitem></menuchoice></term> +<listitem><para>Continue the computer's thinking process if it was +previously stopped using the <guimenuitem>Stop Thinking</guimenuitem> menu +item. +</para></listitem> +</varlistentry> +</variablelist> +</sect1> + +<sect1 id="view-menu"> +<title><guimenu>View</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice><shortcut><keycombo +action="simul">&Ctrl;<keycap>+</keycap></keycombo></shortcut> +<guimenu>View</guimenu><guimenuitem>Zoom In</guimenuitem></menuchoice></term> +<listitem><para>Enlarges the game board.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><shortcut><keycombo +action="simul">&Ctrl;<keycap>-</keycap></keycombo></shortcut> +<guimenu>View</guimenu><guimenuitem>Zoom Out</guimenuitem></menuchoice></term> +<listitem><para>Shrinks the game board.</para></listitem> +</varlistentry> +</variablelist> +</sect1> + +<sect1 id="settings-menu"> +<title><guimenu>Settings</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>M</keycap></keycombo></shortcut><guimenu>Settings</guimenu> +<guimenuitem>Hide Menubar</guimenuitem></menuchoice></term> +<listitem><para>Toggles whether the menubar is visible.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guisubmenu>Toolbars</guisubmenu> +<guimenuitem>Main Toolbar (&kreversi;)</guimenuitem> +</menuchoice></term> +<listitem><para><action>Toggle</action> the <guilabel>Main Toolbar</guilabel></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guisubmenu>Toolbars</guisubmenu> +<guimenuitem>View Toolbar (&kreversi;)</guimenuitem> +</menuchoice></term> +<listitem><para><action>Toggle</action> the <guilabel>View Toolbar</guilabel></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenu>Settings</guimenu> +<guimenuitem>Configure Shortcuts...</guimenuitem></menuchoice></term> +<listitem><para>Opens a dialog which lets you configure all the keyboard shortcuts which +are available in &kreversi;.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Toolbars...</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Open a dialog where you can configure the toolbars</action> for &kreversi;</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenu>Settings</guimenu> +<guimenuitem>Configure &kreversi;...</guimenuitem></menuchoice></term> +<listitem><para>Opens the <link linkend="configuration">configuration +dialog</link> which lets you tweak a lot of &kreversi;'s +options.</para></listitem> +</varlistentry> +</variablelist> +</sect1> + +<sect1 id="help-menu"> +<title><guimenu>Help</guimenu> Menu</title> + +&help.menu.documentation; + +</sect1> +</chapter> + +<chapter id="configuration"> +<title>Configuration</title> + +<para>Selecting the <menuchoice><guimenu>Settings</guimenu> +<guimenuitem>Configure &kreversi;...</guimenuitem></menuchoice> menu item will +open a configuration dialog which lets you adjust many of &kreversi;'s +options.</para> + +<screenshot> +<screeninfo>&kreversi; configuration dialog</screeninfo> +<mediaobject> +<imageobject><imagedata fileref="kreversi-configuration.png" format="PNG"/></imageobject> +<textobject><phrase>&kreversi; configuration dialog</phrase></textobject> +</mediaobject> +</screenshot> + +<variablelist> +<varlistentry> +<term><guilabel>Grayscale chips</guilabel></term> +<listitem><para>Check this box to use grayscale chips instead of blue and +red ones; this might improve the look on very low color +displays.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Play Game</guilabel></term> +<listitem><para>Check a radiobutton whether to play <guilabel>Casually</guilabel> +or <guilabel>Competitively</guilabel>.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Animation</guilabel></term> +<listitem><para>If this option is checked, a short animation will be shown +when a disc changes it's color.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Animation Speed</guilabel></term> +<listitem><para>If the <guilabel>Animation</guilabel> option is enabled, you +can use this slider to define how fast the animation should be played; move the +slider to the left for a slower animation, moving the slider to the right will +play the animation faster.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Computer Skill</guilabel></term> +<listitem><para>This slider lets you define the skill level of the computer +player. There are seven different skill levels available, ranging from beginner +to expert. Move the slider to the left for an easier opponent, or to the right +to get a more difficult opponent.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Background</guilabel></term> +<listitem><para>Here you can define the appearance of the playground. Select +the <guilabel>Color:</guilabel> option and press the colored button at the right +if you want the background to have a single color. Select the +<guilabel>Image:</guilabel> option and enter the path to a picture in the input +field at the right in case you want to use a specific image as the background +wallpaper.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guibutton>Help</guibutton></term> +<listitem><para>Opens &kreversi; help.</para></listitem></varlistentry> + +<varlistentry> +<term><guibutton>Defaults</guibutton></term> +<listitem><para>Reverts settings to defaults.</para></listitem></varlistentry> + +<varlistentry> +<term><guibutton>OK</guibutton></term> +<listitem><para>Saves changes and closes dialog.</para></listitem></varlistentry> + +<varlistentry> +<term><guibutton>Apply</guibutton></term> +<listitem><para>Saves changes but doesn't close dialog.</para></listitem></varlistentry> + +<varlistentry> +<term><guibutton>Cancel</guibutton></term> +<listitem><para>Cancels all your changes and closes the dialog.</para></listitem></varlistentry> + +</variablelist> +</chapter> + +<chapter id="credits-and-license"> +<title>Credits and License</title> + +<para>Program Copyright 1998-2000 &Mario.Weilguni;</para> +<para>Mats Luthman - Designer of the move engine.</para> + +<para>Original documentation by &Mario.Weilguni;</para> +<para>Edited by Robert Williams</para> + +<para>Documentation re-written and updated for &kde; 2.0 by &Clay.Pradarits; +&Clay.Pradarits.mail;</para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +&underFDL; +&underGPL; +</chapter> + +<appendix id="Installation"> +<title>Installation</title> + +&install.intro.documentation; + +<sect1 id="compilation-and-installation"> +<title>Compilation and Installation</title> + +&install.compile.documentation; + +</sect1> +</appendix> + +&documentation.index; +</book> +<!-- +Local Variables: +mode: sgml +sgml-omittag: nil +sgml-shorttag: t +End: +--> + + + + + + + + + diff --git a/doc/kreversi/kreversi-configuration.png b/doc/kreversi/kreversi-configuration.png Binary files differnew file mode 100644 index 00000000..9c8df2d0 --- /dev/null +++ b/doc/kreversi/kreversi-configuration.png diff --git a/doc/kreversi/kreversi1.png b/doc/kreversi/kreversi1.png Binary files differnew file mode 100644 index 00000000..fe32be35 --- /dev/null +++ b/doc/kreversi/kreversi1.png diff --git a/doc/ksame/Makefile.am b/doc/ksame/Makefile.am new file mode 100644 index 00000000..368fc0da --- /dev/null +++ b/doc/ksame/Makefile.am @@ -0,0 +1,4 @@ + +KDE_DOCS = AUTO +KDE_LANG = en + diff --git a/doc/ksame/index.docbook b/doc/ksame/index.docbook new file mode 100644 index 00000000..4e9cb5e9 --- /dev/null +++ b/doc/ksame/index.docbook @@ -0,0 +1,295 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY kappname "&ksame;"> + <!ENTITY package "kdegames"> + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE"> +]> + +<book lang="&language;"> + +<bookinfo> +<title>The &ksame; Handbook</title> + +<authorgroup> +<author> +<firstname>Nicholas</firstname> +<surname>Robbins</surname> +<affiliation> +<address>&Nicholas.Robbins.mail;</address> +</affiliation> +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<copyright> +<year>2000</year> +<holder>Nicholas Robbins</holder> +</copyright> +<legalnotice>&FDLNotice;</legalnotice> + +<date>2005-12-17</date> +<releaseinfo>0.5.1</releaseinfo> + +<abstract><para>&ksame; is a nice little program meant to amuse you for +anywhere from 3 minutes to 6 days (straight).</para></abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>kdegames</keyword> +<keyword>ksame</keyword> +</keywordset> + +</bookinfo> + +<chapter id="introduction"> +<title>Introduction</title> + +<para>&ksame; is a simple game. It is played by one player, so there is only one +winner :-) You play for fun and against the high score. It has been inspired by +SameGame, which is only really famous on the Macintosh. </para> + +<para>In 1997 &Stephan.Kulow; and Marcus Kreutzberger wrote <foreignphrase +lang="de">Probiere</foreignphrase> (a German pun). It was their first attempt to +write a X11 application. They decided that it would be a good idea to port it to +&kde;, and here we are.</para> + +</chapter> + + +<chapter id="using-ksame"> +<title>Using &ksame;</title> + +<para>A very simple premise. There are a bunch of marbles. Get rid of them +all. ;-)</para> + +<para>You can erase same marbles when they are connected vertically or +horizontally when you click them. If there are pieces over the erased ones, +they will drop down. If all of the pieces on the vertical line are erased, all +pieces on the right side will slide to the left.</para> + +<para>The score is calculated as follows:</para> +<para>Subtract 2 from the number of marbles erased, and square the result.</para> +<para>As an example, if you erase 7 balls, then you get 25 points (7 minus 2 = 5. 5 squared is 25 points).If you erase 8 +balls, then you get 36 points (8 minus 2 = 6. 6 squared is 36 points.</para> + +<para>Get as many of the +same pieces as you can, and then erase them in one click. That way you will get +a higher score. The game is over when there are no pieces that can be +erased.</para> + +<para>The score will then be decreased according to the number of remaining +pieces. If you erase all pieces 1,000 bonus points will be added to the final +score.</para> + + +<sect1 id="ksame-features"> +<title>More &ksame; Features</title> + +<para>&ksame; is wonderful in that it will allow you to kill 5 minutes while you +wait for that program to compile.</para> + +<para> Or, if nothing else, it will allow you to kill 5 minutes.</para> + +</sect1> +</chapter> + +<chapter id="commands"> +<title>Command Reference</title> + +<sect1 id="ksame-mainwindow"> +<title>The Main &ksame; Window</title> + +<para>There is a large area with lots of marbles. Underneath is the status +bar. Above is the menu bar.</para> + +<sect2 id="gamemenu"> +<title>The <guimenu>Game</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo> +</shortcut> +<guimenu>Game</guimenu> +<guimenuitem>New</guimenuitem> +</menuchoice></term> +<listitem><para>Starts a new game. If <guisubmenu>Settings</guisubmenu> +<guimenuitem>Random Board</guimenuitem> is enabled, a random game is started. +Otherwise you are presented a dialog in which you can choose a specific board. +</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>R</keycap></keycombo> +</shortcut> +<guimenu>Game</guimenu> +<guimenuitem>Restart This Board</guimenuitem> +</menuchoice></term> +<listitem><para>Restarts the current board.</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>Displays the high score table.</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>Quits &ksame;.</para></listitem> +</varlistentry> +</variablelist> + +</sect2> + +<sect2> +<title>The <guimenu>Edit</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>Z</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Undo</guimenuitem> +</menuchoice></term> +<listitem><para>This will undo the last move.</para></listitem> +</varlistentry> +</variablelist> + +</sect2> + +<sect2> +<title>The <guimenu>Settings</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Random Board</guimenuitem> +</menuchoice></term> +<listitem><para>Enabling this will make the <guimenu>Game</guimenu> +<guimenuitem>New</guimenuitem> start with a random board instead of letting +you choose a specific board.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Show Number Remaining</guimenuitem> +</menuchoice></term> +<listitem><para>Displays the remaining numbers of marbles for each color in the status bar.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Shortcuts...</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Configure</action> the keyboard keys you use to access the +different actions.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Notifications...</guimenuitem> +</menuchoice></term> +<listitem><para><action>Displays a standard &kde; notifications +configuration dialog to change the audio and visual notifications for &ksame;.</action></para></listitem> +</varlistentry> + +</variablelist> + +</sect2> + +<sect2 id="helpmenu"> +<title>The <guimenu>Help</guimenu> Menu</title> + +&help.menu.documentation; + +</sect2> +</sect1> + +</chapter> + +<chapter id="credits"> + +<title>Credits and License</title> + +<para>&ksame;</para> + +<para>Program copyright 1997 Marcus Kreutzberger +<email>kreutzbe@informatik.mu-luebeck.de</email></para> +<para>Contributors:</para> +<itemizedlist> +<listitem><para>&Stephan.Kulow; &Stephan.Kulow.mail;</para> +</listitem> +</itemizedlist> + +<para>Documentation copyright 2000 Nicholas R. Robbins +<email>logik9000@home.com</email></para> +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +&underFDL; <!-- FDL: do not remove --> + + +&underGPL; <!-- GPL License --> + +</chapter> + +<appendix id="installation"> +<title>Installation</title> + +<sect1 id="getting-ksame"> +<title>How to obtain &ksame;</title> + +&install.intro.documentation; + +</sect1> + +<sect1 id="requirements"> +<title>Requirements</title> + +<para>In order to successfully use &ksame;, you need &kde; 3.0. Or at least the +kdelibs package. </para> + +</sect1> + +<sect1 id="compilation"> +<title>Compilation and Installation</title> + +&install.compile.documentation; + +</sect1> + +</appendix> + + +&documentation.index; +</book> +<!-- +Local Variables: +sgml-minimize-attributes: nil +sgml-general-insert-case: lower +End: +--> + diff --git a/doc/kshisen/Makefile.am b/doc/kshisen/Makefile.am new file mode 100644 index 00000000..368fc0da --- /dev/null +++ b/doc/kshisen/Makefile.am @@ -0,0 +1,4 @@ + +KDE_DOCS = AUTO +KDE_LANG = en + diff --git a/doc/kshisen/index.docbook b/doc/kshisen/index.docbook new file mode 100644 index 00000000..483c4eb7 --- /dev/null +++ b/doc/kshisen/index.docbook @@ -0,0 +1,423 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY kappname "&kshisen;"> + <!ENTITY package "kdegames"> + <!ENTITY % English "INCLUDE" > <!-- change language only here --> + <!ENTITY % addindex "IGNORE"> +]> + +<book lang="&language;"> +<bookinfo> +<title>The &kshisen; Handbook</title> + +<authorgroup> +<author> +<firstname>Dirk</firstname> +<surname>Doerflinger</surname> +<affiliation> +<address>&Dirk.Doerflinger.mail;</address> +</affiliation> +</author> +<othercredit role="reviewer"> +<firstname>Frerich</firstname><surname>Raabe</surname> +<contrib>Reviewer</contrib> +<affiliation><address>&Frerich.Raabe.mail;</address></affiliation> +</othercredit> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + + +<date>2006-06-17</date> +<releaseinfo>1.5.1</releaseinfo> + +<abstract> +<para>&kshisen; is a game similar to Mahjongg for &kde;.</para> +</abstract> + +<keywordset> + <keyword>KDE</keyword> + <keyword>kdegames</keyword> + <keyword>kshisen</keyword> + <keyword>game</keyword> + <keyword>shisen-sho</keyword> +</keywordset> + +</bookinfo> + + +<chapter id="introduction"> +<title>Introduction</title> + +<para>&kshisen; is a single-player-game similar to Mahjongg and uses the same +set of tiles as Mahjongg.</para> + +<para>The object of the game is to remove all tiles from the field.</para> + +</chapter> + +<chapter id="playing-kshisen"> +<title>Playing &kshisen;</title> + +<sect1 id="rules"> +<title>Rules</title> + +<para>The aim of the game is to remove all tiles from the board. Only two +matching tiles can be removed at a time. Two tiles can only be removed if they +can be connected with a maximum of three connected lines. Lines can be +horizontal or vertical, but not diagonal. </para> + +<para>You don't have to draw the lines by yourself, the game does this for +you. Just mark two matching tiles on the board, if they can be connected with a +maximum of three lines, the lines will be drawn and the tiles are +removed. </para> + +<para>Remember that lines only may cross the empty border. If you are stuck, you +can use the Hint feature to find two tiles which may be removed. Clicking a +tile with the &RMB; will show you all corresponding tiles, no matter if they are +removable at the moment or not.</para> + +<para>The game is over when no moves are possible. This could be due to +clearing all the tiles from the field or reaching a point in the game +where no two matching tiles can be connected by three lines. +Some games are unsolvable, if you would like to avoid unsolvable +games uncheck the option <guilabel>Allow unsolvable +games</guilabel> in the configuration dialog.</para> + +<para>The resulting score <quote>S</quote> is calculated using the +following formula, assuming that <quote>n</quote> represents the +number of tiles present when the game started and <quote>t</quote> +standing for the time (in seconds) it took to clear the +field:</para> + +<mediaobject><imageobject> +<imagedata fileref="score-formula.png" format="PNG"/> +</imageobject><textobject> +<phrase>S=(n/t)*sqrt(n/84)/0.0014</phrase> +</textobject></mediaobject> + +<para>If you played with the <guilabel>Gravity</guilabel> setting enabled, this score +will additionally get multiplied by two.</para> +</sect1> +</chapter> + +<chapter id="menu-reference"> +<title>Menu Reference</title> + +<sect1 id="game-menu"> +<title>The <guimenu>Game</guimenu> Menu</title> + +<para>The <guimenu>Game</guimenu> menu lets you control the status of the +current game:</para> + +<variablelist> +<varlistentry> +<term><menuchoice> +<shortcut><keycombo action="simul">&Ctrl; +<keycap>N</keycap></keycombo></shortcut> +<guimenu>Game</guimenu><guimenuitem>New</guimenuitem></menuchoice></term> +<listitem><para><action>Finish the actual game</action> set and start a new +session with new tiles. </para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut><keycombo><keycap>F5</keycap></keycombo></shortcut> +<guimenu>Game</guimenu><guimenuitem>Restart +Game</guimenuitem></menuchoice></term> +<listitem><para><action>Restart the current game with the same +tiles.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut><keycombo><keycap>P</keycap></keycombo></shortcut> +<guimenu>Game</guimenu> +<guimenuitem>Pause</guimenuitem></menuchoice></term> +<listitem><para><action>Pauses the entire game</action>, especially the timer +which affects the scoring. The menu entry is also used for resuming the +game.</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>Shows the (local) Top-Ten charts of &kshisen;.</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><action>Quits</action> &kshisen;. </para></listitem> +</varlistentry> + +</variablelist> + +<para>Some of the menu items can also be controlled by keykoard shortcuts. +See <xref linkend="key-bindings"/> for a list.</para> + +</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 step</action>. Same as the +<guibutton>Undo</guibutton> button in the toolbar.</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>Redo the last step</action>. Same as the +<guibutton>Redo</guibutton> button in the toolbar.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut><keycombo><keycap>H</keycap></keycombo></shortcut> +<guimenu>Move</guimenu> +<guimenuitem>Hint</guimenuitem></menuchoice></term> +<listitem><para><action>Show a tip</action>, which two tiles to remove +next.</para></listitem> +</varlistentry> + +</variablelist> +</sect1> + +<sect1 id="settings-menu"> +<title>The <guimenu>Settings</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Show Toolbar</guimenuitem> +</menuchoice></term> +<listitem> +<para> +Toggle on and off the display of the toolbar. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Show Statusbar</guimenuitem> +</menuchoice></term> +<listitem> +<para> +Toggle on and off the display of the status bar. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Shortcuts...</guimenuitem> +</menuchoice></term> +<listitem><para> +<action>Open a dialog which lets you redefine all the keyboard shortcuts.</action> +</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Toolbars...</guimenuitem> +</menuchoice></term> +<listitem><para>Displays a &kde; standard dialog where you can configure the toolbar icons.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure &kshisen;...</guimenuitem> +</menuchoice></term> +<listitem> +<para>Opens the <link linkend="configuration">configuration +dialog</link> to change &kshisen; settings. +</para></listitem> +</varlistentry> + +</variablelist> +</sect1> + +<sect1 id="helpmenu"> +<title>The <guimenu>Help</guimenu> Menu</title> + +&help.menu.documentation; + +</sect1> + +<sect1 id="key-bindings"> +<title>Shortcuts</title> + +<para>Default shortcuts are: +</para> + +<informaltable> +<tgroup cols="2"> +<tbody> +<row><entry>New</entry><entry><keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo></entry></row> +<row><entry>Restart Game</entry><entry><keycap>F5</keycap></entry></row> +<row><entry>Pause</entry><entry><keycap>P</keycap></entry></row> +<row><entry>Show Highscores</entry><entry><keycombo action="simul">&Ctrl;<keycap>H</keycap></keycombo></entry></row> +<row><entry>Quit</entry><entry><keycombo action="simul">&Ctrl;<keycap>Q</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>Hint</entry><entry><keycap>H</keycap></entry></row> +<row><entry>&kshisen; Handbook</entry><entry><keycap>F1</keycap></entry></row> +<row><entry>What's This</entry><entry><keycombo action="simul">&Ctrl;&Shift;<keycap>F1</keycap></keycombo></entry></row> +</tbody> +</tgroup> +</informaltable> + +</sect1> +</chapter> + +<chapter id="configuration"> +<title>Configuration</title> + +<para>Selecting the <menuchoice><guimenu>Settings</guimenu> +<guimenuitem>Configure &kshisen;...</guimenuitem></menuchoice> menu item will +open a configuration dialog which lets you alter the behavior of the game.</para> + +<screenshot> +<screeninfo>&kshisen; configuration dialog</screeninfo> +<mediaobject> +<imageobject><imagedata fileref="kshisen-configuration.png" format="PNG"/></imageobject> +<textobject><phrase>&kshisen; configuration dialog</phrase></textobject> +</mediaobject> +</screenshot> + +<variablelist> +<varlistentry> +<term><guilabel>Gravity</guilabel></term> +<listitem><para>Checking this makes the game even harder: If a tile is +removed, all tiles lying above it will fall down one step.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Allow unsolvable games</guilabel></term> +<listitem><para>If checked, only solvable games will be +created when a new game is started. Note: You may still choose the wrong way and +have to try again if you didn't solve the game, but if it's checked, the game +<emphasis>will</emphasis> be solvable.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Board Difficulty</guilabel></term> +<listitem><para>The slider controls the difficulty of the board. There are three +options <guilabel>Easy</guilabel>, <guilabel>Medium</guilabel> and +<guilabel>Hard</guilabel>.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Piece Removal Speed</guilabel></term> +<listitem><para>Adjusting this slider alters the speed at which the pieces are +removed from the screen after a match has been made.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Prefer Unscaled Tiles</guilabel></term> +<listitem><para>Resizing the window causes the tiles on the board to be scaled to +match the window size. When this option is checked, the window is resized to fit +the tiles' natural size. You can still adjust the size of the window. Doing so +causes this mode to be disengaged.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Tile Size</guilabel></term> +<listitem><para>This slider allows you to can change the number of tiles +on the board. The more tiles you have, the harder (and longer) +the game will be.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guibutton>Help</guibutton></term> +<listitem><para>Opens &kshisen; help pages. (this document).</para></listitem></varlistentry> + +<varlistentry> +<term><guibutton>Defaults</guibutton></term> +<listitem><para>Reverts all settings to defaults.</para></listitem></varlistentry> + +<varlistentry> +<term><guibutton>OK</guibutton></term> +<listitem><para>Saves your changes and closes the dialog.</para></listitem></varlistentry> + +<varlistentry> +<term><guibutton>Apply</guibutton></term> +<listitem><para>Saves your changes but doesn't close the dialog.</para></listitem></varlistentry> + +<varlistentry> +<term><guibutton>Cancel</guibutton></term> +<listitem><para>Cancels all your changes and closes the dialog.</para></listitem></varlistentry> + +</variablelist> +</chapter> + +<chapter id="credits"> +<title>Credits and License</title> + +<para> +&kshisen; Copyright 1999 &Mario.Weilguni; +&Mario.Weilguni.mail; +</para> + + +<para> +Documentation Copyright 2000 &Dirk.Doerflinger; +<email>ddoerflinger@gmx.net</email> +</para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +&underFDL; +&underGPL; + +</chapter> + +<appendix id="installation"> +<title>Installation</title> + +<sect1 id="getting-kshisen"> +<title>How to obtain &kshisen;</title> + +&install.intro.documentation; + +</sect1> + +<sect1 id="requirements"> +<title>Requirements</title> + +<para> +In order to successfully compile &kshisen;, you need &kde; 3.x. +All required libraries as well as &kshisen; itself can be found on +&kde-ftp;.</para> +</sect1> + + +<sect1 id="compilation"> +<title>Compilation and Installation</title> + +&install.compile.documentation; + +</sect1> +</appendix> + +</book> + diff --git a/doc/kshisen/kshisen-configuration.png b/doc/kshisen/kshisen-configuration.png Binary files differnew file mode 100644 index 00000000..cbcfb109 --- /dev/null +++ b/doc/kshisen/kshisen-configuration.png diff --git a/doc/kshisen/score-formula.png b/doc/kshisen/score-formula.png Binary files differnew file mode 100644 index 00000000..0dceb581 --- /dev/null +++ b/doc/kshisen/score-formula.png diff --git a/doc/kshisen/score-formula.tex b/doc/kshisen/score-formula.tex new file mode 100644 index 00000000..a50d233d --- /dev/null +++ b/doc/kshisen/score-formula.tex @@ -0,0 +1,18 @@ +\documentclass{article} +\usepackage[psamsfonts]{amssymb} +\usepackage{amsmath} +\newcounter{afg} +\newcommand{\aufgabe}{\stepcounter{afg}\subsubsection*{Aufgabe \arabic{afg}}} + +\renewcommand{\labelenumi}{\alph{enumi})} + +\begin{document} + +\begin{align*} + \text{S} & = \frac{n}{t} \cdot \sqrt{\frac{n}{84}} / 0.0014 \\ + & = \frac{n}{t} \cdot \frac{\sqrt{\frac{n}{84}}}{0.0014} \\ + & = \frac{n}{t} \cdot \frac{\sqrt{n}}{\sqrt{84}\cdot 0.0014} \\ + & = \frac{n}{t} \cdot \frac{\sqrt{n}}{0.012831211946} \\ + & = \frac{\sqrt{n^3}}{0.012831211946\cdot t} \\ +\end{align*} +\end{document} diff --git a/doc/ksirtet/Makefile.am b/doc/ksirtet/Makefile.am new file mode 100644 index 00000000..368fc0da --- /dev/null +++ b/doc/ksirtet/Makefile.am @@ -0,0 +1,4 @@ + +KDE_DOCS = AUTO +KDE_LANG = en + diff --git a/doc/ksirtet/index.docbook b/doc/ksirtet/index.docbook new file mode 100644 index 00000000..524123c0 --- /dev/null +++ b/doc/ksirtet/index.docbook @@ -0,0 +1,586 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY kappname "&ksirtet;"> + <!ENTITY package "kdegames"> + <!ENTITY % English "INCLUDE"> + <!ENTITY % addindex "IGNORE"> +]> + +<book lang="&language;"> +<bookinfo> +<title>The &ksirtet; Handbook</title> +<authorgroup> +<author> +&Nicolas.Hadacek; +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + + +<copyright> +<year>1999</year><year>2000</year> +<holder>&Nicolas.Hadacek;</holder> +</copyright> + +<legalnotice>&FDLNotice;</legalnotice> + +<date>2005-12-17</date> +<releaseinfo>2.1.11b</releaseinfo> + +<abstract> +<para>&ksirtet; is a clone of the well known game Tetris. You must fit the +falling pieces to form full lines.</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>game</keyword> +<keyword>tetris</keyword> +</keywordset> +</bookinfo> + +<chapter id="introduction"> +<title>Introduction</title> + +<para> +&ksirtet; is a clone of the well known game <application>Tetris</application>. You +must fit the falling pieces to form full lines. You can rotate and translate +the falling piece. The game ends when no more pieces can fall, &ie; when your +incomplete lines reach the top of the board. +</para> + +<para> +Every time you have destroyed 10 lines, you advance to the next level and the +pieces fall quicker (to be precise, the pieces fall from the top of the screen each +<literal>1/(1+level)</literal> second). +</para> +</chapter> + +<chapter id="how-to-play"> +<title>How to Play</title> + +<sect1 id="handling-the-falling-piece"> +<title>Handling the Falling Piece</title> + +<para> +You can use the keyboard to rotate, translate or drop down the falling piece. The +keys are configurable via the menu item <menuchoice><guimenu>Settings</guimenu> +<guimenuitem>Configure Shortcuts...</guimenuitem></menuchoice>. +</para> + +</sect1> + +<sect1 id="game-types"> +<title>Game Types</title> +<para>&ksirtet; supports two types of single player game: Normal and Arcade. In +Normal mode, points totals are kept, and high scores recorded. Also, when advancing +to the next level, play continues without clearing the gameboard. In Arcade +mode, no points totals are kept, although an <guilabel>Elapsed time</guilabel> +counter is shown. When you advance to the next level in Arcade mode, the +gameboard is cleared of pieces.</para> +<para>You can choose the game mode in the <guimenu>Mode</guimenu> menu.</para> +</sect1> + +<sect1 id="how-to-gain-points"> +<title>How to gain Points</title> + +<para>There are two sources of points:</para> + +<itemizedlist> +<listitem> +<para> +Dropping down a piece using the <keysym>Down Arrow</keysym> gives a small +number of points which is equal to the drop height. It is not much each time +but is particularly relevant in the earlier levels, when the pieces fall more +slowly. +</para> +</listitem> + +<listitem> +<para> +The biggest part of the score comes from destroying full lines. It is very +important to note that destroying multiple lines at the same time gives you a +lot more points. A four-lines destruction is called a <quote>tetris</quote>: +it gives a maximum amount of points. +</para> + +<para> +The points gained are 40 for a one-liner, 100 for two lines, 300 for three lines +and 1200 for a tetris. These numbers are multiplied by the current +level. For example, destroying four lines in level 10 gives 12,000 points. +</para> +</listitem> +</itemizedlist> + +</sect1> + +<sect1 id="options"> +<title>Configuring &ksirtet;</title> + +<para> +The &ksirtet; configuration is accessed from the menu item +<menuchoice><guimenu>Settings</guimenu> +<guimenuitem>Configure &ksirtet;...</guimenuitem></menuchoice>. The +options are as follows: +</para> + +<sect2 id="game-config"> +<title>Game Configuration</title> + +<variablelist> + +<varlistentry> +<term><guilabel>Initial level:</guilabel></term> +<listitem><para>Set the level which you will play at startup, from 1 (easiest) +to 20 (hardest). Default is level one.</para> +</listitem> +</varlistentry> + +<varlistentry><term><guilabel>Direct drop down</guilabel></term> +<listitem><para>If checked, pressing the <keysym>Down Arrow</keysym> will cause +a tile to immediately fall to the bottom of the screen. If unchecked, pressing +the <keysym>Down Arrow</keysym> only causes the piece to fall until the key is released.</para> +</listitem> +</varlistentry> + +<varlistentry><term><guilabel>Old rotation style</guilabel></term> +<listitem><para>&ksirtet; has two ways of rotating each piece: +<quote>Old</quote> style and <quote>New</quote> style. Each style uses a +different point to rotate the piece around. Try both, and see which one you prefer.</para> +</listitem> +</varlistentry> + +</variablelist> + +</sect2> + +<sect2 id="appearance-config"> +<title>Appearance Configuration</title> + +<variablelist> + +<varlistentry> +<term><guilabel>Enable animations</guilabel></term> +<listitem><para>If checked, pieces are shown with an +animation (a small rebound effect), when they touch the bottom.</para></listitem> +</varlistentry> + +<varlistentry><term><guilabel>Show piece's shadow</guilabel></term> +<listitem><para>If checked, a shadow is placed beneath the game board +showing where the piece will fall.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Show next piece</guilabel></term> +<listitem><para>If checked, shows the next tile that will fall onto the +game board.</para></listitem> +</varlistentry> + +<varlistentry><term><guilabel>Show detailed "removed lines" +field</guilabel></term> <listitem><para>If checked, the <guilabel>Removed +Lines</guilabel> counter on the left of the screen shows how many times each +number of lines have been removed. If unchecked, just the total number removed +is shown.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Background</guilabel></term> +<listitem><para>Select the color and the opacity for &ksirtet; background. +An opacity of zero makes the &ksirtet; background +completely transparent, and a setting of one makes the &ksirtet; background +completely opaque.</para> +</listitem> +</varlistentry> + +</variablelist> +</sect2> + +<sect2 id="colors-config"> +<title>Colors Configuration</title> +<para>Here you can select the colors used for the tiles in &ksirtet;.</para> +</sect2> + +<sect2 id="ai-config"> +<title>A.I. Configuration</title> +<para>Here you can configure the A.I. in &ksirtet;.</para> +</sect2> + +</sect1> + +<sect1 id="highscore-configuration"> +<title>Configuring Highscores</title> +<para> +The configuration is accessed from +<menuchoice><guimenu>Settings</guimenu> +<guimenuitem>Configure Highscores...</guimenuitem></menuchoice>. The +options are as follows: +</para> + +<sect2 id="highscore-main-config"> +<title>The <guilabel>Main</guilabel> Tab</title> + +<variablelist> + +<varlistentry> +<term><guilabel>Nickname:</guilabel></term> +<listitem><para>Displays your current nickname and allows you to change it.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Comment</guilabel></term> +<listitem><para>A comment about yourself. You choose...</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>World-wide highscores enabled</guilabel></term> +<listitem><para>If checked and if you are connected to the Internet, +&ksirtet; will send your score automatically at the end of the game +to the highscore web server (ksirtet.sf.net).</para></listitem> +</varlistentry> + +</variablelist> +</sect2> + +<sect2 id="highscore-advanced-config"> +<title>The <guilabel>Advanced</guilabel> Tab</title> + +<para>This tab displays your <guilabel>Registration Data</guilabel> +on ksirtet.sf.net:</para> + +<variablelist> +<varlistentry> +<term><guilabel>Nickname:</guilabel></term> +<listitem><para>Displays your current nickname from the <guilabel>Main</guilabel> tab.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Key:</guilabel></term> +<listitem><para>This key was generated when you registered on ksirtet.sf.net by +selecting <guilabel>World-wide highscores enabled</guilabel> the first time. +The registration key is used in conjunction with the +nickname to identify uniquely users, but users cannot have the same nickname. +Click on the <guibutton>Remove</guibutton> button to delete you from the world highscores +list.</para> +</listitem> +</varlistentry> +</variablelist> +</sect2> + +</sect1> + +<!-- Old description +<variablelist> +<varlistentry> +<term><guilabel>Show tile's shadow</guilabel></term> +<listitem> +<para> +Shows/hides the shadow of the falling piece at the bottom of the board. This +shadow can help to avoid position error when dropping the piece. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Show next tile</guilabel></term> +<listitem> +<para> +Shows/hides the display of the next piece to come. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Enable animations</guilabel></term> +<listitem> +<para> + +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Block Size</guilabel></term> +<listitem> +<para> +Lets you change the size of the blocks (and increases the playing field to +match. The default size is 15 pixels. +</para> +</listitem> +</varlistentry> +</variablelist> +--> + +</chapter> + +<chapter id="multiplayer"> +<title>Multiplayer</title> + +<para> +The multiplayer option allows you to play with others players on the same computer. +You can also play against an <acronym>AI</acronym> (artificial intelligence) player which is currently not +very good. +</para> + +<para> +Basically when destroying lines, a player sends <quote>garbage</quote> at the +bottom of the game of his next opponent: nothing for one line destroyed, one +garbage line for two lines destroyed and so on. +</para> + +</chapter> + +<chapter id="commands"> +<title>Command Reference</title> + +<sect1 id="ksirtet-mainwindow"> +<title>The Main &ksirtet; Window</title> + +<sect2> +<title>The <guimenu>Game</guimenu> Menu</title> + +<variablelist> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo> +</shortcut> +<guimenu>Game</guimenu> +<guimenuitem>New</guimenuitem> +</menuchoice></term> +<listitem><para><action>Starts a new game.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo><keycap>P</keycap></keycombo> +</shortcut> +<guimenu>Game</guimenu> +<guimenuitem>Pause</guimenuitem> +</menuchoice></term> +<listitem><para><action>Pauses or resumes the game</action></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><action>Opens</action> a dialog that displays different high score tables. +Clicking on the links below the tables downloads world-wide high scores. +<guibutton>Export</guibutton> the high scores into a file or click on +<guibutton>Configure</guibutton> to open a dialog to customize your Nickname and add a Comment. +</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><action>Quits</action> &ksirtet;</para></listitem> +</varlistentry> + +</variablelist> + +</sect2> + +<sect2> +<title>The <guimenu>View</guimenu> Menu</title> + +<variablelist> + +<varlistentry> +<term><menuchoice><shortcut><keycombo action="simul"> +&Ctrl;<keycap>+</keycap></keycombo></shortcut> +<guimenu>View</guimenu> +<guimenuitem>Zoom In</guimenuitem> +</menuchoice></term> +<listitem><para><action>Enlarges the game board +</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><shortcut><keycombo action="simul"> +&Ctrl;<keycap>-</keycap></keycombo></shortcut> +<guimenu>View</guimenu> +<guimenuitem>Zoom Out</guimenuitem> +</menuchoice></term> +<listitem><para><action>Reduces the game board size +</action></para></listitem> +</varlistentry> + +</variablelist> + +</sect2> + +<sect2> +<title>The <guimenu>Mode</guimenu> Menu</title> + +<variablelist> + +<varlistentry> +<term><menuchoice> +<guimenu>Mode</guimenu> +<guimenuitem>Single Human (Normal)</guimenuitem> +</menuchoice></term> +<listitem><para><action>Sets the multiplayer mode to single +player normal</action>. See <xref linkend="game-types"/>.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Mode</guimenu> +<guimenuitem>Single Human (Arcade)</guimenuitem> +</menuchoice></term> +<listitem><para><action>Sets the multiplayer mode to single +player arcade</action>. See <xref linkend="game-types"/>.</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Mode</guimenu> +<guimenuitem>Human vs Human</guimenuitem> +</menuchoice></term> +<listitem><para><action>Sets the multiplayer mode to two player with two human +players.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Mode</guimenu> +<guimenuitem>Human vs Computer</guimenuitem> +</menuchoice></term> +<listitem><para><action>Sets the multiplayer mode to two player with one human +and one computer player.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Mode</guimenu> +<guimenuitem>More...</guimenuitem> +</menuchoice></term> +<listitem><para><action>Displays the multiplayer +options dialog.</action></para></listitem> +</varlistentry> + +</variablelist> + +</sect2> + +<sect2> +<title>The <guimenu>Settings</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>M</keycap></keycombo> +</shortcut> +<guimenu>Settings</guimenu> +<guimenuitem>Show Menubar</guimenuitem> +</menuchoice></term> +<listitem><para><action>Shows or hides the Menubar.</action>To return the +menubar, right-click anywhere on the gameboard and select <guimenuitem>Show +Menubar</guimenuitem>. </para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Shortcuts...</guimenuitem> +</menuchoice></term> +<listitem><para><action>Displays a standard &kde; key bindings +configuration dialog to change the keyboard shortcuts for &ksirtet;.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Notifications...</guimenuitem> +</menuchoice></term> +<listitem><para><action>Displays a standard &kde; notifications +configuration dialog to change the audio and visual notifications for &ksirtet;.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Highscores...</guimenuitem> +</menuchoice></term> +<listitem><para><action>Displays</action> the high score configuration dialog, +in which you can change several settings that affect how &ksirtet; treats highscores.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure &ksirtet;...</guimenuitem> +</menuchoice></term> +<listitem><para><action>Opens</action> the &ksirtet; +configuration dialog, where you can change the options of the game.</para></listitem> +</varlistentry> + +</variablelist> + +</sect2> + +<sect2 id="help"> +<title>The <guimenuitem>Help</guimenuitem> Menu</title> + +&help.menu.documentation; + +</sect2> + +</sect1> + +</chapter> + +<chapter id="credits-and-licenses"> +<title>Credits and Licenses</title> + +<sect1 id="developers"> +<title>Developers</title> + +<para><literal>Erik Eng</literal> - Wrote the generic tetris code</para> +<para>&Nicolas.Hadacek; &Nicolas.Hadacek.mail;</para> +</sect1> + +<sect1 id="authors"> +<title>Authors</title> +<para>&Nicolas.Hadacek; &Nicolas.Hadacek.mail;</para> +<para>Robert Williams <email>rwilliams@kde.org</email> - Editor</para> +<para>Documentation updated for &kde; 3.2 by &Philip.Rodrigues;.</para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +&underFDL; +&underGPL; +</sect1> + + +</chapter> + + + +</book> +<!-- +Local Variables: +mode: sgml +sgml-omittag: nil +sgml-shorttag: t +End: +--> + diff --git a/doc/ksmiletris/Makefile.am b/doc/ksmiletris/Makefile.am new file mode 100644 index 00000000..368fc0da --- /dev/null +++ b/doc/ksmiletris/Makefile.am @@ -0,0 +1,4 @@ + +KDE_DOCS = AUTO +KDE_LANG = en + diff --git a/doc/ksmiletris/gamescreen.png b/doc/ksmiletris/gamescreen.png Binary files differnew file mode 100644 index 00000000..9cb50cf6 --- /dev/null +++ b/doc/ksmiletris/gamescreen.png diff --git a/doc/ksmiletris/icon.png b/doc/ksmiletris/icon.png Binary files differnew file mode 100644 index 00000000..9bdec8a4 --- /dev/null +++ b/doc/ksmiletris/icon.png diff --git a/doc/ksmiletris/index.docbook b/doc/ksmiletris/index.docbook new file mode 100644 index 00000000..53f330f0 --- /dev/null +++ b/doc/ksmiletris/index.docbook @@ -0,0 +1,456 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!-- Define an entity for your application if it is not part of KDE + CVS --> + <!ENTITY ksmiletris "<application>KSmiletris</application>"> + <!ENTITY kappname "&ksmiletris;"> + <!ENTITY package "kdegames"> + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE"> <!-- change the language here --> + <!ENTITY John.Hayes '<personname><firstname>John</firstname><surname>Hayes</surname></personname>'> + <!ENTITY John.Hayes.mail '<email>justlinux@bellsouth.net</email>'> + <!ENTITY Sandro.Sigala '<personname><firstname>Sandro</firstname><surname>Sigala</surname></personname>'> + <!ENTITY Sandro.Sigala.mail '<email>ssigala@globalnet.it</email>'> + <!ENTITY Tetris "<trademark><application>Tetris</application></trademark>"> +]> + +<book lang="&language;"> + +<bookinfo> +<title>The &ksmiletris; Handbook</title> + +<authorgroup> +<author> +&John.Hayes; &John.Hayes.mail; +</author> + +<othercredit role="developer"> +&Sandro.Sigala; &Sandro.Sigala.mail; +</othercredit> + +<othercredit role="reviewer"> +&Frerich.Raabe; &Frerich.Raabe.mail; +</othercredit> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<copyright> +<year>2005</year> +<holder>&John.Hayes;</holder> +</copyright> + +<date>2005-12-14</date> +<releaseinfo>3.5.0</releaseinfo> + +<legalnotice>&FDLNotice;</legalnotice> + +<!-- Abstract about this handbook --> + +<abstract> +<para> +&ksmiletris; is a &Tetris; like game. +</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>kdegames</keyword> +<keyword>KSmileTris</keyword> +<keyword>Tetris</keyword> +</keywordset> + +</bookinfo> + +<chapter id="introduction"> +<title>Introduction</title> + +<para>&ksmiletris; is a game similar to the &Tetris; game. If you have ever played &Tetris;, you will find &ksmiletris; easy to learn and play. +</para> + +</chapter> + +<chapter id="gameplay"> +<title>Game Play</title> + +<sect1 id="starting-a-new-game"> +<title>Starting a New Game</title> + +<para>When you start &ksmiletris;, the game shows a blank game area. To start playing either select <guimenuitem>New</guimenuitem> from the <guimenu>Game</guimenu> menu or press the key combination <keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>.</para> + +</sect1> + +<sect1 id="aim-of-the-game"> +<title>Aim of the Game</title> + +<para>The aim of the game is to complete each level and get the highest score possible. You score by stacking or moving the similar tiles together as they fall, and then disappear. As the tiles disappear, your score increases.</para> + +</sect1> + +<sect1 id="playing-the-game"> +<title>Playing the Game</title> + +<para>By default, you can use the <keysym>Left Arrow</keysym> and <keysym>Right Arrow</keysym> keys to position the falling tiles where you want them to stack, and the <keysym>Up Arrow</keysym> or <keysym>Down Arrow</keysym> keys to rotate the tiles left or right respectively. The <keysym>Spacebar</keysym> drops the tile all the way to the bottom - use it as a way to save time.</para> + +<para>All of the shortcuts can be customized by selecting <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure Shortcuts</guimenuitem></menuchoice> from the menu.</para> + +<para>Four of more of the same type of connected tiles will change to a broken or shattered look. When four or more of the connected tiles are shattered, they will disappear and all pieces above them will settle down to the rows below them.</para> + +<para>Every time a piece shatters, you get 10 points for each tile, you get 20 more points for each tile when it disappears. There are 1000 points per level. As the level increases, more types of tiles will be introduced which makes it more challenging to find fits and the speed at which the tiles fall increases as well.</para> + +<para>The game ends when the center column fills to the top with tiles, and no more can fall.</para> + +</sect1> + +<sect1 id="game-screen"> +<title>The Game Screen</title> + +<para> +<screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="gamescreen.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>&ksmiletris; in Action</phrase> + </textobject> + </mediaobject> +</screenshot> + +A quick explanation of the parts of the game screen... +</para> + +<variablelist> + +<varlistentry> +<term>Game Screen</term> +<listitem><para>The Game screen is at the top left and is the largest section of the window.</para></listitem> +</varlistentry> + +<varlistentry> +<term>Preview Screen</term> +<listitem><para>The Preview screen at the top right, gives you a preview of the block that will drop out next.</para></listitem> +</varlistentry> + +<varlistentry> +<term>Alignment Screen</term> +<listitem><para>The Alignment screen is located just below the game screen. As the tiles are falling, the two tiles that will be on the bottom are shown in the alignment screen in the columns that they are located in. This screen helps you see where the tiles will be located when they get to the bottom.</para></listitem> +</varlistentry> + +<varlistentry> +<term>Statusbar</term> +<listitem><para>The status bar is located at the very bottom of the screen, and shows the current level you are on and your score. Display of the Statusbar can be toggled on or off by the menu <menuchoice><guimenu>Settings</guimenu><guimenuitem>Hide Statusbar</guimenuitem></menuchoice>.</para></listitem> +</varlistentry> + +</variablelist> + +</sect1> + +</chapter> + +<chapter id="preferences"> +<title>&ksmiletris; Configuration and Default Shortcuts</title> + +<sect1 id="game-configuration"> +<title>Configuring Gameplay</title> + +<para>The configuration options are as follows:</para> + +<sect2 id="statusbar"> +<title>Hide/Show Statusbar</title> + +<variablelist> + +<varlistentry> +<term><menuchoice><guimenu>Settings</guimenu><guimenuitem>Hide Statusbar</guimenuitem></menuchoice></term> +<listitem> +<para>Hides the Statusbar.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenu>Settings</guimenu><guimenuitem>Show Statusbar</guimenuitem></menuchoice></term> +<listitem> +<para>Shows the Statusbar.</para> +</listitem> +</varlistentry> + +</variablelist> + +</sect2> + +<sect2 id="appearance-config"> +<title>Appearance Configuration</title> + +<para>The game appearance configuration can be set from <menuchoice><guimenu>Settings</guimenu><guimenuitem>Pieces</guimenuitem></menuchoice>. Your options are:</para> + +<variablelist> + +<varlistentry> +<term><menuchoice><guimenu>Settings</guimenu><guimenuitem>Pieces</guimenuitem><guimenuitem>Smiles</guimenuitem></menuchoice></term> +<listitem><para>Sets the tile appearance to Smileys. +<screenshot> +<mediaobject> +<imageobject> +<imagedata fileref="smiley.png" format="PNG"/> +</imageobject> +</mediaobject> +</screenshot> +</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenu>Settings</guimenu><guimenuitem>Pieces</guimenuitem><guimenuitem>Symbols</guimenuitem></menuchoice></term> +<listitem><para>Sets the tile appearance to Symbols. +<screenshot> +<mediaobject> +<imageobject> +<imagedata fileref="symbol.png" format="PNG"/> +</imageobject> +</mediaobject> +</screenshot> +</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenu>Settings</guimenu><guimenuitem>Pieces</guimenuitem><guimenuitem>Icons</guimenuitem></menuchoice></term> +<listitem><para>Sets the tile appearance to Icons. +<screenshot> +<mediaobject> +<imageobject> +<imagedata fileref="icon.png" format="PNG"/> +</imageobject> +</mediaobject> +</screenshot> +</para></listitem> +</varlistentry> + +</variablelist> + +</sect2> + +<sect2 id="sound-config"> +<title>Sound Configuration</title> + +<variablelist> + +<varlistentry> +<term><menuchoice><guimenu>Settings</guimenu><guimenuitem>Sounds</guimenuitem></menuchoice></term> +<listitem><para>Toggles sound effects on or off.</para></listitem> +</varlistentry> + +</variablelist> + +</sect2> +</sect1> + +<sect1 id="default-keybindings"> +<title>Default Shortcuts</title> + +<para><menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure Shortcuts</guimenuitem></menuchoice> +allows you to change the default keyboard shortcuts. The default shortcuts are as follows:</para> + +<variablelist> + +<varlistentry> +<term><keysym>Spacebar</keysym></term> +<listitem><para>Drops the tile to the bottom fast.</para></listitem> +</varlistentry> + +<varlistentry> +<term><keysym>Up Arrow</keysym></term> +<listitem><para>Rotate tile to the left.</para></listitem> +</varlistentry> + +<varlistentry> +<term><keysym>Down Arrow</keysym></term> +<listitem><para>Rotate tile to the right.</para></listitem> +</varlistentry> + +<varlistentry> +<term><keysym>Left Arrow</keysym></term> +<listitem><para>Move tile to the left.</para></listitem> +</varlistentry> + +<varlistentry> +<term><keysym>Right Arrow</keysym></term> +<listitem><para>Move tile to the right.</para></listitem> +</varlistentry> + +<varlistentry> +<term><keysym>P</keysym></term> +<listitem><para>Pause or resume the game.</para></listitem> +</varlistentry> + +<varlistentry> +<term><keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo></term> +<listitem><para>Start a new game.</para></listitem> +</varlistentry> + +<varlistentry> +<term><keycombo action="simul">&Ctrl;<keycap>End</keycap></keycombo></term> +<listitem><para>End the game.</para></listitem> +</varlistentry> + +<varlistentry> +<term><keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo></term> +<listitem><para>Quit the game.</para></listitem> +</varlistentry> + +<varlistentry> +<term><keycombo action="simul">&Ctrl;<keycap>H</keycap></keycombo></term> +<listitem><para>Show the high scores.</para></listitem> +</varlistentry> + +</variablelist> + + + +</sect1> + +</chapter> + +<chapter id="memus"> +<title>Menu Reference</title> + +<sect1 id="ksmiletris-mainwindow"> +<title>The Main &ksmiletris; Window</title> + +<sect2> +<title>The <guimenu>Game</guimenu> Menu</title> + +<variablelist> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo> +</shortcut> +<guimenu>Game</guimenu> +<guimenuitem>New</guimenuitem> +</menuchoice></term> +<listitem><para><action>Starts a new game.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>End</keycap></keycombo> +</shortcut> +<guimenu>Game</guimenu> +<guimenuitem>End</guimenuitem> +</menuchoice></term> +<listitem><para><action>Ends the current game.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo><keycap>P</keycap></keycombo> +</shortcut> +<guimenu>Game</guimenu> +<guimenuitem>Pause</guimenuitem> +</menuchoice></term> +<listitem><para><action>Pauses or resumes the game</action></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><action>Displays the high scores.</action></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><action>Quits</action> &ksmiletris;</para></listitem> +</varlistentry> + +</variablelist> + +</sect2> + +<sect2> +<title>The <guimenu>Settings</guimenu> Menu</title> + +<variablelist> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Show/Hide Statusbar</guimenuitem> +</menuchoice></term> +<listitem><para><action>Shows or hides the statusbar.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Pieces</guimenuitem> +</menuchoice></term> +<listitem><para><action>Lets you select from three different appearances for the tiles. Your options are Smileys, Symbols or Icons.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Sounds</guimenuitem> +</menuchoice></term> +<listitem><para><action>Toggle effects on or off.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Shortcuts...</guimenuitem> +</menuchoice></term> +<listitem><para><action>Allows you to change the default shortcuts.</action></para></listitem> +</varlistentry> + +</variablelist> + +</sect2> + +<sect2 id="help"> +<title>The <guimenuitem>Help</guimenuitem> Menu</title> + +&help.menu.documentation; + +</sect2> + +</sect1> + +</chapter> + +<chapter id="credits"> + +<title>Credits and License</title> + +<para>&ksmiletris;</para> + +<para>Program Copyright (c) 1998 &Sandro.Sigala; &Sandro.Sigala.mail;. +</para> + +<para>All rights reserved.</para> + +<para>Documentation copyright 2005 &John.Hayes; &John.Hayes.mail;.</para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +&underFDL; + +&underGPL; + +</chapter> + +</book> diff --git a/doc/ksmiletris/smiley.png b/doc/ksmiletris/smiley.png Binary files differnew file mode 100644 index 00000000..a83c133e --- /dev/null +++ b/doc/ksmiletris/smiley.png diff --git a/doc/ksmiletris/symbol.png b/doc/ksmiletris/symbol.png Binary files differnew file mode 100644 index 00000000..abd92813 --- /dev/null +++ b/doc/ksmiletris/symbol.png diff --git a/doc/ksnake/Makefile.am b/doc/ksnake/Makefile.am new file mode 100644 index 00000000..368fc0da --- /dev/null +++ b/doc/ksnake/Makefile.am @@ -0,0 +1,4 @@ + +KDE_DOCS = AUTO +KDE_LANG = en + diff --git a/doc/ksnake/index.docbook b/doc/ksnake/index.docbook new file mode 100644 index 00000000..608d3132 --- /dev/null +++ b/doc/ksnake/index.docbook @@ -0,0 +1,346 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY kappname "&ksnake;"> + <!ENTITY package "kdegames"> + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE"> +]> + +<book lang="&language;"> +<bookinfo> +<title>The &ksnake; Handbook</title> +<authorgroup> +<author> +<firstname>Michel</firstname> +<surname>Filippi</surname> +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<copyright> +<year>2000</year> +<holder>Michel Filippi</holder> +</copyright> + +<legalnotice>&FDLNotice;</legalnotice> + +<date>2005-12-17</date> +<releaseinfo>0.4.0</releaseinfo> + +<abstract> +<para> +Snake Race is a game of speed and agility. You are a hungry snake and are trying +to eat all the apples in the room before getting out! +</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>game</keyword> +<keyword>linux</keyword> +<keyword>race</keyword> +</keywordset> + +</bookinfo> + +<chapter id="introduction"> +<title>Introduction</title> + +<para> +&ksnake; is a game of speed and agility. You are a hungry snake and are trying +to eat all the apples in the room before getting out! +</para> + +</chapter> + +<chapter id="rules-of-the-game"> +<title>Rules of the Game</title> + +<sect1 id="to-win"> +<title>To Win</title> + +<para> +To win &ksnake; you must eat all the apples in the room and leave through the +exit that opens at the top. +</para> + +<itemizedlist> +<listitem> +<para> +Each apple you eat makes you grow longer. +</para> +</listitem> +<listitem> +<para> +If you hit a wall, you die. +</para> +</listitem> +<listitem> +<para> +If you hit yourself, you die. +</para> +</listitem> +<listitem> +<para> +If you are hit in the head by a bouncing ball, you die. +</para> +</listitem> +<listitem> +<para> +If you take too long to eat the apples, more of them appear. +</para> +</listitem> +</itemizedlist> + +</sect1> + +<sect1 id="scoring"> +<title>Scoring</title> + +<sect2> +<title>Before the timer has run out</title> + + +<para> +Before the timer has run out, you score: +</para> + +<itemizedlist> +<listitem> +<para> +1 point for a red apple + a bonus depending on your skill level. +</para> +</listitem> +<listitem> +<para> +5 points for a gold apple + a bonus for your skill level + 2 points for each +computer snake + 2 points for each bouncing ball. +</para> +</listitem> +<listitem> +<para> +Twice your level number when you exit the room + a bonus depending on your skill +level. +</para> +</listitem> +</itemizedlist> + +</sect2> + +<sect2> +<title>After the timer has run out</title> + +<para> +After the timer has run out, you score: +</para> + +<itemizedlist> +<listitem> +<para> +1 point for a red apple. +</para> +</listitem> +<listitem> +<para> +2 points for a gold apple. +</para> +</listitem> +<listitem> +<para> +Points equal to your level number when you exit the room + a bonus depending on +your skill level. +</para> +</listitem> +</itemizedlist> + +</sect2> + +<sect2> +<title>When the computer snake eats an object</title> + +<para> +When the computer snake eats an object you lose: +</para> + +<itemizedlist> +<listitem> +<para> +2 points for a red apple. +</para> +</listitem> +<listitem> +<para> +5 points for a gold apple. +</para> +</listitem> +</itemizedlist> + +</sect2> + +<sect2> +<title>Other points</title> + +<para> +You score 20 points for killing a computer snake. +</para> + +</sect2> + +</sect1> +</chapter> + +<chapter id="customization"> +<title>Customization</title> + +<sect1 id="create-your-own-levels"> +<title>Create Your Own Levels</title> + +<para> +To create your own level, copy one of the levels from <filename +class="directory">$<envar>KDEDIR</envar>/share/apps/ksnake/levels</filename> to +<filename +class="directory">$<envar>HOME</envar>/.kde/share/apps/ksnake</filename> and +edit it with a bitmap editor. You can then select it in +<menuchoice><guimenu>Settings</guimenu> <guimenuitem>Configure &ksnake;...</guimenuitem> +</menuchoice> in the <guilabel>First Level</guilabel> tab. +</para> + +</sect1> + +</chapter> + +<chapter id="menu-reference"> +<title>Menu Reference</title> + +<sect1 id="game-menu"> +<title>The <guimenu>Game</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo> +</shortcut> +<guimenu>Game</guimenu> +<guimenuitem>New</guimenuitem> +</menuchoice></term> +<listitem> +<para>Start a new game</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycap>P</keycap> +</shortcut> +<guimenu>Game</guimenu> +<guimenuitem>Pause</guimenuitem> +</menuchoice></term> +<listitem> +<para>Pause the game.</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>Show the High Score dialog.</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>Quits &kappname;.</para> +</listitem> +</varlistentry> +</variablelist> + +</sect1> + +<sect1 id="settings-menu"> +<title>The <guimenu>Settings</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu><guimenuitem>Show Statusbar</guimenuitem> +</menuchoice></term> +<listitem> +<para>Shows or hides the &ksnake; status bar at the bottom of the screen.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenu>Settings</guimenu> +<guimenuitem>Configure Shortcuts...</guimenuitem></menuchoice> +</term> +<listitem><para>Select this to open a dialog which lets you define shortcuts +for all menu items in &ksnake;.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu><guimenuitem>Configure &ksnake;...</guimenuitem> +</menuchoice></term> +<listitem> +<para>Opens the &ksnake; configuration dialog to change &ksnake; +settings.</para> +<para>On the <guilabel>General</guilabel> tab you can set the speed of snakes, +choose the number of snakes and balls and their behaviour.</para> +<para>Select a background color or an image on the <guilabel>Appearance</guilabel> tab.</para> +<para>Choose a starting level from 1 to 25 on the <guilabel>First Level</guilabel> tab.</para> + +</listitem> +</varlistentry> + +</variablelist> +</sect1> + +<sect1 id="help-menu"> +<title>The <guimenu>Help</guimenu> Menu</title> + +&help.menu.documentation; + +</sect1> + +</chapter> + +<chapter id="credits-and-licenses"> +<title>Credits and Licenses</title> + +<para> +&ksnake; copyright 2000, Michel Filippi +</para> + +<para> +Documentation copyright 2000, Michel Filippi and Robert Williams. +</para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +&underFDL; +&underGPL; + +</chapter> +</book> +<!-- +Local Variables: +mode: sgml +sgml-omittag: nil +sgml-shorttag: t +End: +--> diff --git a/doc/ksokoban/Makefile.am b/doc/ksokoban/Makefile.am new file mode 100644 index 00000000..368fc0da --- /dev/null +++ b/doc/ksokoban/Makefile.am @@ -0,0 +1,4 @@ + +KDE_DOCS = AUTO +KDE_LANG = en + diff --git a/doc/ksokoban/index.docbook b/doc/ksokoban/index.docbook new file mode 100644 index 00000000..93fbfbea --- /dev/null +++ b/doc/ksokoban/index.docbook @@ -0,0 +1,429 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY kappname "&ksokoban;"> + <!ENTITY package "kdegames"> + <!ENTITY % English "INCLUDE" > <!-- change language only here --> + <!ENTITY % addindex "IGNORE"> +]> + +<book lang="&language;"> +<bookinfo> +<title>The &ksokoban; Handbook</title> + +<authorgroup> +<author> +<firstname>Anders</firstname> +<surname>Widell</surname> +<affiliation> +<address>&Anders.Widell.mail;</address> +</affiliation> +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<copyright> +<year>2000</year> +<holder>&Anders.Widell;</holder> +</copyright> + +<legalnotice>&FDLNotice;</legalnotice> + +<date>2006-06-19</date> +<releaseinfo>0.4.2</releaseinfo> + +<abstract> +<para> +&ksokoban; is a &kde; implementation of the Japanese warehouse keeper +game <quote>sokoban</quote>. +</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>kdegames</keyword> +<keyword>game</keyword> +<keyword>sokoban</keyword> +<keyword>ksokoban</keyword> +</keywordset> +</bookinfo> + +<chapter id="introduction"> +<title>Introduction</title> + +<para> +The first sokoban game was created in 1982 by Hiroyuki Imabayashi at +the Japanese company Thinking Rabbit, Inc. <quote>Sokoban</quote> is +japanese for <quote>warehouse keeper</quote>. The idea is that you +are a warehouse keeper trying to push crates to their proper locations +in a warehouse. +</para> + +<para> +The problem is that you cannot pull the crates or step over them. If +you are not careful, some of the crates can get stuck in wrong places +and/or block your way. +</para> + +<para> +It can be rather difficult just to solve a level. But if you want to +make it even harder, you can try to minimize the number of moves +and/or pushes you use to solve the level. +</para> + +<para> +To make the game more fun for small kids (below 10 years or so), some +collections with easier levels are also included in &ksokoban;. These +are marked <emphasis>(easy)</emphasis> in the level collection menu. +Of course, these levels can be fun for adults too, for example if you +don't want to expose yourself to too much mental strain. +</para> +</chapter> + +<chapter id="how-to-play"> +<title>The Game</title> + +<para> +The objective of the game is to push all the red gems to the goal +squares, which are marked with green glassy round things on the floor. +</para> + +<para> +Use the cursor keys or the mouse to move about. If you move onto a gem +using the cursor keys or the <mousebutton>middle</mousebutton> mouse +button, and there is nothing blocking it on the opposite side, then you +will push the gem. It isn't possible to pull the gems, so if you push +a gem into a corner it will be stuck there. You cannot step over the +gems either, so you can also get trapped in a part of the maze by +blocking the way with gems. Also note that it isn't possible to push +more than one gem at a time. +</para> + +<para> +If you notice that you have moved the gems in such a way that the +level is impossible to solve, then you can always use the undo feature +to go back to a position where the mistake has not yet been made. You +can of course also restart the level from the very beginning. +</para> + +<sect1 id="controls"> +<title>Controls</title> + +<para> +<informaltable> +<tgroup cols="2"> +<thead> +<row><entry>Key</entry><entry>Action</entry></row> +</thead> + +<tbody> +<row><entry>Cursor keys </entry><entry>Move one square in a direction </entry></row> +<row><entry><keycombo action="simul">&Ctrl;<keycap>Cursor</keycap></keycombo> keys </entry><entry>Move as far as possible in a direction without pushing any gems </entry></row> +<row><entry><keycombo action="simul">&Shift;<keycap>Cursor</keycap></keycombo> keys </entry><entry>Move as far as possible in a direction, pushing any gem in the way </entry></row> +<row><entry><mousebutton>Left</mousebutton> mouse button </entry><entry>Move to any place in the maze that can be reached without pushing any gems </entry></row> +<row><entry><mousebutton>Middle</mousebutton> mouse button or <keycombo action="simul">&Ctrl;<keycap>Z</keycap></keycombo></entry><entry>Undo the last move </entry></row> +<row><entry><mousebutton>Right</mousebutton> mouse button </entry><entry>Move up/down/left/right in a straight line, pushing any gem in the way </entry></row> +<row><entry><mousebutton>Mouse wheel</mousebutton></entry><entry>Traverse the history </entry></row> +<row><entry><keycombo action="simul">&Ctrl;&Shift;<keycap>Z</keycap></keycombo></entry><entry>Redo the last undone move </entry></row> +<row><entry><keycap>N</keycap> </entry><entry>Go to the next level in the current level collection </entry></row> +<row><entry><keycap>P</keycap> </entry><entry>Go to the previous level in the current level collection </entry></row> +<row><entry>&Esc; </entry><entry>Restart the current level </entry></row> +<row><entry><keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo></entry><entry>Quit the game </entry></row> +</tbody> +</tgroup> +</informaltable> +</para> +</sect1> + +<sect1 id="loading-external-levels"> +<title>Loading external levels</title> + +<para> +&ksokoban; has the ability to load external sokoban levels from text +files. You can load levels using the menu entry +<menuchoice><guimenu>Game</guimenu> <guimenuitem>Load +Levels...</guimenuitem> </menuchoice>, or by specifying the level file +&URL; as a command line argument when starting &ksokoban; from a +shell. +</para> + +<para> +The external levels must be defined using the standard characters +shown in the table below. If the file contains more than one level, +the levels should be separated by blank lines. The file may also +contain text between the levels. +</para> + +<informaltable> +<tgroup cols="2"> +<thead> +<row><entry>Character</entry><entry>Meaning</entry></row> +</thead> + +<tbody> +<row><entry><literal>#</literal></entry><entry>Wall</entry></row> +<row><entry><emphasis>(space)</emphasis></entry><entry>Empty square</entry></row> +<row><entry><literal>.</literal></entry><entry>Goal square</entry></row> +<row><entry><literal>$</literal></entry><entry>Object on an empty square</entry></row> +<row><entry><literal>*</literal></entry><entry>Object on a goal square</entry></row> +<row><entry><literal>@</literal></entry><entry>Start position on an empty square</entry></row> +<row><entry><literal>+</literal></entry><entry>Start position on a goal square</entry></row> +</tbody> +</tgroup> +</informaltable> + +<para> +As an example, below is a text representation of the first level in the +<emphasis>Microban</emphasis> level collection: +</para> + +<para> +<screen> +#### +# .# +# ### +#*@ # +# $ # +# ### +#### +</screen> +</para> +</sect1> +</chapter> + +<chapter id="menu-reference"> +<title>Menu Reference</title> + +<para>This is a complete guide to the menus of &ksokoban;.</para> + +<sect1 id="game-menu"> +<title>The <guimenu>Game</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice> +<guimenu>Game</guimenu> +<guimenuitem>Load Levels...</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Load an external level.</action> See the section <link +linkend="loading-external-levels">Loading External Levels</link> for +more information.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut><keycap>N</keycap></shortcut> +<guimenu>Game</guimenu> +<guimenuitem>Next Level</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Load the next level.</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut><keycap>P</keycap></shortcut> +<guimenu>Game</guimenu> +<guimenuitem>Previous Level</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Go back to the previous level.</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut>&Esc;</shortcut> +<guimenu>Game</guimenu> +<guimenuitem>Restart Level</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Restart the current level.</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Game</guimenu> +<guisubmenu>Level Collection</guisubmenu> +</menuchoice></term> +<listitem> +<para><action>Change to a different set of levels.</action> &ksokoban; +comes with several level sets, and you can load more that you can find +on the internet.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut><keycombo action="simul">&Ctrl;<keycap>Z</keycap></keycombo></shortcut> +<guimenu>Game</guimenu> +<guimenuitem>Undo</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Undo the last move</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>Z</keycap></keycombo></shortcut> +<guimenu>Game</guimenu> +<guimenuitem>Redo</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Redo the last move you undid with the menu item +above.</action></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><action>Exit</action> &ksokoban;.</para> +</listitem> +</varlistentry> +</variablelist> +</sect1> + +<sect1 id="animation-menu"> +<title>The <guimenu>Animation</guimenu> Menu</title> + +<para> +The <guimenu>Animation</guimenu> Menu allows you to specify the speed that movement replay animations are shown at. +</para> + +<variablelist> +<varlistentry> +<term><menuchoice> +<guimenu>Animation</guimenu> +<guisubmenu>Slow</guisubmenu> +</menuchoice></term> +<listitem> +<para><action>Show replay animations at a slow pace</action>.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Animation</guimenu> +<guisubmenu>Medium</guisubmenu> +</menuchoice></term> +<listitem> +<para>This is the default setting, and <action>shows replay animations at a slightly faster pace</action>.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Animation</guimenu> +<guisubmenu>Fast</guisubmenu> +</menuchoice></term> +<listitem> +<para><action>Show replay animations at the fastest pace</action>.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Animation</guimenu> +<guisubmenu>Off</guisubmenu> +</menuchoice></term> +<listitem> +<para><action>Do not animate replay animations</action>.</para> +</listitem> +</varlistentry> +</variablelist> + +</sect1> + + +<sect1 id="bookmarks"> +<title>The <guimenu>Bookmarks</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice> +<guimenu>Bookmarks</guimenu> +<guisubmenu>Set Bookmark</guisubmenu> +</menuchoice></term> +<listitem> +<para>&ksokoban; allows you to <action>set bookmarks with a level at a +particular state.</action> You might use this to save yourself +repeating the same initial steps in a level.</para> +<para>You can have up to ten bookmarks at a time, and access them via the +hotkey <keycombo action="simul">&Ctrl;<keycap><replaceable>X</replaceable></keycap></keycombo>, +where <replaceable>X</replaceable> is any digit between 0 and 9.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Bookmarks</guimenu> +<guisubmenu>Go to Bookmark</guisubmenu> +</menuchoice></term> +<listitem> +<para><action>Jump to a state you have previously saved as a +bookmark</action>.</para> +</listitem> +</varlistentry> +</variablelist> + +</sect1> + +<sect1 id="help-menu"> +<title>The <guimenu>Help</guimenu> Menu</title> + +&help.menu.documentation; + +</sect1> +</chapter> + +<chapter id="credits"> +<title>Credits and License</title> + +<para> +&ksokoban; is copyright © 1998-2000 by &Anders.Widell; +&Anders.Widell.mail;. For +the latest info on &ksokoban;, see the &ksokoban; home page at +<ulink url="http://hem.passagen.se/awl/ksokoban/"> +http://hem.passagen.se/awl/ksokoban/</ulink> +</para> + +<para> +The background graphics <quote>starfield</quote> was taken from the +<ulink url="http://www.gimp.org/">Gimp</ulink>. All other graphics +were created by &Anders.Widell; &Anders.Widell.mail; using +the <ulink url="http://www.povray.org/">Povray</ulink> ray tracer. +</para> + +<para> +All the currently included sokoban levels were created by David W. +Skinner <email>sasquatch@bentonrea.com</email>. See his sokoban page +at <ulink url="http://users.bentonrea.com/~sasquatch/sokoban/"> +http://users.bentonrea.com/~sasquatch/sokoban/</ulink> +</para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> +&underFDL; +&underGPL; +</chapter> + +<appendix id="installation"> +<title>Installation</title> + +&install.intro.documentation; + +&install.compile.documentation; + +</appendix> + +&documentation.index; +</book> + diff --git a/doc/kspaceduel/Makefile.am b/doc/kspaceduel/Makefile.am new file mode 100644 index 00000000..368fc0da --- /dev/null +++ b/doc/kspaceduel/Makefile.am @@ -0,0 +1,4 @@ + +KDE_DOCS = AUTO +KDE_LANG = en + diff --git a/doc/kspaceduel/index.docbook b/doc/kspaceduel/index.docbook new file mode 100644 index 00000000..2d3cc2b7 --- /dev/null +++ b/doc/kspaceduel/index.docbook @@ -0,0 +1,659 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY kappname "&kspaceduel;"> + <!ENTITY package "kdegames"> + <!ENTITY % English "INCLUDE" > <!-- change language only here --> + <!ENTITY % addindex "IGNORE"> +]> + +<book lang="&language;"> +<bookinfo> +<title>The &kspaceduel; Handbook</title> + +<authorgroup> +<author> +<firstname>Andreas </firstname> +<surname>Zehender</surname> +<affiliation> +<address><email>az@azweb.de</email></address> +</affiliation> +</author> +</authorgroup> +<!-- TRANS:ROLES_OF_TRANSLATORS --> + +<copyright> +<year>1999</year><year>2000</year> +<holder>Andreas Zehender</holder> +</copyright> + +<legalnotice>&FDLNotice;</legalnotice> + +<date>2003-09-17</date> +<releaseinfo>1.1</releaseinfo> + +<abstract> +<para>&kspaceduel; is an space arcade game. </para> +<para>Two ships fly around the sun and try to shoot eachother.</para> +</abstract> + + +<keywordset> +<keyword>Space duel</keyword> +<keyword>KDE</keyword> +<keyword>game</keyword> +<keyword>ships</keyword> +<keyword>shooting</keyword> +</keywordset> + +</bookinfo> + +<chapter id="introduction"> +<title>Introduction</title> + +<para>&kspaceduel; is an space arcade game for two players.</para> + +<para>Each player controls a ship that flies around the sun and tries to shoot +at the other ship. You can play &kspaceduel; with another person, against the +computer, or you can have the computer control both ships and play each +other.</para> + +</chapter> + +<chapter id="the-game"> +<title>The Game</title> +<para>The idea of the game is simple (but addictive). You try to destroy your opponent before he destroys you.</para> +<para>Be careful not to hit the sun.</para> +<sect1 id="rules-of-the-game"> +<title>Rules of the Game</title> +<sect2 id="ship-movement"> +<title>Ship Movement</title> +<para>Each player controls one ship. </para> +<para>The ships can rotate, accelerate, shoot and lay mines.</para> +</sect2> + +<sect2 id="energy"> +<title>Energy</title> + +<para>Each ship has an amount of energy (refer to the game +options for values). </para> + +<para>Ships need energy for rotation, acceleration, shooting and laying mines. A +ship gets energy from its solar panels. The amount of energy a ship gets depends +on the distance from and direction to the sun. A ship gets more energy near the +sun and less energy near the border. It gets the full amount of energy if the +sun shines directly on the panels and less or even no energy if the sun shines +at an angle to the panel or to the side of the panel.</para> + +<para>If a ship has no energy it can't navigate or shoot. </para> + +</sect2> + +<sect2 id="hit-points"> +<title>Hit points</title> + +<para>Collisions with own or other bullets or mines decrease the hit points of a +ship. If two ships collide, the weaker ship is destroyed and the hit points of +the stronger ship are decreased by the hit points of the weaker ship plus an +amount (Crash Damage). A ship is destroyed when it flies into the sun.</para> + +</sect2> + +<sect2 id="bullets-and-mines"> +<title>Bullets and Mines </title> + +<para>Bullets fly around the sun like a ship. </para> + +<para>Mines have an amount of energy to stay at the same position. When the +energy is spent, the mine falls into the sun. Mines near the sun need more +energy than those which are further away. </para> + +<para>Mines can be destroyed with bullets. </para> + +<para>By default a ship can have 5 bullets and 3 mines on the screen. </para> + +</sect2> + +<sect2 id="powerups"> +<title>Powerups</title> + +<para>From time to time powerups appear on the play field.</para> + +<para>There are four different powerups:</para> + +<variablelist> +<varlistentry> +<term>Mine</term> +<listitem><para>The maximum number of mines is increased for the +player.</para></listitem> +</varlistentry> +<varlistentry> +<term>Bullet</term> +<listitem><para>The maximum number of bullets is increased for the +player.</para></listitem> +</varlistentry> +<varlistentry> +<term>Energy (yellow sphere)</term> +<listitem><para>The player gets energy.</para></listitem> +</varlistentry> +<varlistentry> +<term>Shield (blue sphere)</term> +<listitem><para>The player gets hit points</para></listitem> +</varlistentry> +</variablelist> + +</sect2> + +<sect2 id="screen"> +<title>The &kspaceduel; screen</title> + +<screenshot> +<screeninfo>&kspaceduel; Main Screen</screeninfo> +<mediaobject> +<imageobject><imagedata fileref="kspaceduel3.png" format="PNG"/></imageobject> +<textobject><phrase>&kspaceduel; Main Screen</phrase></textobject> +</mediaobject> +</screenshot> + +<para>You can see that the central part of the &kspaceduel; screen is the playing +area. To the left and the right are the Red Player's and the Blue Player's +stats.</para> +<para>The top box on the player stats, represents the <quote>Hit Points</quote> of the +craft.</para> +<para>The middle box on the player stats, represents the battery power.</para> +<para>The bottom box on the player stats, shows the number of wins.</para> +<para>The top of the playing area is occupied by the menubar and toolbar.</para> +<para>The bottom of the playing area is the status bar.</para> + +</sect2> +</sect1> + +<sect1 id="options"> +<title>Game Options</title> + +<para>&kspaceduel; has many, many options you can adjust to increase the enjoyment +of this game.</para> + +<para>Configuration is divided into two sections:</para> + +<itemizedlist> +<listitem><para><link linkend="options-keys">Player Keys</link></para></listitem> +<listitem><para><link linkend="options-configurations">Game Settings</link></para></listitem> +</itemizedlist> + +<sect2 id="options-keys"> +<title>Keys</title> + +<para>&kspaceduel; has a default set of keys to control the game. For a list of +default keys see the section entitled <link linkend="keys">Default key +bindings</link>.</para> + +<para>Keys can be configured by: </para> + +<para>Selecting <menuchoice> <guimenu>Settings</guimenu><guimenuitem>Configure +Shortcuts...</guimenuitem> </menuchoice> from the menubar.</para> + +<para>This will bring up a dialog box which lets you configure all hotkeys, +including the keys used for steering the space ships, for firing bullets, and +for laying mines.</para> + +<para>You can see that each player (Red and Blue), have 5 keystrokes +corresponding to Rotate Left, Rotate Right, Accelerate, Shot, and Mines.</para> + +<para>When you are finished configuring your keys, you should click on +<guibutton>OK</guibutton> to apply your changes.</para> + +<para>If you want to restore the default keys, simply click on the +<guibutton>Default</guibutton> button once. To make these changes permenant, +press <guibutton>OK</guibutton>.</para> + +<para>If you want to abandon the changes you made, and return to your previously +selected keys, simply click <guibutton>Cancel</guibutton>, and your changes +will be lost.</para> +</sect2> + +<sect2 id="options-configurations"> +<title>Game Configuration</title> + +<para>All game settings of &kspaceduel; are configurable.</para> + +<para>If you want to change the game settings, simply select +<menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure &kspaceduel;...</guimenuitem> +</menuchoice> from the menubar.</para> + +<para>This will bring up a dialog box with two pages, labelled +<guilabel>General</guilabel> and <guilabel>Game</guilabel>. The first page +is rather simple, the second one has seven tabs across the top.</para> + +<para>Settings are collected in different configurations. You can choose from +several pre-defined configurations.</para> + +<para>If you choose the <guilabel>Custom</guilabel> configuration, you can +define all settings for yourself.</para> + +<note><para>If you have not selected <guilabel>Custom</guilabel>, you will not +be able to make any changes to these options.</para></note> + +<tip><para> If you have found an interesting configuration, mail it to the +author of the game. It can be implemented in a future version (send the part +[Game] in the file +<filename>~/.kde/share/config/kspaceduelrc</filename>).</para></tip> + +<para>When you are finished altering the options, you should click on +<guibutton>OK</guibutton> to apply your changes.</para> + +<para>If you want to restore the default, simply click on the +<guibutton>Default</guibutton> button once. To make these changes permenant, +press <guibutton>OK</guibutton>.</para> + +<para>If you want to abandon the changes you made, and return to your previous +options, simply click <guibutton>Cancel</guibutton>, and your changes will be +lost.</para> + +<para>The settings are:</para> + +<sect3 id="general"> +<title><guilabel>General</guilabel></title> + +<variablelist> +<varlistentry> +<term><guilabel>Hit Points</guilabel></term> +<listitem><para>These two sliders allow you to define the hitpoints for each +of the two players; you might want to decrease the hitpoints for a player +to give that player a handycap.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Refresh time</guilabel></term> +<listitem><para>Time between two screen refreshes in milliseconds. All other +settings are independent of the refresh time.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Red Player</guilabel></term> +<listitem><para>Here you can define whether the red player gets controlled by +the AI, and also choose the skill level of the AI for this player. Just +experiment with the different skill level to find one which fits you.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Blue Player</guilabel></term> +<listitem><para>This works the same as the options for the <guilabel>Red +Player</guilabel> described above.</para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3 id="game"> +<title><guilabel>Game</guilabel></title> + +<variablelist> +<varlistentry> +<term><guilabel>Game speed</guilabel></term> +<listitem><para>Controls the speed of the whole game.</para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3 id="bullet"> +<title><guilabel>Bullet</guilabel></title> + +<variablelist> +<varlistentry> +<term><guilabel>Shot speed</guilabel></term> +<listitem><para>The speed of bullets</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Energy need</guilabel></term> +<listitem><para>The amount of energy needed for one shot.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Max number</guilabel></term> +<listitem><para>The maximum number of bullets a player can have on the +screen.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Damage</guilabel></term> +<listitem><para>The number of hit points damage done when a bullet hits a +ship.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Life time</guilabel></term> +<listitem><para>The maximum life time of a bullet.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Reload time</guilabel></term> +<listitem><para>The time a ship needs to reload a bullet.</para></listitem> +</varlistentry> +</variablelist> + +</sect3> +<sect3 id="mine"> +<title>Mine</title> + +<variablelist> +<varlistentry> +<term><guilabel>Mine fuel</guilabel></term> +<listitem><para>The amount of fuel on a mine.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Energy need</guilabel></term> +<listitem><para>The amount of energy needed for laying a mine.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Activate time</guilabel></term> +<listitem><para>The time a mine is inactive.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Damage</guilabel></term> +<listitem><para>The number of hit points of damage done when a ship hits a +mine.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Max number</guilabel></term> +<listitem><para>Maximum number of mines a player can have on the +screen.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Reload time</guilabel></term> +<listitem><para>The time a ship needs to reload a mine.</para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3 id="ship"> +<title><guilabel>Ship</guilabel></title> + +<variablelist> +<varlistentry> +<term><guilabel>Acceleration</guilabel></term> +<listitem><para>Acceleration of the ships</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Energy need</guilabel></term> +<listitem><para>The energy needed to accelerate a ship.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Rotation speed</guilabel></term> +<listitem><para>The speed at which a ship rotates.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Energy need</guilabel></term> +<listitem><para>The energy needed to rotate a ship.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Crash damage</guilabel></term> +<listitem><para>The number of hit points damage done when two ships +collide.</para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3 id="sun"> +<title><guilabel>Sun</guilabel></title> + +<variablelist> +<varlistentry> +<term><guilabel>Sun energy</guilabel></term> +<listitem><para>The strength of the sun. The higher the value, the quicker +ships will be recharged.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Gravity</guilabel></term> +<listitem><para>The strength of the gravitational pull of the +sun.</para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3 id="start"> +<title><guilabel>Start</guilabel></title> + +<variablelist> +<varlistentry> +<term><guilabel>Position X</guilabel> and <guilabel>Position Y</guilabel></term> +<listitem><para>The ships position at the beginning of a new round. The ships +start at opposite sides of the sun.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Velocity X</guilabel> and <guilabel>Velocity Y</guilabel></term> +<listitem><para>Velocity at the beginning of a new round.</para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3 id="powerup-options"> +<title><guilabel>Powerups</guilabel></title> + +<variablelist> +<varlistentry> +<term><guilabel>Appearance time</guilabel></term> +<listitem><para>Maximal time between the appearance of two +powerups.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Life time</guilabel></term> +<listitem><para>Maximal life time of a powerup.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Energy amount</guilabel></term> +<listitem><para>Amount of energy a player gets from an energy +powerup.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Shield amount</guilabel></term> +<listitem><para>Amount of hit points a player gets from a shield +powerup.</para></listitem> +</varlistentry> +</variablelist> + +</sect3> +</sect2> +</sect1> +</chapter> + +<chapter id="command"> +<title>Commands/Keyboard Shortcuts</title> + +<para>The following sections briefly describe each menubar option.</para> + +<sect1 id="game-menu"> +<title>The <guimenu>Game</guimenu> Menu</title> + +<para>The <guimenu>Game</guimenu> menu is used to start and pause the game.</para> + +<variablelist> +<varlistentry> +<term><menuchoice> +<shortcut><keycombo action="simul"> +&Ctrl;<keycap>N</keycap></keycombo></shortcut> +<guimenu>Game</guimenu><guimenuitem>New</guimenuitem> </menuchoice></term> +<listitem><para>Starts a new game of &kspaceduel;.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut><keycombo action="simul"> +&Ctrl;<keycap>N</keycap></keycombo></shortcut> +<guimenu>Game</guimenu><guimenuitem>New Round</guimenuitem> </menuchoice></term> +<listitem><para>Starts a new round, at the current level.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut><keycombo action="simul"><keycap>P</keycap></keycombo></shortcut> +<guimenu>Game</guimenu><guimenuitem>Pause</guimenuitem> </menuchoice></term> +<listitem><para>Pauses and unpauses the game.</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><action>Quits</action> &kspaceduel;</para></listitem> +</varlistentry> +</variablelist> + +</sect1> + +<sect1 id="settings-menu"> +<title><guimenu>Settings</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu><guimenuitem>Show Toolbar</guimenuitem> </menuchoice></term> +<listitem><para>When selected, the toolbar will be visible. When not selected, +the toolbar will be hidden.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu><guimenuitem>Show Statusbar</guimenuitem> +</menuchoice></term> +<listitem><para>When selected, the status bar (the bar along the bottom of the +screen which gives textual information) will be visible. When not selected, the +status bar will be hidden.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Shortcuts...</guimenuitem> +</menuchoice></term> +<listitem><para>Allows you to change the keyboard shortcuts for &kspaceduel;, +including the keys for steering the space ship, firing bullets &etc;.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice><guimenu>Settings</guimenu> +<guimenuitem>Configure Toolbars...</guimenuitem> +</menuchoice></term> +<listitem><para>Display the standard KDE Toolbar Configuration Dialog.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure &kspaceduel;...</guimenuitem> +</menuchoice></term> +<listitem><para>Opens a configuration dialog which lets you define many +settings of the game, refer to the chapter <link linkend="options">Game +Options</link> for further information.</para></listitem> +</varlistentry> +</variablelist> + +</sect1> + +<sect1 id="help-menu"> +<title><guimenu>Help</guimenu> Menu</title> + +&help.menu.documentation; + +</sect1> + +<sect1 id="keys"> +<title>Default Key Bindings</title> + +<para>The following tables show you the default key bindings.</para> + +<para><emphasis>Menu bindings</emphasis></para> + +<informaltable frame="all"> +<tgroup cols="2"> +<thead><row><entry>Key Combo</entry><entry>Action</entry></row></thead> +<tbody> +<row><entry><keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo></entry><entry>Quit &kspaceduel;</entry></row> +<row><entry><keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo></entry><entry>New Game</entry></row> +<row><entry><keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo></entry><entry>New Round</entry></row> +<row><entry><keycombo action="simul"><keycap>P</keycap></keycombo></entry><entry>Pause Game</entry></row> +<row><entry><keycombo action="simul"><keycap>F1</keycap></keycombo></entry><entry>Help Contents</entry></row> +<row><entry><keycombo action="simul">&Shift;<keycap>F1</keycap></keycombo></entry><entry>Whats This Help</entry></row> +<row><entry><keycombo action="simul"><keycap>Space</keycap></keycombo></entry><entry>Start Game</entry></row> +</tbody> +</tgroup> +</informaltable> + +<para>The Menu Key Bindings can be changed by selecting <menuchoice> +<guimenu>Settings</guimenu> <guimenuitem>Configure Key Bindings</guimenuitem> +</menuchoice></para> + +<para><emphasis>Game Play</emphasis></para> + +<informaltable frame="all"> +<tgroup cols="3"> +<colspec colname="c1"/> +<colspec colname="c2"/> +<colspec colname="c3"/> +<thead><row><entry>Action</entry><entry>Red Player</entry><entry>Blue Player</entry></row></thead> +<tbody> +<row><entry>Rotate Left</entry><entry>S</entry><entry>Left Arrow</entry></row> +<row><entry>Rotate Right</entry><entry>F</entry><entry>Right Arrow</entry></row> +<row><entry>Accelerate</entry><entry>E</entry><entry>Up Arrow</entry></row> +<row><entry>Shot</entry><entry>D</entry><entry>Down Arrow</entry></row> +<row><entry>Mines</entry><entry>A</entry><entry>Insert</entry></row> +</tbody> +</tgroup> +</informaltable> + +<para>To change these keys, refer to the section entitled <link +linkend="options-keys">Player Keys...</link>.</para> + +</sect1> +</chapter> + +<chapter id="credits"> +<title>Credits and License</title> + +<para> +&kspaceduel; +</para> +<para> +Program copyright 1999-2000 Andreas Zehender <email>az@azweb.de</email></para> +<para>Documentation copyright 2000 Andreas Zehender <email>az@azweb.de</email></para> +<para>Documentation updated for &kde; 2.0 by Mike McBride <email>mpmcbride7@yahoo.com</email></para> +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +&underFDL; +&underGPL; + +</chapter> + +<appendix id="installation"> +<title>Installation</title> + +<sect1 id="getting-kspaceduel"> +<title>How to obtain &kspaceduel;</title> + +&install.intro.documentation; + +</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: +--> + diff --git a/doc/kspaceduel/kspaceduel3.png b/doc/kspaceduel/kspaceduel3.png Binary files differnew file mode 100644 index 00000000..a23bc50e --- /dev/null +++ b/doc/kspaceduel/kspaceduel3.png diff --git a/doc/ktron/Makefile.am b/doc/ktron/Makefile.am new file mode 100644 index 00000000..368fc0da --- /dev/null +++ b/doc/ktron/Makefile.am @@ -0,0 +1,4 @@ + +KDE_DOCS = AUTO +KDE_LANG = en + diff --git a/doc/ktron/index.docbook b/doc/ktron/index.docbook new file mode 100644 index 00000000..52a76da6 --- /dev/null +++ b/doc/ktron/index.docbook @@ -0,0 +1,575 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY kappname "&ktron;"> + <!ENTITY package "kdegames"> + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE"> +]> + +<book lang="&language;"> +<bookinfo> +<title>The &ktron; Handbook</title> + +<authorgroup> +<author> +<firstname>Fabian</firstname> +<surname>Dal Santo</surname> +<affiliation> +<address>&Fabian.DalSanto.mail;</address> +</affiliation> +</author> + +<othercredit role="developer"> +<firstname>Matthias</firstname> +<surname>Kiefer</surname> +<affiliation> +<address>&Matthias.Kiefer.mail;</address> +</affiliation> +<contrib>Developer</contrib> +</othercredit> + +<othercredit role="reviewer"> +<firstname>Lauri</firstname> +<surname>Watts</surname> +<affiliation> +<address>&Lauri.Watts.mail;</address> +</affiliation> +<contrib>Reviewer</contrib> +</othercredit> +<!-- TRANS:ROLES_OF_TRANSLATORS--> +</authorgroup> + +<copyright> +<year>1999</year> +<year>2000</year> +<holder>&Matthias.Kiefer;</holder> +</copyright> + +<copyright> +<year>2001</year> +<holder>&Fabian.Dal.Santo;</holder> +</copyright> + +<legalnotice>&FDLNotice;</legalnotice> + +<date>2005-12-16</date> +<releaseinfo>1.1</releaseinfo> + +<abstract> +<para> +&ktron; is a simple <quote>Tron</quote> clone for &kde;, which you can +play alone or against a friend. +</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>kdegames</keyword> +<keyword>KTron</keyword> +<keyword>game</keyword> +<keyword>tron</keyword> +</keywordset> +</bookinfo> + +<chapter id="introduction"> +<title>Introduction</title> + +<para> +&ktron; is a simple Tron-Clone for the +<ulink url="http://www.kde.org">K Desktop Environment</ulink>. You can play +&ktron; against the computer or a friend. +</para> + +<para> +The aim of the game is to live longer than your opponent. To do that, +avoid running into a wall, your own tail and that of your opponent. +</para> + +</chapter> + +<chapter id="playing-ktron"> +<title>Playing &ktron;</title> + +<sect1 id="playing-ktron-rules"> +<title>Rules</title> + +<para> +Once a round is started, the players do not stop moving forward (unless the game +is paused). All you have to do is avoid crashing by changing your players +direction. Additionally you can try to hinder your opponent. For this it is +possible to increase the velocity by pressing your accelerator key. +</para> + +<para> +A round starts when all human players press a direction key. The initial moving +direction is then in this direction. +</para> + +<para> +If you want to interrupt playing, select +<guimenuitem>Pause</guimenuitem> from the <guimenu>Game</guimenu> menu +or hit the keyboard shortcut (see section <link linkend="keys">Default +Shortcuts</link>). Additionally the game is paused when the game loses the +keyboard focus, ⪚ when switching to an other window. +</para> + +<para>To continue the game, select the menu item +<guimenuitem>Pause</guimenuitem> again, or the keyboard shortcut. The +game will also continue if the human players press one of their direction keys. +But be careful, your player switches to this direction immediately. +</para> + + +<para>A game consists of several rounds, and ends if a player has at least +nine points, and additionally two more points than the opponent. +The current score is always displayed in the status bar. +</para> + +</sect1> + +<sect1 id="computerplayer"> +<title>The Computer Player</title> + +<para> +You can let the computer be Player One, Player Two or both players. +There are three difficulty levels: Beginner, Average and Expert.</para> + +<itemizedlist> +<listitem> +<para>If you choose Beginner, the computer doesn't care about +the opponent and just moves around. This is the same algorithm as used by +xtron-1.1.</para> +</listitem> +<listitem> +<para>At skill levels Average and Expert, the computer tries to hinder the +opponent when he comes near.</para> +</listitem> +</itemizedlist> + +<note><para>See the <link linkend="settings-menu"><guimenu>Settings</guimenu> +Menu</link> section for information on how to configure the computer player. +</para></note> + +</sect1> + +<sect1 id="using-keyboard"> +<title>Using the Keyboard</title> + +<para> +Each player has five keys. Four keys for changing the direction and one to +accelerate. +</para> + +<para> +The direction keys do not have to be held down. Simply press them once to change +the direction of your player. +</para> + +<para> +Acceleration only occurs while the acceleration key remains depressed. When you +release the acceleration key, velocity returns to normal. +</para> + +<note><para> +See section <link linkend="settings-menu"><guimenu>Settings</guimenu> +Menu</link> for information how to change the default keys. +</para></note> +</sect1> +</chapter> + +<chapter id="command"> +<title>Command Reference</title> + +<para>The following sections briefly describe each menubar option.</para> + +<sect1 id="game-menu"> +<title>The <guimenu>Game</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo> +</shortcut> +<guimenu>Game</guimenu> +<guimenuitem>New</guimenuitem> +</menuchoice></term> +<listitem><para><action>Starts a new game.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycap>P</keycap> +</shortcut> +<guimenu>Game</guimenu> +<guimenuitem>Pause</guimenuitem> +</menuchoice></term> +<listitem><para><action>Toggles whether the game is paused.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo> +</shortcut> +<guimenu>Game</guimenu> +<guimenuitem>Exit</guimenuitem> +</menuchoice></term> +<listitem><para><action>Quits.</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>Show Statusbar</guimenuitem> +</menuchoice></term> +<listitem><para><action>Shows or hides the Statusbar.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Shortcuts...</guimenuitem> +</menuchoice></term> +<listitem><para><action>Displays a standard &kde; shortcuts configurator.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure &kappname;...</guimenuitem> +</menuchoice></term> +<listitem><para><action>Opens a <link linkend="configuration">comprehensive dialog</link> +to configure various options.</action></para></listitem> +</varlistentry> +</variablelist> + +</sect1> + +<sect1 id="help"> +<title>The <guimenuitem>Help</guimenuitem> Menu</title> + +&help.menu.documentation; + +</sect1> + +<sect1 id="keys"> +<title>Default Shortcuts</title> + +<para>The following tables show you the default shortcuts.</para> + + +<table> +<title>Player 1 Shortcuts</title> +<tgroup cols="2"> +<thead> +<row> +<entry>Key Combo</entry> +<entry>Action</entry></row></thead> +<tbody> +<row> +<entry><keycap>R</keycap></entry> +<entry>Up</entry> +</row> +<row> +<entry><keycap>F</keycap></entry> +<entry>Down</entry> +</row> +<row> +<entry><keycap>G</keycap></entry> +<entry>Right</entry> +</row> +<row> +<entry><keycap>D</keycap></entry> +<entry>Left</entry> +</row> +<row> +<entry><keycap>A</keycap></entry> +<entry>Accelerate</entry> +</row> +</tbody> +</tgroup> +</table> + +<table> +<title>Player 2 Shortcuts</title> +<tgroup cols="2"> +<thead> +<row> +<entry>Key Combo</entry> +<entry>Action</entry> +</row> +</thead> +<tbody> +<row> +<entry><keycap>Up Arrow</keycap></entry> +<entry>Up</entry> +</row> +<row> +<entry><keycap>Down Arrow</keycap></entry> +<entry>Down</entry> +</row> +<row> +<entry><keycap>Right Arrow</keycap></entry> +<entry>Right</entry> +</row> +<row> +<entry><keycap>Left Arrow</keycap></entry> +<entry>Left</entry> +</row> +<row> +<entry><keycap>0</keycap></entry> +<entry>Accelerate</entry> +</row> +</tbody> +</tgroup> +</table> + +<table> +<title>General Shortcuts</title> +<tgroup cols="2"> +<thead> +<row> +<entry>Key Combo</entry> +<entry>Action</entry> +</row> +</thead> +<tbody> +<row> +<entry><keycap>P</keycap></entry> +<entry>Pause/Resume Game</entry> +</row> +<row> +<entry><keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo></entry> +<entry>New Game</entry> +</row> +<row> +<entry><keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo></entry> +<entry>Quit &ktron;</entry> +</row> +<row> +<entry><keycap>F1</keycap></entry> +<entry>Help Contents</entry> +</row> +<row> +<entry><keycombo +action="simul"><keycap>Shift</keycap><keycap>F1</keycap></keycombo></entry> +<entry>What's This Help</entry> +</row> +</tbody> +</tgroup> +</table> + +<para> +These shortcuts can be changed by selecting <menuchoice> +<guimenu>Settings</guimenu> <guimenuitem>Configure Shortcuts...</guimenuitem> +</menuchoice> from the menubar. +</para> + +</sect1> + +</chapter> + +<chapter id="configuration"> + +<title>The Configuration Dialog</title> + +<para>Selecting the <guimenuitem>Configure &kappname;...</guimenuitem> option +in the <guimenu>Settings</guimenu> menu will open a further dialog which lets +you tweak &kappname;'s behavior.</para> + +<para>This dialog is divided into three pages.</para> + +<sect1 id="configuration-general"> +<title>General Configuration</title> + +<variablelist> +<varlistentry> +<term><guilabel>Show winner by changing color</guilabel></term> +<listitem><para>Enable this box to improve visualizing that the game is over +by making &ktron; change the color of the loser's trail to the color of +the winner.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Disable acceleration</guilabel></term> +<listitem><para>Checking this box will disable the acceleration feature - +pressing the acceleration key will have no effect, both vehicles will always +travel with constant velocity.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Crash when moving in the opposite direction</guilabel></term> +<listitem><para>Enable this to make a vehicle crash into itself as soon as a +player attempts to move into the opposite direction (&ie; a vehicle moves left, +and the player tries to move to the right in one step). If this box is +not checked, nothing happens when a player attempts to move into the opposite +direction.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Player Names</guilabel></term> +<listitem><para>Specify custom names to use for the players to override the use of default ones.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Speed</guilabel></term> +<listitem><para>Use this slider to define how fast the vehicles move; moving the +slider to the left will make the vehicles move slower, moving it to the right +will make them move faster.</para></listitem> +</varlistentry> +</variablelist> +</sect1> + +<sect1 id="configuration-ai"> +<title><acronym>AI</acronym> Configuration</title> + +<variablelist> +<varlistentry> +<term><guilabel>Computer Controls</guilabel></term> +<listitem><para>Use these two checkable boxes to define which players should +be controlled by the computer.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Intelligence:</guilabel></term> +<listitem><para>Selects the skill level of the computer player, +<guimenuitem>Beginner</guimenuitem>, <guimenuitem>Average</guimenuitem> or +<guimenuitem>Expert</guimenuitem></para> +<para><guimenuitem>Beginner</guimenuitem> ignores the opponent, and just moves +randomly. <guimenuitem>Average</guimenuitem> or +<guimenuitem>Expert</guimenuitem> causes the computer to actively hinder the +opponent.</para></listitem> +</varlistentry> +</variablelist> +</sect1> + +<sect1 id="configuration-appearance"> +<title>Appearance Configuration</title> + +<variablelist> +<varlistentry> +<term><guilabel>Line style:</guilabel></term> +<listitem><para>Here you can choose one of four different line styles to be +used for drawing the vehicles. The names of the styles are self-explanatory: +<guimenuitem>3D Line</guimenuitem>, <guimenuitem>3D Rectangles</guimenuitem>, +<guimenuitem>Flat</guimenuitem> and <guimenuitem>Circles</guimenuitem>.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Line Size</guilabel></term> +<listitem><para>Use this slider to define how broad the trail of a vehicle should +be. Moving the slider towards the left will make the trail more narrow, moving +it to the right will result in a wider trail.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Background</guilabel></term> +<listitem><para>Here you can define the appearance of the playground's +background. If you prefer a simple solid color, select the +<guilabel>Color:</guilabel> option and click on the button at the right of it +to open a convenient color-selection dialog.</para> +<para>You can also choose a background image for the playground. To do so, +select the <guilabel>Image:</guilabel> option, and then provide the filename +of a wallpaper image to use in the input field at the right. Alternatively you +can click on the little button at the very right to open the well-known +file-selection dialog.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Player 1 color:</guilabel></term> +<listitem><para>Click on the colored rectangle to open a color-selection dialog +which lets you define the color to be used for the vehicle of the first +player.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Player 2 color:</guilabel></term> +<listitem><para>Click on the colored rectangle to open a color-selection dialog +which lets you define the color to be used for the vehicle of the second +player.</para></listitem> +</varlistentry> +</variablelist> +</sect1> +</chapter> + +<!-- credits chapter done --> +<chapter id="credits"> +<title>Credits and License</title> + +<para> +&ktron; +</para> +<para>Program Copyright 1999 &Matthias.Kiefer; +&Matthias.Kiefer.mail; +</para> + +<para> +Parts of the code are from xtron-1.1 by Rhett D. Jacobs +<email>rhett@hotel.canberra.edu.au></email> +</para> + +<para> +Documentation Copyright 1999 &Matthias.Kiefer; +&Matthias.Kiefer.mail; +</para> + +<para>Documentation updated for &kde; 2.0 by &Fabian.Dal.Santo; +&Fabian.DalSanto.mail;</para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> +&underFDL; +&underGPL; +</chapter> + +<!-- appendix finished --> + +<appendix id="installation"> +<title>Installation</title> + +<sect1 id="getting-ktron"> +<title>How to obtain &ktron;</title> + +&install.intro.documentation; + +</sect1> + +<sect1 id="requirements"> +<title>Requirements</title> + +<para> +In order to successfully compile &ktron;, you need &kde; 3.0. All +required libraries as well as &ktron; itself can be found on &kde-ftp;.</para> +</sect1> + +<sect1 id="compilation"> +<title>Compilation and Installation</title> + +&install.compile.documentation; + +<para>Should you run into problems, please report them to the the +author at <ulink url="mailto:matthias.kiefer@gmx.de">&Matthias.Kiefer;</ulink> +</para> + +</sect1> +</appendix> + +</book> +<!-- +Local Variables: +mode: sgml +sgml-omittag: nil +sgml-shorttag: t +End: +--> + diff --git a/doc/ktuberling/Makefile.am b/doc/ktuberling/Makefile.am new file mode 100644 index 00000000..368fc0da --- /dev/null +++ b/doc/ktuberling/Makefile.am @@ -0,0 +1,4 @@ + +KDE_DOCS = AUTO +KDE_LANG = en + diff --git a/doc/ktuberling/button-new.png b/doc/ktuberling/button-new.png Binary files differnew file mode 100644 index 00000000..4e744438 --- /dev/null +++ b/doc/ktuberling/button-new.png diff --git a/doc/ktuberling/button-open.png b/doc/ktuberling/button-open.png Binary files differnew file mode 100644 index 00000000..c62d21d6 --- /dev/null +++ b/doc/ktuberling/button-open.png diff --git a/doc/ktuberling/button-print.png b/doc/ktuberling/button-print.png Binary files differnew file mode 100644 index 00000000..8a48c035 --- /dev/null +++ b/doc/ktuberling/button-print.png diff --git a/doc/ktuberling/button-redo.png b/doc/ktuberling/button-redo.png Binary files differnew file mode 100644 index 00000000..67733a91 --- /dev/null +++ b/doc/ktuberling/button-redo.png diff --git a/doc/ktuberling/button-save.png b/doc/ktuberling/button-save.png Binary files differnew file mode 100644 index 00000000..49e4dae5 --- /dev/null +++ b/doc/ktuberling/button-save.png diff --git a/doc/ktuberling/button-undo.png b/doc/ktuberling/button-undo.png Binary files differnew file mode 100644 index 00000000..fb918436 --- /dev/null +++ b/doc/ktuberling/button-undo.png diff --git a/doc/ktuberling/gameboard.png b/doc/ktuberling/gameboard.png Binary files differnew file mode 100644 index 00000000..0d1fd1c4 --- /dev/null +++ b/doc/ktuberling/gameboard.png diff --git a/doc/ktuberling/index.docbook b/doc/ktuberling/index.docbook new file mode 100644 index 00000000..33b87804 --- /dev/null +++ b/doc/ktuberling/index.docbook @@ -0,0 +1,811 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY kappname "&ktuberling;"> + <!ENTITY package "kdegames"> + <!ENTITY technical.reference SYSTEM "technical-reference.docbook"> + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE" > <!-- change language only here --> +]> + +<book lang="&language;"> +<bookinfo> +<title>The &ktuberling; Handbook</title> +<authorgroup> + +<author> +<firstname>Éric</firstname> +<surname>Bischoff</surname> +<affiliation> +<address>&Eric.Bischoff.mail;</address> +</affiliation></author> + +<author> +<firstname>Paul</firstname> +<othername>E.</othername> +<surname>Ahlquist</surname> +<lineage>Jr.</lineage> +<affiliation> +<address>&Paul.E.Ahlquist.Jr.mail;</address> +</affiliation> +</author> + +<othercredit role="reviewer"> +<firstname>Lauri</firstname> +<surname>Watts</surname> +<contrib>Reviewer</contrib> +</othercredit> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> + +</authorgroup> + +<date>2006-05-05</date> +<releaseinfo>0.05.01</releaseinfo> + +<copyright> +<year>1999</year><year>2000</year><year>2002</year><year>2006</year> +<holder>Éric Bischoff</holder> +</copyright> + +<copyright> +<year>2001</year> +<holder>&Paul.E.Ahlquist.Jr;</holder> +</copyright> + +<legalnotice>&FDLNotice;</legalnotice> + +<abstract> +<para> +&ktuberling; is a game intended for small children. +</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KTuberling</keyword> +<keyword>game</keyword> +<keyword>children</keyword> +<keyword>tuberling</keyword> +<keyword>potato</keyword> +<keyword>penguin</keyword> +<keyword>aquarium</keyword> +</keywordset> +</bookinfo> + +<chapter id="introduction"> +<title>Introduction</title> + +<para> +<inlinemediaobject><imageobject> +<imagedata fileref="ktuberling.png" format="PNG"/></imageobject> +</inlinemediaobject> +&ktuberling; is a game intended for small children. Of course, it may be +suitable for adults who have remained young at heart. +</para> + +<para> +It is a <quote>potato editor</quote>. That means that you can drag and drop +eyes, mouths, mustache, and other parts of face and goodies onto a potato-like +guy. Similarly, you have a penguin and an aquarium on which you can drop other stuff. +</para> + +<para> +There is no winner for the game. The only purpose is to make the funniest faces +you can. +</para> + +<para> +There is a museum (like a <quote>Madame Tusseau</quote> gallery) where +you can find many funny examples of decorated potatoes, penguins and +aquariums. Of course, you can send your own creations to the programmer, +<ulink url="mailto:ebischoff@nerim.net">Éric Bischoff</ulink>, who will +include them in the museum if he gets some spare time. +</para> + +<para> +&ktuberling; can also <quote>speak</quote>. It will spell out the name of +the objects you drag and drop. It will <quote>speak</quote> in a language +that you can chose. You can even use it to learn a bit of vocabulary +in foreign languages. Currently, &ktuberling; can <quote>speak</quote> +Danish, German, English, Spanish, French, Italian, Dutch, Portuguese, Romanian, +Serbian, Slovak, Slovenian and Swedish. +</para> +</chapter> + +<chapter id="onscreen-fundamentals"> +<title>On Screen Fundamentals</title> + +<sect1 id="mouse-operation"> +<title>Mouse Operation</title> + +<para> +There are two areas in the main window: +</para> + +<itemizedlist> +<listitem><para><quote>Playground</quote> area, on the left side. +</para></listitem> +<listitem><para> +<quote>Objects</quote> area, on the right side, where you select objects to +place on your playground. +</para></listitem> +</itemizedlist> + +<screenshot> +<screeninfo>Main Window of &ktuberling;</screeninfo> +<mediaobject> +<imageobject> +<imagedata format="PNG" fileref="gameboard.png"/> +</imageobject> +<imageobject> +<imagedata format="EPS" fileref="gameboard.eps"/> +</imageobject> +<textobject><phrase>Main Window</phrase></textobject> +</mediaobject> +</screenshot> + +<sect2 id="place-object"> +<title>Placing an Object</title> + +<para> +To drag an object, move the mouse pointer to the <quote>objects</quote> +area on the right. Click on the object you want to drag, but do not release +the mouse button until you have moved the mouse pointer to the location in +the <quote>playground</quote> area where you want to drop the object. +</para> +</sect2> + +<sect2 id="move-object"> +<title>Moving an Object</title> +<para> +Once dropped in the <quote>playground</quote> area, an object can be moved. +Just click on the object to select it for further drag and drop. When you +click on it, it goes on top of other objects that were partially hiding it. +This trick is useful for getting the glasses and eyes placed correctly. +</para> +</sect2> + +<sect2 id="remove-object"> +<title>Removing an Object</title> +<para> +To remove an object that has been dropped in the <quote>playground</quote> +area, drag it back from the <quote>playground</quote> area to the +<quote>objects</quote> area. +</para> +</sect2> +</sect1> + +<sect1 id="the-tool-bar"> +<title>The Tool Bar</title> + +<mediaobject> +<imageobject> +<imagedata format="PNG" fileref="toolbar.png"/> +</imageobject> +<imageobject> +<imagedata format="EPS" fileref="toolbar.eps"/> +</imageobject> +<textobject><phrase>Toolbar</phrase></textobject> +</mediaobject> + +<para> +The toolbar provides buttons for the commonly used functions. +</para> + +<table> +<title>Toolbar Buttons</title> +<tgroup cols="4"> + +<thead> +<row> +<entry>Button</entry> +<entry>Name</entry> +<entry>Menu Equivalent</entry> +<entry>Action</entry> +</row> +</thead> +<tbody> + +<row> +<entry> + <inlinemediaobject> + <imageobject> + <imagedata format="PNG" fileref="button-new.png"/> + </imageobject> + <imageobject> + <imagedata format="EPS" fileref="button.new.eps"/> + </imageobject> + <textobject><phrase>New Game Button</phrase></textobject> + </inlinemediaobject> + </entry> +<entry> + <guiicon>New</guiicon></entry> +<entry> + <link linkend="game-new"><menuchoice> + <guimenu>Game</guimenu> <guimenuitem>New</guimenuitem></menuchoice> + </link> + </entry> +<entry> +Resets the <quote>playground</quote> area. This cleans all parts off the +playground so a new decoration may be created. +</entry> +</row> + + +<row> +<entry> + <inlinemediaobject> + <imageobject> + <imagedata format="PNG" fileref="button-open.png"/> + </imageobject> + <imageobject> + <imagedata format="EPS" fileref="button.open.eps"/> + </imageobject> + <textobject><phrase>Load Button</phrase></textobject> + </inlinemediaobject> + </entry> +<entry><guiicon>Load</guiicon></entry> +<entry> + <link linkend="game-load"><menuchoice> + <guimenu>Game</guimenu> <guimenuitem>Load...</guimenuitem></menuchoice> + </link> + </entry> +<entry> +Opens an existing tuberling file from the museum or from other folders. +</entry> +</row> + +<row> +<entry> + <inlinemediaobject> + <imageobject> + <imagedata format="PNG" fileref="button-save.png"/> + </imageobject> + <imageobject> + <imagedata format="EPS" fileref="button.save.eps"/> + </imageobject> + <textobject><phrase>Save Button</phrase></textobject> + </inlinemediaobject> +</entry> +<entry><guiicon>Save</guiicon></entry> +<entry> + <link linkend="game-save"><menuchoice> + <guimenu>Game</guimenu> <guimenuitem>Save</guimenuitem></menuchoice> + </link> + </entry> +<entry> +Saves your creation to your home folder, or to some other folder like +the museum if you wish. The tuberling is saved to a small file where only the +position of objects are saved. +</entry> +</row> + + +<row> +<entry> + <inlinemediaobject> + <imageobject> + <imagedata format="PNG" fileref="button-print.png"/> + </imageobject> + <imageobject> + <imagedata format="EPS" fileref="button.print.eps"/> + </imageobject> + <textobject><phrase>Print Button</phrase></textobject> +</inlinemediaobject> +</entry> +<entry> +<guiicon>Print</guiicon> +</entry> +<entry> + <link linkend="game-print"><menuchoice> + <guimenu>Game</guimenu> <guimenuitem>Print</guimenuitem></menuchoice> + </link> + </entry> +<entry> +Prints your picture (&PostScript; format). +</entry> +</row> + +<row> +<entry> + <inlinemediaobject> + <imageobject> + <imagedata format="PNG" fileref="button-undo.png"/> + </imageobject> + <imageobject> + <imagedata format="EPS" fileref="button.undo.eps"/> + </imageobject> + <textobject><phrase>Undo Button</phrase></textobject> + </inlinemediaobject> + </entry> +<entry> + <guiicon>Undo</guiicon> + </entry> +<entry> + <link linkend="edit-undo"><menuchoice> + <guimenu>Edit</guimenu> <guimenuitem>Undo</guimenuitem></menuchoice> + </link> + </entry> +<entry>Undoes last operation.</entry> +</row> + +<row> +<entry> + <inlinemediaobject> + <imageobject> + <imagedata format="PNG" fileref="button-redo.png"/> + </imageobject> + <imageobject> + <imagedata format="EPS" fileref="button.redo.eps"/> + </imageobject> + <textobject><phrase>Redo Button</phrase></textobject> + </inlinemediaobject> + </entry> +<entry> +<guiicon>Redo</guiicon> +</entry> +<entry> + <link linkend="edit-redo"><menuchoice> + <guimenu>Edit</guimenu> <guimenuitem>Redo</guimenuitem></menuchoice> + </link> + </entry> +<entry> +Re-does last operation.</entry> +</row> + +<!-- Currently there is no HELP button on the toolbar +<row> +<entry> +<inlinemediaobject> +<imageobject> +<imagedata format="PNG" fileref="button-help.png"/> +</imageobject> +<imageobject> +<imagedata format="EPS" fileref="button.help.eps"/> +</imageobject> +<textobject><phrase>Help Button</phrase></textobject> +</inlinemediaobject> +</entry> +<entry> +Help +</entry> +<entry>Displays this handbook.</entry> +</row> +--> + +</tbody> +</tgroup> +</table> +</sect1> + +<sect1 id="the-menu-items"> +<title>The Menu Items</title> + +<mediaobject> +<imageobject> +<imagedata format="PNG" fileref="menu-raw.png"/> +</imageobject> +<imageobject> +<imagedata format="EPS" fileref="menu.raw.eps"/> +</imageobject> +<textobject><phrase>Menu Bar</phrase></textobject> +</mediaobject> + +<sect2> +<title>The <guimenu>Game</guimenu> Menu</title> +<mediaobject> +<imageobject> +<imagedata format="PNG" fileref="menu-game.png"/> +</imageobject> +<imageobject> +<imagedata format="EPS" fileref="menu.game.eps"/> +</imageobject> +<textobject><phrase><guimenu>File</guimenu> Menu</phrase></textobject> +</mediaobject> + +<variablelist> + +<varlistentry id="game-new"> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo> + </shortcut> +<guimenu>Game</guimenu> + <guimenuitem>New</guimenuitem> + </menuchoice></term> +<listitem><para><action>Clears</action> the <quote>playground</quote> +area </para></listitem> +</varlistentry> + +<varlistentry id="game-load"> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo> + </shortcut> +<guimenu>Game</guimenu> + <guimenuitem>Load...</guimenuitem> + </menuchoice></term> + <listitem><para><action>Opens an existing tuberling file</action> from +the museum or from somewhere else if you wish.</para></listitem> +</varlistentry> + +<varlistentry id="game-save"> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo> +</shortcut> +<guimenu>Game</guimenu> +<guimenuitem>Save</guimenuitem> +</menuchoice></term> +<listitem><para><action>Saves</action> your creation. The tuberling is +saved to a small file where only the position of objects are saved. +</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Game</guimenu> +<guimenuitem>Save as Picture...</guimenuitem> +</menuchoice></term> +<listitem><para><action>Creates a graphics file</action> +containing a picture of your tuberling. Available file formats +are XPM, JPEG, PNG and BMP. +</para></listitem> +</varlistentry> + +<varlistentry id="game-print"> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>P</keycap></keycombo> +</shortcut> +<guimenu>Game</guimenu> +<guimenuitem>Print...</guimenuitem> +</menuchoice></term> +<listitem><para><action>Print</action> your tuberling picture using + &PostScript; format. +</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><action>Quit</action> &ktuberling;. +</para></listitem> +</varlistentry> + +</variablelist> + +</sect2> + +<sect2> +<title>The <guimenu>Edit</guimenu> Menu</title> +<mediaobject> +<imageobject> +<imagedata format="PNG" fileref="menu-edit.png"/> +</imageobject> +<imageobject> +<imagedata format="EPS" fileref="menu.edit.eps"/> +</imageobject> +<textobject><phrase>Edit Menu</phrase></textobject> +</mediaobject> + +<variablelist> + +<varlistentry id="edit-undo"> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>Z</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Undo</guimenuitem> +</menuchoice></term> +<listitem><para><action>Undo</action> the last +<quote>object</quote> placement. +</para></listitem> +</varlistentry> + +<varlistentry id="edit-redo"> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>Shift</keycap> +<keycap>Z</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Redo</guimenuitem> +</menuchoice></term> +<listitem><para><action>Re-does</action> the last <quote>object</quote> +placement. This menu option is active only if you have previously used +<guilabel>Undo</guilabel>. +</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>C</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Copy</guimenuitem> +</menuchoice></term> +<listitem><para><action>Copy</action> the <quote>playground</quote> area to the +clipboard.</para></listitem> +</varlistentry> + +</variablelist> + +</sect2> + +<sect2> +<title>The <guimenu>Playground</guimenu> Menu</title> + +<mediaobject> +<imageobject> +<imagedata format="PNG" fileref="menu-playground.png"/> +</imageobject> +<imageobject> +<imagedata format="EPS" fileref="menu.playground.eps"/> +</imageobject> +<textobject><phrase><guimenu>Playground</guimenu> Menu</phrase></textobject> +</mediaobject> + +<variablelist> + +<varlistentry> +<term><menuchoice> +<guimenu>Playground</guimenu> +<guimenuitem>Potato Guy</guimenuitem> +</menuchoice></term> +<listitem><para><action>Switches to potato playground</action>. +&ktuberling; remembers the last chosen playground the next +time it starts up.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Playground</guimenu> +<guimenuitem>Penguin</guimenuitem> +</menuchoice></term> +<listitem><para><action>Switches to penguin playground</action>. +&ktuberling; remembers the last chosen playground the next +time it starts up.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Playground</guimenu> +<guimenuitem>Aquarium</guimenuitem> +</menuchoice></term> +<listitem><para><action>Switches to aquarium playground</action>. +&ktuberling; remembers the last chosen playground the next +time it starts up.</para></listitem> +</varlistentry> +</variablelist> +</sect2> + +<sect2> +<title>The <guimenu>Speech</guimenu> Menu</title> + +<mediaobject> +<imageobject> +<imagedata format="PNG" fileref="menu-speech.png"/> +</imageobject> +<imageobject> +<imagedata format="EPS" fileref="menu.speech.eps"/> +</imageobject> +<textobject><phrase><guimenu>Speech</guimenu> Menu</phrase></textobject> +</mediaobject> + +<para> +Please note that you need to have kdemultimedia installed +and <command>&artsd;</command> running to be able to hear sounds. +</para> + +<variablelist> + +<varlistentry> +<term><menuchoice> +<guimenu>Speech</guimenu> +<guimenuitem>No Sound</guimenuitem> +</menuchoice></term> +<listitem><para><action>Toggles sound off</action>. &ktuberling; +remembers of this option the next time it starts up.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Speech</guimenu> +<guimenuitem>Danish</guimenuitem> +</menuchoice></term> +<listitem><para><action>Toggles sound on and speaks Danish</action>. +If Danish sounds are not installed then this option is grayed out. &ktuberling; +remembers of this option the next time it starts up.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Speech</guimenu> +<guimenuitem>German</guimenuitem> +</menuchoice></term> +<listitem><para><action>Toggles sound on and speaks German</action>. +If German sounds are not installed then this option is grayed out. &ktuberling; +remembers of this option the next time it starts up.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Speech</guimenu> +<guimenuitem>English</guimenuitem> +</menuchoice></term> +<listitem><para><action>Toggles sound on and speaks English</action>. +If English sounds are not installed then this option is grayed out. &ktuberling; +remembers of this option the next time it starts up.</para></listitem> +</varlistentry> + +<varlistentry> +<term>etc...</term> +<listitem><para>Same for the other languages.</para></listitem> +</varlistentry> +</variablelist> +</sect2> + +<sect2> +<title>The <guimenu>Settings</guimenu> Menu</title> +<mediaobject> +<imageobject> +<imagedata format="PNG" fileref="menu-settings.png"/> +</imageobject> +<textobject><phrase>Settings Menu</phrase></textobject> +</mediaobject> + +<variablelist> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Show/Hide Toolbar</guimenuitem> +</menuchoice></term> +<listitem><para><action>Toggle the Toolbar display</action> on and off. +</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Shortcuts...</guimenuitem> +</menuchoice></term> +<listitem><para>Opens a standard &kde; shortcut configuration dialog, where you can change the +keyboard shortcuts used by &ktuberling;. +</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Toolbars...</guimenuitem> +</menuchoice></term> +<listitem><para>Display the standard &kde; toolbar configuration dialog.</para></listitem> +</varlistentry> + +</variablelist> + +</sect2> + +<sect2> +<title>The <guimenu>Help</guimenu> Menu</title> +<mediaobject> +<imageobject> +<imagedata format="PNG" fileref="menu-help.png"/> +</imageobject> +<imageobject> +<imagedata format="EPS" fileref="menu.help.eps"/> +</imageobject> +<textobject><phrase>Help Menu</phrase></textobject> +</mediaobject> + +&help.menu.documentation; + +</sect2> +</sect1> +</chapter> + +&technical.reference; + +<chapter id="credits_license"> +<title>Credits and License</title> + +<para>&ktuberling;</para> + +<itemizedlist> +<listitem> +<para>John Calhoun - Original idea, original pictures and English +sounds</para> +</listitem> + +<listitem> +<para>Éric Bischoff &Eric.Bischoff.mail; - &kde; +Programming</para> +</listitem> + +<listitem> +<para>François-Xavier Duranceau <email>duranceau@free.fr</email> - Tests, +advice and help</para> +</listitem> + +<listitem> +<para>Agnieszka Czajkowska <email>agnieszka@imagegalaxy.de</email> - Penguin graphics</para> +</listitem> + +<listitem> +<para>Bas Willems <email>next@euronet.nl</email> - Graphics reworks and aquarium theme</para> +</listitem> + +<listitem> +<para>Roger Larsson <email>roger.larsson@norran.net</email> - Sounds tuning</para> +</listitem> + +<listitem> +<para>Dolores Almansa <email>dolores.almansa@corazondemaria.org</email> - Educative graphics for COR-EDUX initiative</para> +</listitem> + +<listitem> +<para>Peter Silva <email>peter.silva@videotron.ca</email> - Proofreading of +the documentation</para> +</listitem> + +<listitem> +<para>Paul Ahlquist &Paul.E.Ahlquist.Jr.mail; - Bettering of +documentation</para> +</listitem> +</itemizedlist> + +<para>This game is dedicated to my little daughter Sunniva Bischoff</para> + +<para>Thanks to Apple Computer and to the &LinuxPPC; project for having made +ports of &Linux; to the &Mac;. &ktuberling; would never have existed without +that!</para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +&underFDL; +&underGPL; + +</chapter> + + +<appendix id="installation"> +<title>Installation</title> + +<sect1 id="how-to-obtain-ktuberling"> +<title>How to obtain <application>ktuberling</application></title> + +&install.intro.documentation; + +</sect1> + +<sect1 id="requirements"> +<title>Requirements</title> + +<para> +In order to successfully compile &ktuberling;, you need &kde; 3.5. +All required libraries as well as &ktuberling; itself can be found on +&kde-ftp;.</para> + +<para> +To be able to hear the sounds, you need to have kdemultimedia installed. +</para> +</sect1> + +<sect1 id="compilation-and-installation"> +<title>Compilation and Installation</title> + +&install.compile.documentation; + +</sect1> +</appendix> + +</book> diff --git a/doc/ktuberling/ktuberling.png b/doc/ktuberling/ktuberling.png Binary files differnew file mode 100644 index 00000000..3b44966d --- /dev/null +++ b/doc/ktuberling/ktuberling.png diff --git a/doc/ktuberling/menu-edit.png b/doc/ktuberling/menu-edit.png Binary files differnew file mode 100644 index 00000000..d5090713 --- /dev/null +++ b/doc/ktuberling/menu-edit.png diff --git a/doc/ktuberling/menu-game.png b/doc/ktuberling/menu-game.png Binary files differnew file mode 100644 index 00000000..93981973 --- /dev/null +++ b/doc/ktuberling/menu-game.png diff --git a/doc/ktuberling/menu-help.png b/doc/ktuberling/menu-help.png Binary files differnew file mode 100644 index 00000000..dd02e340 --- /dev/null +++ b/doc/ktuberling/menu-help.png diff --git a/doc/ktuberling/menu-playground.png b/doc/ktuberling/menu-playground.png Binary files differnew file mode 100644 index 00000000..c85a7e45 --- /dev/null +++ b/doc/ktuberling/menu-playground.png diff --git a/doc/ktuberling/menu-raw.png b/doc/ktuberling/menu-raw.png Binary files differnew file mode 100644 index 00000000..0e0276c6 --- /dev/null +++ b/doc/ktuberling/menu-raw.png diff --git a/doc/ktuberling/menu-settings.png b/doc/ktuberling/menu-settings.png Binary files differnew file mode 100644 index 00000000..c581dac7 --- /dev/null +++ b/doc/ktuberling/menu-settings.png diff --git a/doc/ktuberling/menu-speech.png b/doc/ktuberling/menu-speech.png Binary files differnew file mode 100644 index 00000000..b8f6e1c5 --- /dev/null +++ b/doc/ktuberling/menu-speech.png diff --git a/doc/ktuberling/technical-reference.docbook b/doc/ktuberling/technical-reference.docbook new file mode 100644 index 00000000..94abf945 --- /dev/null +++ b/doc/ktuberling/technical-reference.docbook @@ -0,0 +1,262 @@ +<chapter id="technical-reference"> +<chapterinfo> + +<authorgroup> +<author> +<firstname>Éric</firstname> +<surname>Bischoff</surname> +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2006-05-05</date> +<releaseinfo>0.05.01</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KTuberling</keyword> +<keyword>technical reference</keyword> +</keywordset> +</chapterinfo> + +<title>Technical reference</title> + +<para> +&ktuberling; offers a gentle and rewarding introduction to &kde; customization +and programming. The application can be extended. For example, without any +coding, new playgrounds can be added by changing the graphics files. By +adding appropriate sound files, translators can change the sounds to their +native tongue! +</para> + +<para> +If you extend or add to the game please consider sending your additions to the +developer <ulink url="mailto:ebischoff@nerim.net">Éric Bischoff</ulink> for +inclusion in future releases. +</para> + +<sect1 id="for-artists"> +<title>For artists</title> + +<para> +The size and shape of the playground and the number of objects can be +changed. New playgrounds can be added. Only two image files need to be +created for each playground: a gameboard and a mask. A maximum of 8 +playgrounds is allowed, out of which only 3 are currently used. +</para> + +<para> +Six images are used in &ktuberling;: <filename>potato-game.png</filename>, +<filename>potato-mask.png</filename>, <filename>penguin-game.png</filename>, +<filename>penguin-mask.png</filename>, <filename>aquarium-game.png</filename> +and <filename>aquarium-mask.png</filename>. The standard location +for these files is the folder <filename +class="directory">$KDEDIR/share/apps/ktuberling/pics/</filename>. +</para> + +<para> +The first type of images, <filename>*-game.png</filename> holds the playground +and the objects that the user selects. This is the graphic that the user sees +when playing the game. +</para> + +<para> +The second type of images, <filename>*-mask.png</filename>, contains only masks of the +objects. The masks are used to delimit the borders of the objects and, in some +cases, give the object some transparency (for example, the spectacles). It is +mandatory to put the objects at the same position in +the gameboard file as in the mask file. +</para> + +<para> +In the same folder, a file named <filename>layout.xml</filename>. +(<filename>$KDEDIR/share/apps/ktuberling/pics/layout.xml</filename>) tells +which images to use and links them to menu entries. It also contains the +position parameters of the playground and the objects in the gameboard and +in the masks. It assigns the sounds to objects and places the +objects in groups. It finally declares languages as sets of translated sounds. +It follows standard &XML; syntax (see details +<link linkend="layout-details">below</link>). +</para> + +<para> +Still in the same folder, a file named <filename>layout.i18n</filename> +(<filename>$KDEDIR/share/apps/ktuberling/pics/layout.xml</filename>) +recapitulates the strings in <filename>layout.xml</filename> that can be +translated: +<itemizedlist> +<listitem><para>The menu entries that allow to choose the playground and the language</para></listitem> +<listitem><para>The names of the categories of objects</para></listitem> +</itemizedlist> +</para> + +<para> +One folder above, a file named <filename>ktuberlingui.rc</filename> +(<filename>$KDEDIR/share/apps/ktuberling/ktuberlingui.rc</filename>) is a +second &XML; file describing the menus of &ktuberling;. It should contain +one <markup><action></markup> tag per playground and language. +The symbolic name of the action in this file should be identical to +the symbolic name of the action in <filename>layout.xml</filename>. +</para> + +</sect1> + +<sect1 id="for-translators"> +<title>Translation</title> + +<para> +Besides the usual <literal role="extension">.po</literal> files mechanism for +translating program labels and prompts, the sounds can be localized too. +</para> + +<para> +If the various +translators can record their voice to a <literal role="extension">.wav</literal> +file, they can store that file to the language-specific subfolder of the +sounds folder. The name of the sound is then assigned to a file in the +<filename>layout.xml</filename> file. For example, if destination language is +Italian, translators can record their voice in <literal +role="extension">.wav</literal> files located in +<filename>$KDEDIR/share/apps/ktuberling/sounds/it</filename>. Then they can +assign the sound named <quote>hat</quote> to the filename +<filename>it/cappello.wav</filename>. +</para> + +<para> +In a future release, &ktuberling; will use OGG Vorbis rc3 file format for sounds. +At that moment, it will be possible to convert the WAV files to OGG Vorbis rc3 +through the following command line: +<screen> +<prompt>$</prompt> <userinput>oggenc -q 10 -o <replaceable>sound.ogg</replaceable> <replaceable>sound.wav</replaceable></userinput> +</screen> +</para> + +<para> +Information on how to work with the translation mechanisms in &kde; is available +in <ulink url="http://i18n.kde.org/translation-howto/index.html">The +&kde; Translation HOWTO</ulink>. +</para> + +</sect1> + +<sect1 id="for-programmers"> + +<title>For programmers</title> +<para>&ktuberling; isn't really difficult to extend for programmers.</para> + +<sect2 id="classes"> +<title>C++ classes</title> + +<variablelist> +<varlistentry> +<term><classname>TopLevel</classname></term> +<listitem> +<para>Top-level window and basic program management</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><classname>PlayGround</classname></term> +<listitem> +<para>Description of one of the game levels</para> </listitem> +</varlistentry> + +<varlistentry> +<term><classname>ToDraw</classname></term> +<listitem> +<para>Description of one of the graphical <quote>objects</quote> to be +drawn</para> </listitem> +</varlistentry> + +<varlistentry> +<term><classname>SoundFactory</classname></term> +<listitem> +<para>Description of one of the languages and its sounds</para> </listitem> +</varlistentry> + +<varlistentry> +<term><classname>Action</classname></term> +<listitem> +<para>One of the user's manipulation in the undo/redo stack</para> </listitem> +</varlistentry> +</variablelist> + +</sect2> + +<sect2 id="files-structure"> +<title><literal role="extension">.tuberling</literal> files structure</title> + +<para>A <literal role="extension">.tuberling</literal> file holds all the +necessary data to redraw a tuberling. It can be edited with an ordinary text +editor.</para> + +<para>The first line holds the number of the playground.</para> + +<para>On all other lines, there is one graphical object per line, in the order +that is used to draw them. Each line contains 5 numbers: the identifier of the object, +and the rectangle where it should be drawn (left, top, right, bottom). The numbers are +separated by whitespaces.</para> + +</sect2> +</sect1> + +<sect1 id="layout-details"> +<title>Structure of the layout file (<filename>layout.xml</filename>)</title> + +<para> +The top-level tag is unique and is named <markup><ktuberling></markup>. +It contains several <markup><playground></markup> tags, one per +playground, and several <markup><language></markup> tags, one per language. +</para> + +<para> +The <markup><playground></markup> tag has two attributes: <markup>gameboard</markup> +and <markup>masks</markup>. These attributes give the name of the files holding the +pictures. The <markup><playground></markup> tag also contains one +<markup><menuitem></markup> tag, one <markup><editablearea></markup> +tag, several <markup><category></markup> tags, and several +<markup><object></markup> tags. +</para> + +<para> +The <markup><menuitem></markup> tag describes the action identifier +of the menu item allowing to select position of the +area where you can drop objects, and the label of this menu item. +This action identifier should be identical to the one in +<filename>ktuberlingui.rc</filename>. +</para> + +<para> +The <markup><editablearea></markup> tag describes the position of the +area where you can drop objects, and the name of the sound associated with it. +</para> + +<para> +The <markup><category></markup> tag describes the position and +the label of a text describing a group of objects. For example, it +can describe the position and the text of the group of <quote>goodies</quote>. +</para> + +<para> +The <markup><object></markup> tag describes the position (in the +gameboard and in the masks) of an object, as well as the name of the sound +associated with it. +</para> + +<para> +The <markup><language></markup> tag has one attribute: <markup>code</markup> +This attribute give the code of the locale for that language. +The <markup><language></markup> tag also contains one +<markup><menuitem></markup> tag and several +<markup><sound></markup> tags. +</para> + +<para> +The lower level tags are not explained here, since their meaning is +quite straightforward. If you modify <filename>layout.xml</filename>, +don't forget to modify <filename>layout.i18n</filename> and +<filename>ktuberlingui.rc</filename> accordingly. +</para> + +</sect1> +</chapter> diff --git a/doc/ktuberling/toolbar.png b/doc/ktuberling/toolbar.png Binary files differnew file mode 100644 index 00000000..9ff20d9a --- /dev/null +++ b/doc/ktuberling/toolbar.png diff --git a/doc/kwin4/Makefile.am b/doc/kwin4/Makefile.am new file mode 100644 index 00000000..368fc0da --- /dev/null +++ b/doc/kwin4/Makefile.am @@ -0,0 +1,4 @@ + +KDE_DOCS = AUTO +KDE_LANG = en + diff --git a/doc/kwin4/index.docbook b/doc/kwin4/index.docbook new file mode 100644 index 00000000..afef0bfc --- /dev/null +++ b/doc/kwin4/index.docbook @@ -0,0 +1,441 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ +<!ENTITY kappname "&k4wins;"> +<!ENTITY package "kdegames"> +<!ENTITY % English "INCLUDE"> +<!ENTITY % addindex "IGNORE"> +]> + +<book lang="&language;"> +<bookinfo> +<title>Four Wins</title> + +<authorgroup> +<author> +<firstname>Martin</firstname> +<surname>Heni</surname> +<affiliation> +<address>&Martin.Heni.mail;</address> +</affiliation> +</author> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<copyright> +<year>1995</year><year>2002</year> +<holder>&Martin.Heni;</holder> +</copyright> + +<legalnotice>&FDLNotice;</legalnotice> + +<date>2006-06-17</date> +<releaseinfo>1.1.0</releaseinfo> + +<abstract> +<para> +&k4wins; is a four-in-a-row game for &kde;.</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>kdegames</keyword> +<keyword>game</keyword> +<keyword>board</keyword> +<keyword>board game</keyword> +<keyword>four wins</keyword> +<keyword>four</keyword> +<keyword>four in a row</keyword> +<keyword>win4</keyword> +<keyword>kwin4</keyword> +<keyword>connect four</keyword> +<keyword>connect 4</keyword> +</keywordset> +</bookinfo> + +<chapter id="overview"> +<title>Overview</title> + +<para> +Four wins is a game for two players. +</para> + +<para> +Each player is represented by a color (yellow and red). The goal of the +game is to get four connected pieces of your color into a row, column or +any diagonal. This is done by placing one of your pieces into any of +the seven columns. +</para> + +<para> +A piece will begin to fill a column from the bottom, &ie; it +will fall down until it reaches the ground level or another stone. +After a move is done it is the turn of the other player. +</para> + +<para> +This is repeated until the game is over, which is when one of the +players has four pieces in a row, column or diagonal or no more moves +are possible because the board is filled. +</para> + +</chapter> + +<chapter id="rules"> +<title>Rules</title> + +<para> +The board is separated into three regions. +</para> + +<para> +The <firstterm>game board</firstterm> is constructed out of 7x6 fields +which will be filled from bottom to top. The fields are marked in the +color of the player who made the current move. On top of each column a +colored arrow shows were the last piece had been put. +</para> + +<para> +The <firstterm>status display</firstterm> shows which player color +starts and which color is played by whom (player, computer, remote +connection). It further shows the level of the computer opponent, the +number of moves done as well as the computer calculated chance of +winning. This chance is calculated only if the computer opponent makes a +move. A positive number means that the player has an advantage, a +negative number means that the computer thinks he is better. +</para> + +<para> +The <firstterm>table display</firstterm> shows the number of won, lost +and drawn games is noted for both player. Also the number of aborted +games (Brk) and the sum of games is shown. +</para> + +</chapter> + +<chapter id="remote-connections"> +<title>Remote connections</title> + +<para> +It is possible to play the game over a network connection with another +computer. +One of the computers will act as game server. This one can determine +who should play which color. You can configure the network options +in the menu <guimenu>Game</guimenu><guimenuitem>Network Configuration...</guimenuitem> +There you also find a chat dialog +box which allows you to speak with your friend. +</para> + + +<para> +When a network connection is build you are asked to enter a remote host +and a port. The port can usually just be left untouched, but if you know +what you are doing replace it by another number, which has to be the +same in both player games of course. The hostname should be the name of +the remote host to which you are connecting. Only the client in +the connection has to supply a hostname. It is often wise that the player +behind a firewall chooses to be client as the firewall might not allow +incoming connections. +</para> + +</chapter> + +<chapter id="menus"> +<title>Menus</title> + +<sect1 id="game-menu"> +<title><guimenu>Game</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo> +</shortcut> +<guimenu>Game</guimenu> +<guimenuitem>New</guimenuitem> +</menuchoice></term> +<listitem> +<para> +Starts a new game. In a network game this option is only available for +the network server. The network client will be automatically started by +the server. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo> +</shortcut> +<guimenu>Game</guimenu> +<guimenuitem>Load...</guimenuitem> +</menuchoice></term> +<listitem> +<para> +Loads a saved game. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo> +</shortcut> +<guimenu>Game</guimenu> +<guimenuitem>Save</guimenuitem> +</menuchoice></term> +<listitem> +<para> +Saves the current game. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>End</keycap></keycombo> +</shortcut> +<guimenu>Game</guimenu> +<guimenuitem>End Game</guimenuitem></menuchoice></term> +<listitem> +<para> +Aborts a running game. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Game</guimenu> +<guimenuitem>Network Configuration...</guimenuitem></menuchoice></term> +<listitem> +<para> +Pops up a dialog for the network configuration. You can choose to be +server or client. If you are server you can also choose what color the +remote player should take over. If a network game is running you can +also disconnect it in this menu. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Game</guimenu> +<guimenuitem>Network Chat...</guimenuitem></menuchoice></term> +<listitem> +<para> +Pops up a chat widget which allows you to send messages to the +other party. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycap>H</keycap> +</shortcut> +<guimenu>Game</guimenu> +<guimenuitem>Hint</guimenuitem> +</menuchoice></term> +<listitem> +<para> +The computer will calculate the best possible move and mark it with a +small circle on the board. How good the move is depends on the level of +the computer. +</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> +Quits the program. +</para> +</listitem> +</varlistentry> +</variablelist> + +</sect1> + +<sect1 id="edit-menu"> +<title><guimenu>Edit</guimenu> Menu</title> +<variablelist> +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>Z</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Undo</guimenuitem> +</menuchoice></term> +<listitem> +<para> +Undo the last move. If the previous player is played by the computer two +moves are taken back so that it is the player's turn again. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;&Shift;<keycap>Z</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Redo</guimenuitem> +</menuchoice></term> +<listitem> +<para> +Replay a move which had been undone. +</para> +</listitem> +</varlistentry> +</variablelist> + +</sect1> + + +<sect1 id="option-menu"> +<title><guimenu>Settings</guimenu> Menu</title> + +<variablelist> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Show Toolbar</guimenuitem> +</menuchoice></term> +<listitem> +<para> +Toggle on and off the display of the toolbar. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Show Statusbar</guimenuitem> +</menuchoice></term> +<listitem> +<para> +Toggle on and off the display of the status bar. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Shortcuts...</guimenuitem> +</menuchoice></term> +<listitem><para> +<action>Open a dialog which lets you redefine all the keyboard shortcuts.</action> +</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Toolbars...</guimenuitem> +</menuchoice></term> +<listitem><para>Displays a &kde; standard dialog where you can configure the toolbar icons.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure &k4wins;...</guimenuitem> +</menuchoice></term> +<listitem><para><action>Displays</action> the &k4wins; +configuration dialog with these options:</para> +<para><guilabel>Starting Player Color</guilabel>: Determine which color player has the first move in the next game.</para> +<para><guilabel>Player Names</guilabel>: Change the names of the players.</para> +<para><guilabel>Yellow Plays With</guilabel>: +Choose who should play for player 1 (yellow). It can be either +<guilabel>Mouse</guilabel> or <guilabel>Keyboard</guilabel>, +&ie; a local player using the mouse or keyboard +as input device or <guilabel>Computer</guilabel>, &ie; the computer +plays for this player.</para> +<para><guilabel>Red Plays With</guilabel>: Same as <guilabel>Yellow Playes With</guilabel> but for player 2 +(red).</para> +<para><guilabel>Computer Difficulty</guilabel>: Select the level of the computer player.</para> +</listitem> +</varlistentry> + +</variablelist> +</sect1> + +<sect1 id="help"> +<title><guimenuitem>Help</guimenuitem> Menu</title> + +&help.menu.documentation; + +</sect1> + +</chapter> + +<chapter id="credits"> +<title>Credits and License</title> + +<para> +&k4wins; +</para> +<para> +Program copyright 1995-2002 &Martin.Heni; &Martin.Heni.mail; +</para> +<para> +Documentation copyright 2002 &Martin.Heni; &Martin.Heni.mail; +</para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +&underFDL; +&underGPL; + +</chapter> + +<appendix id="installation"> +<title>Installation</title> + +<sect1 id="getting-kwin4"> +<title>How to obtain &k4wins;</title> + +&install.intro.documentation; + +</sect1> + +<sect1 id="compilation"> +<title>Compilation and Installation</title> + +&install.compile.documentation; + +</sect1> +</appendix> + + +&documentation.index; +</book> +<!-- +Local Variables: +mode: sgml +sgml-minimize-attributes:nil +sgml-general-insert-case:lower +sgml-always-quote-attributes:t +sgml-indent-step:0 +sgml-indent-data:t +End: +--> + diff --git a/doc/lskat/Makefile.am b/doc/lskat/Makefile.am new file mode 100644 index 00000000..368fc0da --- /dev/null +++ b/doc/lskat/Makefile.am @@ -0,0 +1,4 @@ + +KDE_DOCS = AUTO +KDE_LANG = en + diff --git a/doc/lskat/index.docbook b/doc/lskat/index.docbook new file mode 100644 index 00000000..198d3ff6 --- /dev/null +++ b/doc/lskat/index.docbook @@ -0,0 +1,467 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY kappname "&lskat;"> + <!ENTITY package "kdegames"> + <!ENTITY % English "INCLUDE" > <!-- change language only here --> + <!ENTITY % addindex "IGNORE"> +]> + +<book lang="&language;"> +<bookinfo> +<title>Lieutnant Skat</title> +<authorgroup> +<author> +<firstname>Martin</firstname> +<surname>Heni</surname> +<affiliation> +<address><email>martin@heni-online.de</email></address> +</affiliation> +</author> +<othercredit role="reviewer"> +<firstname>Mike</firstname><surname>McBride</surname> +<contrib>Reviewer</contrib> +<affiliation> +<address><email>mpmcbride7@yahoo.com</email></address></affiliation> +</othercredit> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> + +</authorgroup> + +<date>2003-09-16</date> +<releaseinfo>0.09.01</releaseinfo> + +<abstract> +<para>This documentation describes &lskat; version 0.9.1</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>kdegames</keyword> +<keyword>game</keyword> +<keyword>playing cards</keyword> +<keyword>skat</keyword> +<keyword>lieutenant</keyword> +<keyword>lskat</keyword> +</keywordset> +</bookinfo> + +<chapter id="overview"> +<title>Overview</title> + +<para> +Lieutenant skat (from German <foreignphrase +lang="de">Offiziersskat</foreignphrase>) is a card game for two +players. It is roughly played according to the rules of +<firstterm>Skat</firstterm> but with only two players and simplified +rules. +</para> + +<para> +Every player has a set of cards in front of him/her, half of them +covered and half of them open. Both players try to win more than 60 of +the 120 possible points. After 16 moves all cards are played and the +game ends. +</para> + +</chapter> + +<chapter id="rules"> +<title>Rules</title> + +<para> +The game has a randomly chosen trump card. It is shown as a small suit +symbol in the upper right corner of the score field. All four Jacks are +also counted as trumps and do <emphasis>not</emphasis> belong to their +suits. So if <emphasis>heart</emphasis> is trump all seven hearts as +well as all four Jacks count as trumps, making 11 trumps. +</para> + +<note> +<para> +The Jack of clubs does not count as <emphasis>club</emphasis> but as +trump. +</para> +</note> + +<para> +A special trump is the <firstterm>Grand</firstterm>. In this game no +suit is trump and only the four Jacks count as trump. In the game this +is indicated by the symbol of the Jack's head. +</para> + +<para> +Every player owns 16 cards. 8 of them covered 8 of them open. The start +player can play any of his/her open cards. +</para> + +<para> +The second player has following choices: +</para> + +<orderedlist> +<listitem><para> +The second player has in his/her open cards the same suit. +He/she has to play one of this suit then. The player with +the higher card (see table below) wins both cards. +</para></listitem> +<listitem><para> +The second player does not have a card of the played suit. +He/she can now play any other card. If it is a trump the +second player will win both cards. Otherwise the +first player will win both cards. +</para></listitem> +</orderedlist> + +<para> +If there is still a covered card below a played card it will be uncovered +and is from now on an open card. +</para> + +<para> +The player who won the cards can make the next turn. +</para> + +<para> +The sequence of the cards (from the highest to the lowest - +holding for any <emphasis>trump</emphasis>):</para> +<simplelist type="inline"> +<member>Jack of clubs</member> +<member>Jack of spades</member> +<member>Jack of hearts</member> +<member>Jack of diamonds</member> +<member>Ace</member> +<member>Ten</member> +<member>King</member> +<member>Queen</member> +<member>Nine</member> +<member>Eight</member> +<member>Seven</member> +</simplelist> + +<para> +The player who wins both cards will add their value to his score. The +values of the cards are:</para> + +<informaltable> +<tgroup cols="2"> +<thead> +<row><entry> Card </entry><entry> Value </entry></row> +</thead> +<tbody> +<row><entry> Ace </entry><entry> 11 </entry></row> +<row><entry> Ten </entry><entry> 10 </entry></row> +<row><entry> King </entry><entry> 4 </entry></row> +<row><entry> Queen </entry><entry> 3 </entry></row> +<row><entry> Jack </entry><entry> 2 </entry></row> +<row><entry> Nine </entry><entry> 0 </entry></row> +<row><entry> Eight </entry><entry> 0 </entry></row> +<row><entry> Seven </entry><entry> 0 </entry></row> +</tbody> +</tgroup> +</informaltable> + +<sect1 id="scoring"> +<title>Scoring</title> + +<para> +The game is won if you have more than 60 points. With both players having +60 points the game ends in a draw. +</para> + +<informaltable> +<tgroup cols="2"> +<thead> +<row><entry>Points</entry><entry>Score</entry></row> +</thead> +<tbody> +<row><entry>60</entry><entry>1</entry></row> +<row><entry>61...90</entry><entry>2</entry></row> +<row><entry>91...119</entry><entry>3</entry></row> +<row><entry>120</entry><entry>4</entry></row> +</tbody> +</tgroup> +</informaltable> + +</sect1> +</chapter> + +<chapter id="remote-connections"> +<title>Remote connections</title> + +<para> +It is possible to play the game over a network connection with another +computer. To do so both players on both computers have to select one +color played by the local player and the other by the remote player. Who +chooses which side does not matter. It even does not matter if both +choose to play the same player as this will automatically be +interchanged by the game. +</para> + +<para> +One of the computers will act as game server. Only this one can start a +new network game. Also all its game data will be transfered to the +client computer. You can force your computer to be server if you do not +supply a hostname in the network dialog. This dialog pops up if you +start a new network game. As a client you enter the hostname of the +machine on which the server is running. The port does not usually need to be +changed, but you can enter any valid port number there. +</para> + +</chapter> + +<chapter id="menus"> +<title>Menus</title> + +<sect1 id="file-menu"> +<title><guimenu>Game</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo> +</shortcut> +<guimenu>Game</guimenu> +<guimenuitem>New</guimenuitem></menuchoice></term> +<listitem> +<para> +<action>Starts a new game.</action> In a network game this option is +only available for the network server. The network client will be +automatically started by the server. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Game</guimenu> +<guimenuitem>End Game</guimenuitem> +</menuchoice></term> +<listitem><para> +<action>Aborts a running game.</action> +</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Game</guimenu> +<guimenuitem>Clear Statistics</guimenuitem> +</menuchoice></term> +<listitem><para> +<action>Clears the all time game memory.</action> This statistic is +usually saved when the game ended and shows the amount of +played and won games per player. This is cleared with this menu +option. +</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>M</keycap></keycombo> +</shortcut> +<guimenu>Game</guimenu> +<guimenuitem>Send Message...</guimenuitem> +</menuchoice></term> +<listitem><para> +If connected to another game in a remote session this +option allows you to <action>send a message to the remote +player.</action> +</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><action> +Quits the program.</action> +</para></listitem> +</varlistentry> +</variablelist> + +</sect1> + +<sect1 id="settings-menu"> +<title><guimenu>Settings</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Statusbar</guimenuitem> +</menuchoice></term> +<listitem><para><action> +Shows or hides the statusbar. +</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guisubmenu>Starting Player</guisubmenu></menuchoice></term> +<listitem><para> +Selects whether player 1 (top) or player two (bottom) +begins the next game. +</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guisubmenu>Player 1 Played By</guisubmenu> +</menuchoice></term> +<listitem> +<para> +Chooses who should play for player 1 (top). It can be one of the +following: +</para> + +<itemizedlist><listitem> +<para> +A local player using the mouse as input device. For this option, choose +<guimenuitem>Player</guimenuitem>. +</para></listitem> + +<listitem><para> +An artificual computer player. For this option, choose +<guimenuitem>Computer</guimenuitem>. +</para></listitem> + +<listitem><para> +A remote player, who is connected to this computer through a network. +For this option choose <guimenuitem>Remote</guimenuitem>. +</para></listitem> +</itemizedlist> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenu>Settings</guimenu><guisubmenu>Player 2 Played By</guisubmenu></menuchoice></term> +<listitem><para> +Same as the <guimenuitem>Player 1 Played By</guimenuitem> option, only this refers to Player 2. +</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guisubmenu>Level</guisubmenu> +</menuchoice></term> +<listitem><para> +<action>Selects the level of the computer player.</action> +</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Select Card Deck</guimenuitem></menuchoice></term> +<listitem><para> +<action> +Choose the face and back of the carddeck used for playing.</action> You +can select these in a preview dialog showing all carddecks installed for +&kde;. +</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Change Names...</guimenuitem> +</menuchoice></term> +<listitem><para> +<action>Change the names of the players.</action> +</para></listitem> +</varlistentry> + + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Shortcuts...</guimenuitem> +</menuchoice></term> +<listitem><para> +<action>Open a dialog which lets you redefine all the keyboard shortcuts.</action> +</para></listitem> +</varlistentry> + +</variablelist> +</sect1> + +<sect1 id="help"> +<title>The <guimenuitem>Help</guimenuitem> Menu</title> + + +&help.menu.documentation; + +</sect1> + +</chapter> + +<chapter id="credits"> +<title>Credits and License</title> + +<para> +&lskat; +</para> +<para> +Program copyright 2000,2001 Martin Heni <email>martin@heni-online.de</email> +</para> +<para> +Documentation copyright 2000,2001 Martin Heni <email>martin@heni-online.de</email> +</para> +<para> +Documentation converted to &kde; 2.0 by Mike McBride +<email>mpmcbride7@yahoo.com</email> +</para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +&underFDL; +&underGPL; + +</chapter> + + +<appendix id="installation"> +<title>Installation</title> + +&install.intro.documentation; + + +<sect1 id="Compilation"> +<title>Compilation and Installation</title> + +&install.compile.documentation; + +</sect1> +</appendix> + +&documentation.index; +</book> +<!-- +Local Variables: +mode: sgml +sgml-minimize-attributes:nil +sgml-general-insert-case:lower +sgml-omittag:t +sgml-shorttag:t +sgml-namecase-general:t +sgml-always-quote-attributes:t +sgml-indent-step:0 +sgml-indent-data:nil +sgml-parent-document:nil +sgml-exposed-tags:nil +sgml-local-catalogs:nil +sgml-local-ecat-files:nil +End: +--> + + + |
