summaryrefslogtreecommitdiffstats
path: root/doc/kbattleship/index.docbook
blob: bf4b9ad78a3121067c24c5a4b6a94d90df7182fb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
<?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 "tdegames">
  <!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 &tde;.</para>
</abstract>

<keywordset>
<keyword>KDE</keyword>
<keyword>tdegames</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 &amp; 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>