index.docbook 14.5 KB
Newer Older
Éric Bischoff's avatar
Éric Bischoff committed
1
<?xml version="1.0" ?>
Laurent Montel's avatar
Laurent Montel committed
2
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
Eugene Trounev's avatar
Eugene Trounev committed
3
4
  <!ENTITY % English "INCLUDE" > <!-- change language only here -->
  <!ENTITY % addindex "IGNORE"> <!-- do not change this! -->
5
]>
Eugene Trounev's avatar
Eugene Trounev committed
6
 
Luigi Toscano's avatar
Luigi Toscano committed
7
<book id="katomic" lang="&language;"> <!-- do not change this! -->
8
<bookinfo>
9
<title>The &katomic; Handbook</title> <!-- This is the title of the docbook. Leave as is unless change is necessary.-->
Yuri Chornoivan's avatar
Yuri Chornoivan committed
10
<!-- List of immediate authors begins here. -->
Eugene Trounev's avatar
Eugene Trounev committed
11
<!--INPORTANT! - All other contributors: [to be determined] -->
12
13
14
15
16
<authorgroup>
<author>
<firstname>Dirk</firstname>
<surname>Doerflinger</surname>
</author>
Eugene Trounev's avatar
Eugene Trounev committed
17
18
19
20
<author>
<firstname>Eugene</firstname><surname>Trounev</surname>
<affiliation><address><email>eugene.trounev@gmail.com</email></address></affiliation>
</author>
21
<othercredit role="reviewer">
22
23
<firstname>Mike</firstname><surname>McBride</surname>
<contrib>Reviewer</contrib>
24
<affiliation><address>&Mike.McBride.mail;</address></affiliation>
25
</othercredit>
Erik Kjær Pedersen's avatar
Erik Kjær Pedersen committed
26
<!-- TRANS:ROLES_OF_TRANSLATORS -->
27
</authorgroup>
28
<legalnotice>&FDLNotice;</legalnotice> 
29
30
<date>2016-05-09</date>
<releaseinfo>4.0 (Applications 16.04)</releaseinfo>
Eugene Trounev's avatar
Eugene Trounev committed
31
32
 
<!--Short description of this document. Do not change unless necessary!-->
33
<abstract>
34
	<para>This documentation describes the game of &katomic; version 4.0</para>
35
</abstract>
Eugene Trounev's avatar
Eugene Trounev committed
36
37
 
<!--List of relevan keywords-->
38
<keywordset>
Eugene Trounev's avatar
Eugene Trounev committed
39
40
41
42
	<keyword>KDE</keyword> <!-- do not change this! -->
	<keyword>kdegames</keyword> <!-- do not change this! -->
	<keyword>game</keyword> <!-- do not change this! -->
	<keyword>Katomic</keyword><!--Application name goes here-->
Frederik Schwarzer's avatar
Frederik Schwarzer committed
43
<!-- Game genre. Use as many as necessary. Available game types are: Arcade, Board, Card, Dice, Toys, Logic, Strategy.-->
Eugene Trounev's avatar
Eugene Trounev committed
44
45
46
47
48
49
50
51
52
	<keyword>arcade</keyword>
	<keyword>logic</keyword>
	<keyword>atoms</keyword>
	<keyword>socoban</keyword>
<!--Number of possible players. It can be: One, Two,..., Multiplayer-->
	<keyword>one player</keyword>
<!--All other relevant keywords-->
	<keyword>chemical elements</keyword>
	<keyword> reassemble the molecule</keyword>
53
54
</keywordset>
</bookinfo>
Eugene Trounev's avatar
Eugene Trounev committed
55
56
<!--Content begins here: -->
<chapter id="introduction"><title>Introduction</title> <!-- do not change this! -->
Frederik Schwarzer's avatar
Frederik Schwarzer committed
57
	<note><title>Gametype:</title><para>Logic, Arcade</para></note><!-- Game genre. Use as many as necessary. Available game types are: Arcade, Board, Card, Dice, Toys, Logic, Strategy.-->
Eugene Trounev's avatar
Eugene Trounev committed
58
59
60
61
	<note><title>Number of possible players:</title><para>One</para></note><!--Number of possible players. It can be: One, Two,..., Multiplayer-->
 
<!--Short game description starts here. 3-4 sentences (paragraphs)-->
	<para>
62
	&katomic; is a fun and educational game built around molecular geometry. It employs a simplistic two-dimensional look at the elements which comprise a molecule. A molecule is disassembled into its separate atoms and scattered around the playing field. The player must reassemble the molecule in order to complete the current level and move up to the next one.
Eugene Trounev's avatar
Eugene Trounev committed
63
	</para>
64
</chapter>
Eugene Trounev's avatar
Eugene Trounev committed
65
 
Eugene Trounev's avatar
Eugene Trounev committed
66
<chapter id="howto"><title>How to Play</title> <!-- do not change this! -->
67
68
69
70
71
72
73
74
75
76
<screenshot>
<mediaobject>
<imageobject>
<imagedata fileref="mainscreen.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>&katomic; main screen</phrase>
</textobject>
</mediaobject>
</screenshot>
Eugene Trounev's avatar
Eugene Trounev committed
77
78
79
80
<!--IMPORTANT: If the game has no defined objective, please remove the below line.-->
	<note><title>Objective:</title><para>Reassemble molecules from compound atoms by sliding them around.</para></note><!--Describe the objective of the game.-->
<!--How to play description. Don't be to specific on rules as they have a separate section in this document-->
	<para>
Eugene Trounev's avatar
Eugene Trounev committed
81
	&katomic; will load level one once you start the game and you can begin playing right away. To see how the molecule you are supposed to make looks like, take a look at the upper right corner. To play, click on an atom. You will see green arrows pointing in the directions where atom can move. To move the atom, click on the desired arrow. When an atom starts moving, it will not stop until it hits another atom or a wall, so make sure you think before you do your next move. You can assemble your molecule wherever you like on the game board, but some places are easier to access than others. When the molecule is assembled, you can move to the next level.
Eugene Trounev's avatar
Eugene Trounev committed
82
83
84
85
86
	</para>
</chapter>
 
<chapter id="rules_and_tips"><title>Game Rules, Strategies and Tips</title> <!-- do not change this! -->
	<!--This section has to do with game rules. Please give a detailed description of those using lists or paragraphs.-->
87
	<sect1 id="games_rules"><title>Game Rules</title>		
Eugene Trounev's avatar
Eugene Trounev committed
88
89
		<itemizedlist>
			<listitem><para>Game pieces can only move in one direction at a time.</para></listitem>
Luciano Montanaro's avatar
Typo    
Luciano Montanaro committed
90
			<listitem><para>Once an atom begins moving it will not stop until it meets either a wall or another piece.</para></listitem>
Eugene Trounev's avatar
Eugene Trounev committed
91
92
			<listitem><para>The only way to progress to the next game level is to complete a current one. Once a player completes a certain level the game automatically switches to the next one, thus 'uncovering it'.</para></listitem>
			<listitem><para>A player can only switch between the levels which have been uncovered.</para></listitem>
Eugene Trounev's avatar
Eugene Trounev committed
93
94
95
			<listitem><para>The game progress is automatically saved every time an adjacent level is reached, and will be reloaded the next time application is started.</para></listitem>
		</itemizedlist>
	</sect1>
96
	<sect1 id="tips"><title>Strategies and Tips</title>
Eugene Trounev's avatar
Eugene Trounev committed
97
98
99
100
		<itemizedlist>
			<listitem><para>Always review the complete molecule using the reference screen before making any moves.</para></listitem>
			<listitem><para>Next, study the play field and plan your moves. Remember, once a piece is moved it may not be possible to return it into the starting position.</para></listitem>
			<listitem><para>Think through your every move and try to visualize the trajectory piece will follow once a directional arrow is clicked.</para></listitem>
Eugene Trounev's avatar
Eugene Trounev committed
101
			<listitem><para>When using the keyboard to move pieces make sure that the desired piece is selected. If a wrong atom is marked as selected, use the &Tab; key to switch between the pieces until you reach a desired one.</para></listitem>
Eugene Trounev's avatar
Eugene Trounev committed
102
103
104
105
106
107
		</itemizedlist>
	</sect1>
</chapter> 
 
<chapter id="interface"><title>Interface Overview</title> <!-- do not change this! -->
<!-- This section has to do with menubar. Describe every single entry in order. Use <variablelist> and <varlistentry>. Split the chapter into sections using <sect1(2,3)> for better viewing.-->
108
109
<sect1 id="menu">
<title>Menu Items</title>
Eugene Trounev's avatar
Eugene Trounev committed
110

111
<variablelist>
Eugene Trounev's avatar
Eugene Trounev committed
112
113
114
115
116
117
<varlistentry>
<term><menuchoice>
<shortcut><keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo>
</shortcut>
<guimenu>Game</guimenu>
<guimenuitem>Load...</guimenuitem></menuchoice></term>
118
<listitem><para>Loads a previously saved game.</para></listitem>
Eugene Trounev's avatar
Eugene Trounev committed
119
120
</varlistentry>

121
<varlistentry>
Lauri Watts's avatar
Lauri Watts committed
122
123
124
125
<term>
<menuchoice>
<shortcut><keycap>F5</keycap></shortcut>
<guimenu>Game</guimenu>
126
127
128
129
<guimenuitem>Restart Game</guimenuitem></menuchoice></term>
<listitem><para>This will restart the current level.</para></listitem>
</varlistentry>

130
<varlistentry>
Lauri Watts's avatar
Lauri Watts committed
131
<term><menuchoice>
Eugene Trounev's avatar
Eugene Trounev committed
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
<shortcut><keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo>
</shortcut>
<guimenu>Game</guimenu>
<guimenuitem>Save</guimenuitem></menuchoice></term>
<listitem><para>Saves the current state of the game to the disk.</para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<shortcut><keycombo action="simul">&Ctrl;<keycap>P</keycap></keycombo>
</shortcut>
<guimenu>Game</guimenu>
<guimenuitem>Previous Level</guimenuitem></menuchoice></term>
<listitem><para>Change to the previous game level</para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<shortcut><keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>
</shortcut>
<guimenu>Game</guimenu>
<guimenuitem>Next Level</guimenuitem></menuchoice></term>
<listitem><para>Change to the next game level</para></listitem>
155
</varlistentry>
156

157
158
159
160
161
162
163
164
<varlistentry>
<term><menuchoice>
<guimenu>Game</guimenu>
<guimenuitem>Choose level set ...</guimenuitem></menuchoice></term>
<listitem><para>This will show all available level sets and allows you to 
download additional sets uploaded by other users from the internet.</para></listitem>
</varlistentry>

165
<varlistentry>
Lauri Watts's avatar
Lauri Watts committed
166
167
168
169
<term><menuchoice>
<shortcut><keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
</shortcut>
<guimenu>Game</guimenu>
170
<guimenuitem>Quit</guimenuitem></menuchoice></term>
Eugene Trounev's avatar
Eugene Trounev committed
171
<listitem><para>Selecting this item will end your current game, and exit
172
&katomic;.</para></listitem>
173
</varlistentry>
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

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

Eugene Trounev's avatar
Eugene Trounev committed
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
<varlistentry>
<term><menuchoice>
<guimenu>Move</guimenu>
<guimenuitem>Undo All</guimenuitem>
</menuchoice></term>
<listitem>
<para><action>Undo</action> all moves you made.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<guimenu>Move</guimenu>
<guimenuitem>Redo All</guimenuitem>
</menuchoice></term>
<listitem>
<para><action>Redo</action> all undone moves.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><menuchoice><guimenu>Settings</guimenu><guisubmenu>Animation Speed
</guisubmenu></menuchoice></term>
<listitem><para>Set the animation speed to <guimenuitem>Slow</guimenuitem>, <guimenuitem>Normal</guimenuitem> or 
<guimenuitem>Fast</guimenuitem>.</para></listitem>
</varlistentry>

231
</variablelist>
Eugene Trounev's avatar
Eugene Trounev committed
232

233
234
<para>
Additionally &katomic; has the common &kde; <guimenu>Settings</guimenu> and <guimenu>Help</guimenu>
235
236
menu items, for more information read the sections about the <ulink url="help:/fundamentals/menus.html#menus-settings"
>Settings Menu</ulink> and <ulink url="help:/fundamentals/menus.html#menus-help">Help Menu</ulink>
237
238
of the &kde; Fundamentals.
</para>
Eugene Trounev's avatar
Eugene Trounev committed
239

240
</sect1>
241

242
243
<sect1 id="keybindings">
<title id="keybindings-title">Default Keybindings</title>
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
<para>Default shortcuts are:</para>

<table>
<title>Shortcuts</title>
<tgroup cols="2">
<tbody>
<row>
<entry>Load</entry>
<entry><keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo></entry>
</row>
<row>
<entry>Restart Game</entry>
<entry>
<keycap>F5</keycap>
</entry>
</row>
<row>
<entry>Save</entry>
<entry><keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo></entry>
</row>
<row>
<entry>Previous Level</entry>
<entry><keycombo action="simul">&Ctrl;<keycap>P</keycap></keycombo></entry>
</row>
<row>
<entry>Next Level</entry>
<entry><keycombo action="simul">&Ctrl;<keycap>N</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>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>&Tab;</entry>
</row>
<row>
<entry>Previous Atom</entry>
<entry><keycombo action="simul">&Shift;&Tab;</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>
337
</sect1>
338

339
</chapter>
Eugene Trounev's avatar
Eugene Trounev committed
340
341
342
343
344
345
 
<chapter id="faq"><title>Frequently asked questions</title> <!-- do not change this! -->
<!--This chapter is for frequently asked questions. Please use <qandaset> <qandaentry> only!-->
<qandaset>
<!--Following is a standard list of FAQ questions.-->
<qandaentry>
Frederik Schwarzer's avatar
Frederik Schwarzer committed
346
 <question><para>How do I know what the molecule looks like?</para></question>
Eugene Trounev's avatar
Eugene Trounev committed
347
348
349
 <answer><para>You can view the molecule on the reference screen located in the top right corner of the game screen.</para></answer>
</qandaentry>
<qandaentry>
Eugene Trounev's avatar
Eugene Trounev committed
350
351
 <question><para>How do I move a game piece (atom)?</para></question>
 <answer><para>To move a game piece (atom) use your mouse cursor to click on it. At this time the available directional icon will become visible. Click on the corresponding directional icon to make a game piece move into the desired direction. Alternatively, you can use your keyboard to move the pieces. Use the &Tab; key to switch between the items, and the cursor keys to move them once selected.</para></answer>
Eugene Trounev's avatar
Eugene Trounev committed
352
353
</qandaentry>
<qandaentry>
Eugene Trounev's avatar
Eugene Trounev committed
354
355
 <question><para>Can I use the keyboard to control the pieces (atoms)?</para></question>
 <answer><para>Yes. Use &Tab; key to switch between the items, and he cursor keys to move them once selected.</para></answer>
Eugene Trounev's avatar
Eugene Trounev committed
356
357
</qandaentry>
<qandaentry>
Luciano Montanaro's avatar
Typo    
Luciano Montanaro committed
358
 <question><para>When I move a piece (atom) it goes right past the place where I want it. How do I make it stop there?</para></question>
Eugene Trounev's avatar
Eugene Trounev committed
359
 <answer><para>You don't. Once an atom begins moving, it will not stop until it meets either a wall or another piece.</para></answer>
Eugene Trounev's avatar
Eugene Trounev committed
360
361
</qandaentry>
<qandaentry>
Eugene Trounev's avatar
Eugene Trounev committed
362
363
 <question><para>I cannot beat the level. Is there a hint system, or a solver?</para></question>
  <answer><para>No. Unfortunately at this time &katomic; does not feature a hint system. So the only way to finish a level is to solve it on your own.</para></answer>
Eugene Trounev's avatar
Eugene Trounev committed
364
365
366
367
368
</qandaentry>
<!--Please add more Q&As if needed-->
</qandaset>
</chapter>
 
369
<chapter id="credits">
370
371
372
<title>Credits and License</title>

<para>
373
374
375
<application>Atomic Entertainment</application> Copyright 1999 &Stephan.Kulow;
&Stephan.Kulow.mail; and Cristian Tibirna
&Cristian.Tibirna.mail;.
376
377
378
379
380
</para>
<para>
Atomic Copyright Andreas Wuest <email>Andreas Wuest@gmx.de</email>.
</para>
<para>
381
Documentation Copyright 2000 &Dirk.Doerflinger;
382
383
384
385
<email>ddoerflinger@gmx.net</email>
</para>
<para>
Proofreading by Michael McBride
386
&Mike.McBride.mail;
387
</para>
Eugene Trounev's avatar
Eugene Trounev committed
388
<!-- TRANS:CREDIT_FOR_TRANSLATORS --> 
389
390
&underFDL;
&underGPL;
Eugene Trounev's avatar
Eugene Trounev committed
391
 
392
</chapter>
Eugene Trounev's avatar
Eugene Trounev committed
393
394
 
&documentation.index; 
395
396
397
398
</book>
<!--
Local Variables:
mode: sgml
Eugene Trounev's avatar
Eugene Trounev committed
399
400
401
402
403
404
405
406
407
408
409
410
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
411
End:
Luciano Montanaro's avatar
Typo    
Luciano Montanaro committed
412
-->