~neon/kdegames/trunk

« back to all changes in this revision

Viewing changes to konquest/doc/index.docbook

  • Committer: aacid
  • Date: 2012-08-18 14:19:55 UTC
  • Revision ID: svn-v4:283d02a7-25f6-0310-bc7c-ecb5cbfe19da:trunk/KDE/kdegames:1311445
move the doc folders inside of each of the apps, will ease git migration

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<?xml version="1.0" ?>
 
2
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
 
3
  <!ENTITY kappname "&konquest;">
 
4
  <!ENTITY package "kdegames">  
 
5
  <!ENTITY % addindex "IGNORE">
 
6
  <!ENTITY % English "INCLUDE" > <!-- change language only here -->
 
7
]>
 
8
 
 
9
<book lang="&language;">
 
10
 
 
11
<bookinfo>
 
12
<title>The &konquest; Handbook</title>
 
13
 
 
14
<authorgroup>
 
15
<author>
 
16
<firstname>Nicholas</firstname>
 
17
<surname>Robbins</surname>
 
18
<affiliation>
 
19
<address>&Nicholas.Robbins.mail;</address>
 
20
</affiliation>
 
21
</author>
 
22
<!-- TRANS:ROLES_OF_TRANSLATORS -->
 
23
</authorgroup>
 
24
 
 
25
<othercredit role="developer">
 
26
<firstname>Russ</firstname>
 
27
<surname>Steffen</surname>
 
28
<affiliation>
 
29
<address>&Russ.Steffen.mail;</address></affiliation>
 
30
<contrib>Developer</contrib>
 
31
</othercredit>
 
32
 
 
33
<othercredit role="reviewer">
 
34
<firstname>Lauri</firstname>
 
35
<surname>Watts</surname>
 
36
<affiliation>
 
37
<address>&Lauri.Watts.mail;</address>
 
38
</affiliation>
 
39
<contrib>Reviewer</contrib>
 
40
</othercredit>
 
41
 
 
42
<copyright>
 
43
<year>2000</year>
 
44
<holder>Nicholas Robbins</holder>
 
45
</copyright>
 
46
 
 
47
<copyright>
 
48
<year>2012</year>
 
49
<holder>Viktor Chynarov</holder>
 
50
</copyright>
 
51
 
 
52
<author>
 
53
<firstname>Anton</firstname>
 
54
<surname>Brondz</surname>
 
55
<affiliation>
 
56
<address><email>dinolinux@gmail.com</email></address>
 
57
</affiliation>
 
58
</author>
 
59
 
 
60
<author>
 
61
<firstname>Viktor</firstname>
 
62
<surname>Chynarov</surname>
 
63
</author>
 
64
 
 
65
<legalnotice>&FDLNotice;</legalnotice>
 
66
 
 
67
<date>2012-01-16</date>
 
68
<releaseinfo>2.1</releaseinfo>
 
69
 
 
70
<abstract>
 
71
<para>
 
72
&konquest; is a game of galactic conquest for &kde;
 
73
</para>
 
74
</abstract>
 
75
 
 
76
<keywordset>
 
77
<keyword>KDE</keyword>
 
78
<keyword>Konquest</keyword>
 
79
<keyword>kdegames</keyword>
 
80
</keywordset>
 
81
 
 
82
</bookinfo>
 
83
 
 
84
<chapter id="introduction">
 
85
<title>Introduction</title>
 
86
<note><title>Game type:</title><para>Strategy, Board</para></note>
 
87
<note><title>Number of players:</title><para>Multiplayer</para></note>
 
88
 
 
89
<screenshot>
 
90
<mediaobject>
 
91
        <imageobject><imagedata fileref="main_game_window.png" format="PNG"/></imageobject>
 
92
        <textobject><phrase>Main window of &konquest;</phrase></textobject>
 
93
        <caption><para>Main window of &konquest;.</para></caption>
 
94
</mediaobject>
 
95
</screenshot>
 
96
 
 
97
<para>
 
98
&konquest; is the &kde; version of Gnu-Lactic. Players conquer other planets by sending
 
99
ships to them. The goal is to build an interstellar empire and ultimately conqueror all 
 
100
other player's planets. &konquest; can be played against other people or a computer.
 
101
</para>
 
102
 
 
103
</chapter>
 
104
 
 
105
<chapter id="playing">
 
106
<title>How to Play</title>
 
107
 
 
108
<para>
 
109
When you start &konquest;, press <guibutton>New</guibutton> to start a new game.
 
110
You will see a dialog in which you need to enter various information to setup your game.
 
111
Listed below are the following parameters for the new game:
 
112
</para>
 
113
<itemizedlist>
 
114
 
 
115
<listitem><para>Players</para><itemizedlist>
 
116
  
 
117
  <listitem><para>Amount of players with <guibutton>Add</guibutton> or <guibutton>Remove</guibutton> players</para></listitem>
 
118
  <listitem><para>Names of players</para></listitem>
 
119
  <listitem><para>Type of players (Computer versus Human)</para></listitem>
 
120
  <listitem><para>Difficulty of computer players (Low/Normal/Hard)</para></listitem>
 
121
  </itemizedlist>
 
122
  <para>To change the name of the player, double-click in the <guilabel>Name</guilabel> 
 
123
  column and edit it. To change the type of the player, open the drop-down list by 
 
124
  double-clicking in the <guilabel>Type</guilabel> column.</para>
 
125
</listitem>  
 
126
 
 
127
<listitem><para>Map</para><itemizedlist>
 
128
  
 
129
  <listitem><para>Number of Neutral planets</para></listitem>
 
130
  <listitem><para>Width and height of the map in tile units</para></listitem>
 
131
  <listitem><para>Changing the Owner, Kill Percentage, and Production level of a particular planet</para></listitem>
 
132
  <listitem><para>Change the distribution of planets. Press <guibutton>Randomize</guibutton> to make it random.</para></listitem>
 
133
 
 
134
  </itemizedlist>
 
135
  <para>You can select the planet using the map thumbnail in the middle of <guilabel>Map</guilabel> pane. Just click on the planet with the &LMB;, then change the desired options.</para>
 
136
</listitem>
 
137
<listitem><para>Options</para><itemizedlist>
 
138
  
 
139
  <listitem><para>Whether or not you can see information about opponents' planets.</para></listitem>
 
140
  <listitem><para>Whether or not cumulative production is enabled or not.</para></listitem>
 
141
  <listitem><para>If production is enabled immediately after capture.</para></listitem>
 
142
  <listitem><para>Allowing amount of ships and other stats to be displayed for neutral planets</para></listitem>
 
143
  <listitem><para>Set the production level for neutral planets</para></listitem>
 
144
  </itemizedlist>
 
145
</listitem>
 
146
</itemizedlist>
 
147
<para>When you are done changing these settings (optional), click <guibutton>OK</guibutton> to start the game.
 
148
</para>
 
149
 
 
150
<screenshot>
 
151
<mediaobject>
 
152
        <imageobject><imagedata fileref="new_game_settings.png" format="PNG"/></imageobject>
 
153
        <textobject><phrase>New game dialog of &konquest;</phrase></textobject>
 
154
        <caption><para>New game dialog of &konquest;.</para></caption>
 
155
</mediaobject>
 
156
</screenshot>
 
157
 
 
158
<para>
 
159
Once the game starts, you will be presented with the game board. Blank squares
 
160
are empty space. At first, each player owns one planet. The planet's background
 
161
is the player color. If you move your mouse over a planet, you can see additional
 
162
  information. Without the <guilabel>Blind Map</guilabel> option enabled when selecting a game, you can see any information about all planet if you hover over it with mouse. If you had selected the <guilabel>Blind Map</guilabel> option when starting a new game, you will only see the planet's name on planets which have been conquered by opponents.The information can include:
 
163
</para>
 
164
 
 
165
<itemizedlist>
 
166
<listitem><para>Planet name</para></listitem>
 
167
<listitem><para>Owner</para></listitem>
 
168
<listitem><para>Ships</para></listitem>
 
169
<listitem><para>Ships Due</para></listitem>
 
170
<listitem><para>Production</para></listitem>
 
171
<listitem><para>Kill percent</para></listitem>
 
172
</itemizedlist>
 
173
 
 
174
<screenshot>
 
175
<mediaobject>
 
176
        <imageobject><imagedata fileref="ingame_window.png" format="PNG"/></imageobject>
 
177
        <textobject><phrase>Playing &konquest;</phrase></textobject>
 
178
        <caption><para>Playing &konquest;.</para></caption>
 
179
</mediaobject>
 
180
</screenshot>
 
181
 
 
182
<para>
 
183
The <guilabel>Planet name</guilabel> is how the planet is referred to in the game. Planets are named
 
184
alphabetically with uppercase letters. <guilabel>Owner</guilabel> is who owns the planet. If the planet
 
185
is conquered by another player, this will change. <guilabel>Ships</guilabel> is the current number of
 
186
ships on the planet. <guilabel>Ships due</guilabel> will only appear if you have selected a standing order for that planet,
 
187
otherwise it is not there. <guilabel>Production</guilabel> is the number of ships the planet will produce each turn.
 
188
The production varies from planet to planet, but always remains the same. <guilabel>Kill percent</guilabel>
 
189
is a measure of the effectiveness of the ships produced at that planet. Attack fleets take
 
190
the kill percentage of their planet of departure, and defense fleets use the kill
 
191
percentage of the planet they are defending.
 
192
You can get easily see the planet name, the owner and the current number of ships
 
193
on a planet in the square in which the planet lies. The owner is represented by the
 
194
background color of the planet, the name is in the upper left corner and the number of
 
195
ships is in the lower right corner.
 
196
</para>
 
197
 
 
198
<para>
 
199
To send ships from a planet to another, select the planet you want to send ships from, enter
 
200
the number of ships in the green box in the upper right corner and press &Enter;. Repeat
 
201
this procedure until you have sent out all the ships you want. If you wish to send a constant amount 
 
202
of ships from one planet to another every turn, enter that number and check the <guilabel>Standing Order</guilabel> box,
 
203
and press &Enter;. The ships due to the standing order will be sent at the end of the turn. When you are done, press <guibutton>End
 
204
Turn</guibutton>. When all players have played one turn, dialog boxes will appear and give you the latest news. The game will
 
205
proceed like this until one of the players owns the entire galaxy.
 
206
</para>
 
207
</chapter>
 
208
 
 
209
<chapter id="rulestips">
 
210
<title>Game Rules, Strategies and Tips</title>
 
211
<sect1 id="rules">
 
212
<title>Rules</title>
 
213
<itemizedlist>
 
214
<listitem><para>Ships cannot be stopped once they leave a planet.</para></listitem>
 
215
<listitem><para>Ships cannot attack other ships in midair.</para></listitem>
 
216
<listitem><para>Ships can be stored at planets for later use.</para></listitem>
 
217
<listitem><para>A planet cannot be given away.</para></listitem>
 
218
<listitem><para>A player can skip a turn by pressing <guibutton>End Turn</guibutton> without launching any
 
219
ships.</para></listitem>
 
220
</itemizedlist>
 
221
</sect1>
 
222
 
 
223
<sect1 id="strattips">
 
224
<title>Strategies and Tips</title>
 
225
<itemizedlist>
 
226
<listitem><para>Do not attack a planet with less than 10 ships.</para></listitem>
 
227
<listitem><para>Attack neutral planets before other players' planets.</para></listitem>
 
228
<listitem><para>Split your ship storages across several planets.</para></listitem>
 
229
<listitem><para>Plan your attacks in advance.</para></listitem>
 
230
<listitem><para>Use the ruler to find out the distance between planets.</para></listitem>
 
231
<listitem><para>Use the information window to get information on planets before an attack.</para></listitem>
 
232
<listitem><para>If this information is available to you, it is preferable to attack a planet with a low kill ratio from a planet with a high one.</para></listitem>
 
233
</itemizedlist>
 
234
</sect1>
 
235
</chapter>
 
236
 
 
237
<chapter id="menus">
 
238
<title>Menus</title>
 
239
 
 
240
<sect1 id="game-menu">
 
241
<title>The Game Menu</title>
 
242
 
 
243
<variablelist>
 
244
<varlistentry>
 
245
<term><menuchoice>
 
246
<shortcut>
 
247
<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>
 
248
</shortcut>
 
249
<guimenu>Game</guimenu>
 
250
<guimenuitem>New</guimenuitem>
 
251
</menuchoice></term>
 
252
<listitem><para><action>Starts a new game.</action></para></listitem>
 
253
</varlistentry>
 
254
 
 
255
<varlistentry>
 
256
<term><menuchoice>
 
257
<shortcut>
 
258
<keycombo action="simul">&Ctrl;<keycap>End</keycap></keycombo>
 
259
</shortcut>
 
260
<guimenu>Game</guimenu>
 
261
<guimenuitem>End Game</guimenuitem>
 
262
</menuchoice></term>
 
263
<listitem><para><action>End the current game, without closing</action> &konquest;</para></listitem>
 
264
</varlistentry>
 
265
 
 
266
<varlistentry>
 
267
<term><menuchoice>
 
268
<guimenu>Game</guimenu>
 
269
<guimenuitem>Measure Distance</guimenuitem>
 
270
</menuchoice></term>
 
271
<listitem><para>Click with the &LMB; on two planets to see their distance.</para></listitem>
 
272
</varlistentry>
 
273
 
 
274
<varlistentry>
 
275
<term><menuchoice>
 
276
<guimenu>Game</guimenu>
 
277
<guimenuitem>Show Standings</guimenuitem>
 
278
</menuchoice></term>
 
279
<listitem><para><action>Opens</action> a window to display the detailed current 
 
280
standings for all players</para></listitem>
 
281
</varlistentry>
 
282
 
 
283
<varlistentry>
 
284
<term><menuchoice>
 
285
<guimenu>Game</guimenu>
 
286
<guimenuitem>Fleet Overview</guimenuitem>
 
287
</menuchoice></term>
 
288
<listitem><para><action>Opens</action> a window to display detailed information 
 
289
for all fleets</para></listitem>
 
290
</varlistentry>
 
291
 
 
292
<varlistentry>
 
293
<term><menuchoice>
 
294
<shortcut>
 
295
<keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
 
296
</shortcut>
 
297
<guimenu>Game</guimenu>
 
298
<guimenuitem>Quit</guimenuitem>
 
299
</menuchoice></term>
 
300
<listitem><para><action>Quits the game.</action></para></listitem>
 
301
</varlistentry>
 
302
</variablelist>
 
303
</sect1>
 
304
 
 
305
<sect1 id="settings-menu">
 
306
<title>The Settings Menu</title>
 
307
 
 
308
<variablelist>
 
309
<varlistentry>
 
310
<term><menuchoice>
 
311
<guimenu>Settings</guimenu>
 
312
<guimenuitem>Show Toolbar</guimenuitem>
 
313
</menuchoice></term>
 
314
<listitem>
 
315
<para><action>Toggle</action> the toolbar display on and off.</para>
 
316
</listitem>
 
317
</varlistentry>
 
318
 
 
319
<varlistentry>
 
320
<term><menuchoice>
 
321
<guimenu>Settings</guimenu>
 
322
<guimenuitem>Show Statusbar</guimenuitem>
 
323
</menuchoice></term>
 
324
<listitem>
 
325
<para>
 
326
Toggles on and off the display of the statusbar.
 
327
</para>
 
328
</listitem>
 
329
</varlistentry>
 
330
 
 
331
<varlistentry>
 
332
<term><menuchoice>
 
333
<guimenu>Settings</guimenu>
 
334
<guimenuitem>Configure Shortcuts...</guimenuitem>
 
335
</menuchoice></term>
 
336
<listitem>
 
337
<para><action>Opens</action> a standard &kde; shortcut configuration dialog to
 
338
change the keyboard shortcuts used by &konquest;.</para>
 
339
</listitem>
 
340
</varlistentry>
 
341
 
 
342
<varlistentry>
 
343
<term><menuchoice>
 
344
<guimenu>Settings</guimenu>
 
345
<guimenuitem>Configure Toolbars...</guimenuitem>
 
346
</menuchoice></term>
 
347
<listitem>
 
348
<para>Brings up the standard &kde; toolbar configuration dialog to customize the &konquest; toolbar icons.</para>
 
349
</listitem>
 
350
</varlistentry>
 
351
 
 
352
</variablelist>
 
353
</sect1>
 
354
 
 
355
<sect1 id="help-menu">
 
356
<title>The Help Menu</title>
 
357
 
 
358
&help.menu.documentation;
 
359
 
 
360
 
 
361
</sect1>
 
362
</chapter>
 
363
 
 
364
<chapter id="faq">
 
365
<title>Frequently Asked Questions</title>
 
366
<qandaset>
 
367
 
 
368
<qandaentry>
 
369
<question>
 
370
<para>
 
371
Can I redirect ships once they have left a planet?
 
372
</para>
 
373
</question>
 
374
<answer>
 
375
<para>
 
376
No, once ships leave a planet, they cannot be stopped or redirected.
 
377
</para>
 
378
</answer>
 
379
</qandaentry>
 
380
 
 
381
<qandaentry>
 
382
<question>
 
383
<para>
 
384
Do the different colors and shapes of planets mean anything?
 
385
</para>
 
386
</question>
 
387
<answer>
 
388
<para>
 
389
No, they are random.
 
390
</para>
 
391
</answer>
 
392
</qandaentry>
 
393
 
 
394
<qandaentry>
 
395
<question>
 
396
<para>
 
397
How can I know where my ships are?
 
398
</para>
 
399
</question>
 
400
<answer>
 
401
<para>
 
402
Click <guibutton>Show Standings</guibutton>. It will give you information about fleets currently in flight.
 
403
</para>
 
404
</answer>
 
405
</qandaentry>
 
406
 
 
407
<qandaentry>
 
408
<question>
 
409
<para>
 
410
I have lost all my planets, but I am still in the game, why?
 
411
</para>
 
412
</question>
 
413
<answer>
 
414
<para>
 
415
You have not lost the game until you have lost all your ships.
 
416
</para>
 
417
</answer>
 
418
</qandaentry>
 
419
 
 
420
<qandaentry>
 
421
<question>
 
422
<para>
 
423
I am running out of turns, what can I do?
 
424
</para>
 
425
</question>
 
426
<answer>
 
427
<para>
 
428
You can continue playing. When you are at the last turn, you will be prompted to add more.
 
429
</para>
 
430
</answer>
 
431
</qandaentry>
 
432
 
 
433
<qandaentry>
 
434
<question>
 
435
<para>
 
436
Can I store ships on a planet for later use?
 
437
</para>
 
438
</question>
 
439
<answer>
 
440
<para>
 
441
Yes, you should however store them on multiple planets to be able to send them to nearby planets.
 
442
</para>
 
443
</answer>
 
444
</qandaentry>
 
445
 
 
446
<qandaentry>
 
447
<question>
 
448
<para>
 
449
I have sent out all the ships on a planet, but when I move my mouse over the planet, it shows the ships still in place, why?
 
450
</para>
 
451
</question>
 
452
<answer>
 
453
<para>
 
454
The number of ships on a planet is updated when a turn is ended.
 
455
</para>
 
456
</answer>
 
457
</qandaentry>
 
458
 
 
459
<qandaentry>
 
460
<question>
 
461
<para>
 
462
Is it possible to change the theme?
 
463
</para>
 
464
</question>
 
465
<answer>
 
466
<para>
 
467
No, that is not possible at the moment.
 
468
</para>
 
469
</answer>
 
470
</qandaentry>
 
471
 
 
472
</qandaset>
 
473
</chapter>
 
474
 
 
475
 
 
476
<chapter id="credits">
 
477
 
 
478
 
 
479
<title>Credits and License</title>
 
480
 
 
481
<para>&konquest;</para>
 
482
 
 
483
<para>&GNU;-Lactic Conquest Project, &kde; version by &Russ.Steffen;,
 
484
&Russ.Steffen.mail;.</para>
 
485
 
 
486
<para>Copyright &copy; 1998 by the &GNU;-Lactic Conquest Project </para>
 
487
 
 
488
<para>Documentation copyright 2000 Nicholas Robbins
 
489
&Nicholas.Robbins.mail;</para>
 
490
 
 
491
<para>Documentation copyright 2012 Viktor Chynarov</para>
 
492
 
 
493
<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
 
494
 
 
495
&underFDL;               <!-- FDL: do not remove -->
 
496
 
 
497
&underGPL;               <!-- GPL License -->
 
498
 
 
499
</chapter>
 
500
 
 
501
<appendix id="installation">
 
502
<title>Installation</title>
 
503
 
 
504
<sect1 id="getting-konquest">
 
505
<title>How to obtain &konquest;</title>
 
506
 
 
507
&install.intro.documentation;
 
508
 
 
509
</sect1>
 
510
 
 
511
<sect1 id="compilation">
 
512
<title>Compilation and Installation</title>
 
513
 
 
514
&install.compile.documentation;
 
515
 
 
516
</sect1>
 
517
 
 
518
</appendix>
 
519
 
 
520
&documentation.index;
 
521
 
 
522
</book>
 
523
 
 
524
<!--
 
525
Local Variables:
 
526
mode: sgml
 
527
sgml-omittag: nil
 
528
sgml-shorttag: t
 
529
End:
 
530
-->