<?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>

<author>
<firstname>Anton</firstname>
<surname>Brondz</surname>
<affiliation>
<address><email>dinolinux@gmail.com</email></address>
</affiliation>
</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>2007-11-14</date>
<releaseinfo>2.0</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>
<note><title>Gametype:</title><para>Strategy, Board</para></note><!-- Game genre. use as many as necessary.Available game types are: Arcade, Board, Card, Dice, Toys, Logic, Strategy.-->
<note><title>Number of possible players:</title><para>Two</para></note><!--Number of possible players. It can be: One, Two,..., Multiplayer-->
<para>
&kbattleship; is a Battle Ship game for &kde;. Ships are placed on a board which represents the sea. Players try to hit each others
ships in turns without knowing where they are placed. The first player to destroy all ships wins the game.
</para>
</chapter>

<chapter id="howtoplay">
<title>How to Play</title>
<note><title>Objective:</title><para>Sink all of the opponent’s ships before the opponent sink all the ships of your own.</para></note><!--Describe the objective of the game.-->
<para>
If you want to play &kbattleship;, you will need two players, either play
against the computer or in a network against another player. To play against your computer, first select the difficulty level on the right of the status bar, and then select <guibutton>Single player</guibutton> on the welcome screen, or directly on the <menuchoice><guimenu>Game</guimenu></menuchoice> menu.</para>

<para>
To start a network game, one player has to host the game by selecting <guilabel>Host network game</guilabel> on the welcome screen, or choosing <menuchoice><guimenu>Game</guimenu>
<guimenuitem>Host Game...</guimenuitem></menuchoice>.
A dialog box opens which asks for a <guilabel>Nickname:</guilabel> and <guilabel>Port:</guilabel>. Normally,
&kbattleship; will suggest your full 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 port 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 <guilabel>Connect to network game</guilabel>, or click <menuchoice><guimenu>Game</guimenu>
<guimenuitem>Connect to Game...</guimenuitem></menuchoice>. Again, a <guilabel>Nickname:</guilabel> is
suggested, but you can choose any name you like. In the field <guilabel>Hostname:</guilabel> you
have to enter the host name of the server (the machine of the player that initiated the game).
</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 ships. You have four ships to place: the first one will have a length of one square, the next
will be two squares long &etc;. Click on the field where you want to start
the placement. By default, ships will be placed horizontally;
to rotate them 90 degrees, click the &RMB; before the placement.
<!-- &Shift; itself will flip the ship placement preview. -->
</para>

<para>
When a ship is hit, fire will break out on it. To sink it, hit all the squares it
occupies. A sunk ship will appear faded.
</para>

<para>
Now you can use the &LMB; to fire on the battle area of your enemy. The status bar indicates
who is about to shoot. 
</para>

<para>
You can restart the game by choosing <menuchoice><guimenu>Game</guimenu>
<guimenuitem>Restart Game</guimenuitem></menuchoice>, or by pressing
<keycap>F5</keycap>.
</para>

<para>
The first player to destroy all their opponents ships wins the game.
</para>

</chapter>

<chapter id="rulestips">
<title>Game Rules, Strategies and Tips</title>
<sect1 id="rules">
<title>Rules</title>
<itemizedlist>
<listitem><para>A player can only fire one shot per turn.</para></listitem>
<listitem><para>Players must place all their ships.</para></listitem>
<listitem><para>Ships cannot be moved once placed.</para></listitem>
<listitem><para>A ship is sunk when all the squares it occupies are hit.</para></listitem>
</itemizedlist>
</sect1>

<sect1 id="strattips">
<title>Strategies and Tips</title>
<itemizedlist>
<listitem><para>Never place ships next to one another.</para></listitem>
<listitem><para>Once you hit a ship, try shooting around the place you hit.</para></listitem>
<listitem><para>Try to place ships away from the edges of the board.</para></listitem>
<listitem><para>Small ships are harder to hit, make sure you place them where they are hard to find.</para></listitem>
<listitem><para>Think before you shoot. Hits on water gives less points.</para></listitem>
</itemizedlist>
</sect1>


<sect1 id="multiplayer">
<title>Multiplayer support</title>

<para>
&kbattleship; can be played online on any GGZ Gaming Zone site. You can
find other players there, and compete against them. Just enter one
of the available Battleship rooms with any GGZ core client, such as
kggz, and &kbattleship; will be offered to you as your favourite
game client. If a GGZ core client is installed, you can try
out GGZ by visiting the <ulink url="ggz://live.ggzgamingzone.org/#Battleship">community site</ulink>.
</para>

<para>
Remember that when playing online, the opponent might be either a
human player or a computer player. The latter one might behave
differently from the computer player included in &kbattleship;.
</para>

</sect1>
</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>
<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>
</shortcut>
<guimenu>Game</guimenu>
<guimenuitem>New</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Exit the current game and reload the welcome screen.</action>
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<shortcut><keycap>F5</keycap></shortcut>
<guimenu>Game</guimenu>
<guimenuitem>Restart Game</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Restart the game.</action>
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<shortcut action="simul">&Ctrl;<keycap>H</keycap></shortcut>
<guimenu>Game</guimenu>
<guimenuitem>Show High Scores...</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Show the highest scores so far.</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><keycap>F3</keycap></shortcut> -->
<guimenu>Game</guimenu>
<guimenuitem>Host Game...</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>F3</keycap></shortcut> -->
<guimenu>Game</guimenu>
<guimenuitem>Connect to Game...</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Connect to a server to start a game.</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> &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>Change Nickname...</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Change the default nickname.</action>
</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>Show Toolbar</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Toggle on or off the display of the toolbar.</action> The
default is on.
</para>
</listitem>
</varlistentry>

<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>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 Toolbars...</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Configure</action> the toolbars provided 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="faq">
<title>Frequently Asked Questions</title>

<qandaset>

<qandaentry>
<question>
<para>
How do I start a new game?
</para>
</question>
<answer>
<para>
Press the <guibutton>New</guibutton> button, select <guimenuitem>New</guimenuitem> from the <guimenu>Game</guimenu> menu or press 
<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>
</para>
</answer>
</qandaentry>

<qandaentry>
<question>
<para>
I'm not sure where to shoot, can I get a hint?
</para>
</question>
<answer>
<para>
No, there is no hint system in &kbattleship;.
</para>
</answer>
</qandaentry>

<qandaentry>
<question>
<para>
How can I rotate a ship?
</para>
</question>
<answer>
<para>
Move the ship where you want to place it, then press &RMB;
</para>
</answer>
</qandaentry>

<qandaentry>
<question>
<para>
Can I change how the game looks?
</para>
</question>
<answer>
<para>
No, the theme is not changeable.
</para>
</answer>
</qandaentry>

</qandaset>
</chapter>

<chapter id="credits">
<title>Credits and Licenses</title>

<para>&kbattleship; Copyright 2000-2007</para>

<itemizedlist>
<title>Authors</title>
<listitem>
<para>
Paolo Capriotti <email>p.capriotti@gmail.com</email>
</para>
</listitem>
<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>
Johann Ollivier Lapeyre <email>johann.ollivierlapeyre@gmail.com</email>
</para>
</listitem>
<listitem>
<para>
Eugene Trounev <email>irs_me@hotmail.com</email>
</para>
</listitem>
<listitem>
<para>
Robert Wadley <email>rob@robntina.fastmail.us</email>
</para>
</listitem>
<listitem>
<para>
Riccardo Iaconelli <email>ruphy@fsfe.org</email>
</para>
</listitem>
<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>

<para>Documentation updated for &kde; 4 by
<personname><firstname>Elisa</firstname><surname>Tonello</surname></personname>
<email>elisa.tonello@gmail.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:
-->
