~ubuntu-branches/ubuntu/trusty/enigma/trusty-proposed

« back to all changes in this revision

Viewing changes to doc/manual/enigma.texi

  • Committer: Package Import Robot
  • Author(s): Erich Schubert
  • Date: 2013-04-06 14:54:02 UTC
  • mfrom: (1.1.10)
  • Revision ID: package-import@ubuntu.com-20130406145402-jgjrtk7hac8gtvza
Tags: 1.20-dfsg.1-1
* New upstream release (Closes: #704595)
  (Repacked: dropped zipios++ source and main menu music)
* Update watch file, sf.net again.
* Fix documentation links (Closes: #653508)
* Conflict with enigma-level-previews to encourage deinstallation
  (Pregenerated level previews were only used with version 1.01)
* Use dh7 for building instead of CDBS
* Update to policy 3.9.4.0 (no changes)
* Register documentation with doc-base

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
\input texinfo                              @c -*- texinfo -*-
2
2
@afourpaper
3
3
 
4
 
@set VERSION 1.01
 
4
@set VERSION 1.20
5
5
 
6
6
@copying
7
 
Copyright @copyright{} 2003, 2004, 2005, 2006, 2007 Daniel Heck and other contributors
 
7
Copyright @copyright{} 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 Daniel Heck and other contributors
8
8
 
9
9
Copying and distribution of this file, with or without modification,
10
10
are permitted in any medium without royalty provided the copyright
19
19
@center @titlefont{Enigma Manual}
20
20
@center for version @value{VERSION}
21
21
@sp 2
22
 
@center Copyright @copyright{} 2003, 2004, 2005, 2006, 2007 Daniel Heck (@email{dheck@@gmx.de})
 
22
@c @center Copyright @copyright{} 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 Daniel Heck (@email{dheck@@gmx.de})
23
23
@page
24
24
@vskip 0pt plus 1filll
25
25
@insertcopying
34
34
This manual describes how to install and play Enigma, and corresponds
35
35
to Enigma version @value{VERSION}.
36
36
 
37
 
Copyright @copyright{} 2003, 2004, 2005, 2006, 2007 Daniel Heck and other contributors
 
37
Copyright @copyright{} 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 Daniel Heck (@email{dheck@@gmx.de}) and other contributors
38
38
 
39
39
Copying and distribution of this file, with or without modification,
40
40
are permitted in any medium without royalty provided the copyright
90
90
from countless other popular games, and added its own unique twists
91
91
to each of them.
92
92
@c Did you ever play Sokoban?
93
 
@c with chess horses to be pushed? 
 
93
@c with chess horses to be pushed?
94
94
@c Experience your d@'ej@`a-vu's for some games in single
95
95
@c levels -- for others, like Sokoban, in complete levelpacks of many levels.
96
96
 
97
 
Enigma is available for Windows, Mac OS X, and most flavors of Linux and other 
 
97
Enigma is available for Windows, Mac OS X, and most flavors of Linux and other
98
98
modern Unices. It has been translated into many languages. Even this manual is
99
99
available in several languages.
100
100
 
106
106
 
107
107
Enigma is free software, i.e., we encourage you to copy it and give
108
108
it to your friends (@pxref{Distributing Enigma}), or to send them a link
109
 
to our download page.  Enigma is developed by a small group 
 
109
to our download page.  Enigma is developed by a small group
110
110
of volunteers, all of us working in our free time.  If you like the
111
111
game, please send us an email.  It's probably the only reward
112
112
we will ever get in return for the countless hours we have put
227
227
with the leftmost icon button in the bottom row.
228
228
 
229
229
@itemize @bullet
230
 
@item 
 
230
@item
231
231
A steady black marble icon stands for ``strictly next''. You will get the next level
232
232
in the level pack, regardless of whether you already solved that level
233
233
or not.
234
234
 
235
235
@item
236
 
The icon that displays medals that are ready for awarding stands for the next 
 
236
The icon that displays medals that are ready for awarding stands for the next
237
237
unsolved mode. In this mode, the @key{>>|} buttons moves to the next
238
238
unsolved level.
239
239
 
241
241
The speeding black marble icon stands for the par mode. Par is the professional
242
242
average rating for a level.  This represents a score that a skilled player should
243
243
be able to reach. Levels where your score is equal to or lower than this
244
 
par value will be marked with the speeding marble icon. 
 
244
par value will be marked with the speeding marble icon.
245
245
In this mode the
246
246
@key{>>|}  button moves to the next level with a score below par.
247
247
 
249
249
Finally, a world class icon is provided for the world record hunt mode. If your score
250
250
is the best score ever recorded, you will be honored with the world record icon.
251
251
If you select this mode, you will play the level repeatedly until you
252
 
reach the world record. 
 
252
reach the world record.
253
253
 
254
254
@c Of course, a world record is a rare event. Still, you may
255
255
@c use this mode just for training purposes and to lower your score a little bit.
256
256
@end itemize
257
257
 
258
258
A small red triangle with an exclamation mark in the upper left corner may
259
 
label the level. This sign should inform you that the level was updated 
260
 
since you last solved it.  You will probably see this only when you update 
 
259
label the level. This sign should inform you that the level was updated
 
260
since you last solved it.  You will probably see this only when you update
261
261
Enigma to a newer version.
262
262
 
263
263
You can navigate the level menu with the following keys:
270
270
Display help
271
271
 
272
272
@item @key{F5}
273
 
Move to next level, identical to the @key{>>|} button 
 
273
Move to next level, identical to the @key{>>|} button
274
274
 
275
275
@item Arrows
276
276
Change selected level
290
290
@subsection The Level Pack Menu
291
291
 
292
292
Enigma comes with many levels.  Many, many levels, in fact.  To keep
293
 
things orderly, we have organized them into ``level packs''.  And 
294
 
because every release of Enigma added more levels, we even 
 
293
things orderly, we have organized them into ``level packs''.  And
 
294
because every release of Enigma added more levels, we even
295
295
had to organize the level packs themselves into ``groups''.  But
296
296
luckily, this is all a lot easier than it sounds.
297
297
 
298
298
To select the level pack, you have to enter the ``Level Pack'' menu,
299
299
which is accessible from the main menu or the level menu.
300
300
 
301
 
This menu shows the groups in the left column and the level packs of the 
 
301
This menu shows the groups in the left column and the level packs of the
302
302
selected group in the other columns to the right.  The official groups
303
303
that ship with Enigma are the following:
304
304
 
305
305
@itemize @bullet
306
 
@item @b{Enigma} - levels that are written just for Enigma 
 
306
@item @b{Enigma} - levels that are written just for Enigma
307
307
@item @b{D@'ej@`a-vu} - levels that you may have seen before
308
308
@item @b{Sokoban}
309
309
@item @b{Facets} - special sortings and views of the levels above
310
 
@item @b{User} - personal levels and level packs like History, automatically generated by the 
 
310
@item @b{User} - personal levels and level packs like History, automatically generated by the
311
311
system for the user.
312
312
@item @b{Development} - templates and unfinished levels from the Enigma Team
313
313
@item @b{All Packs}
314
314
@end itemize
315
315
 
316
 
A left click selects a group or a level pack. 
 
316
A left click selects a group or a level pack.
317
317
 
318
318
For descriptions of further features of level packs, see @ref{User
319
319
Level Packs}.
395
395
Besides all the other information that is described in detail in the Reference
396
396
Manual, you can enter a small annotation to a level and can rate the level.
397
397
 
398
 
Please note, the annotation text field may allow you to enter only ASCII 
 
398
Please note, the annotation text field may allow you to enter only ASCII
399
399
characters, depending on the system in which Enigma is running.
400
400
 
401
401
The rating is your personal impression of the level. @samp{-} stands for no
402
402
opinion. 0 - for very bad, 5 - for average, 10 - for best of the best. The ratings
403
403
will be sent back with your scores (@pxref{Registering Scores}).
404
404
 
405
 
Last but not least, you can use the Level Inspector to view screen shots that 
 
405
Last but not least, you can use the Level Inspector to view screen shots that
406
406
you made while playing a level (@pxref{Controls}).
407
407
 
408
408
@node Rules of the Game, Controls, Getting Started, The Game
409
409
@section Rules of the Game
410
410
 
411
411
@menu
412
 
* Normal landscapes::           
413
 
* Two-player landscapes::       
414
 
* Meditation landscapes::       
 
412
* Normal landscapes::
 
413
* Two-player landscapes::
 
414
* Meditation landscapes::
415
415
@end menu
416
416
 
417
417
 
529
529
Display help screen
530
530
 
531
531
@item @key{F3}
532
 
Kill the current marble 
 
532
Kill the current marble
533
533
 
534
534
@item @key{Shift-F3}
535
535
Restart the current level
570
570
levels of Enigma.
571
571
 
572
572
@menu
573
 
* Items::                       
574
 
* Stones::                      
 
573
* Items::
 
574
* Stones::
575
575
@end menu
576
576
 
577
577
@c @node Special Objects,,,
585
585
 
586
586
@menu
587
587
* Explosives::                  Dynamite and bombs
588
 
* Umbrellas::                   
 
588
* Umbrellas::
589
589
* Flags::                       Setting the respawn point
590
590
@end menu
591
591
 
609
609
 
610
610
@image{images/it-umbrella,,0.7cm}
611
611
 
612
 
Use umbrellas to make your marble invulnerable for a short time 
 
612
Use umbrellas to make your marble invulnerable for a short time
613
613
(ten seconds to be exact).  When you activate an umbrella, a white
614
614
halo will appear around your marble for as long as the protection lasts.
615
615
If the halo starts to blink, you have three seconds to move your marble
633
633
@c @subsection Elastic Band
634
634
 
635
635
@node Stones,  , Items, Some Game Objects
636
 
@section Stones  
 
636
@section Stones
637
637
 
638
638
@menu
639
 
* Lethal Stones::               
640
 
* Swap Stones::                 
641
 
* Mirrors::                     
642
 
* Oneway Stones::                
643
 
* Shogun Stones::               
644
 
* Bolder Stones::             
645
 
* Puzzle Stones::               
646
 
* Mail Stones::                 
 
639
* Lethal Stones::
 
640
* Swap Stones::
 
641
* Mirrors::
 
642
* Oneway Stones::
 
643
* Shogun Stones::
 
644
* Bolder Stones::
 
645
* Puzzle Stones::
 
646
* Mail Stones::
647
647
* Chess Stones::
648
648
@end menu
649
649
 
739
739
 
740
740
@image{images/st-bolder,,0.7cm}
741
741
 
742
 
Bolder stones move in the direction shown by the arrow on them 
743
 
until they bump into another stone.  Maybe they block your 
744
 
way, and you have to get rid of them someway. However, never, 
 
742
Bolder stones move in the direction shown by the arrow on them
 
743
until they bump into another stone.  Maybe they block your
 
744
way, and you have to get rid of them someway. However, never,
745
745
never stand in front of one, as it shatters your marble
746
746
instantly, when the bolder stone overruns it!
747
747
 
752
752
@node Puzzle Stones, Mail Stones, Bolder Stones, Stones
753
753
@subsection Puzzle Stones
754
754
 
755
 
Puzzle stones derive their name from the fact you can put individual 
 
755
@image{images/st-puzzles,,0.7cm}
 
756
 
 
757
Puzzle stones derive their name from the fact you can put individual
756
758
stones together like the pieces of a puzzle.  Puzzle stones have
757
759
sockets on some or all of their four sides, which can attach to sockets
758
760
on adjacent stones.  Once linked up, groups of puzzle stones move as a
759
761
unit.  You can use these blocks, for example, to build bridges across an
760
762
abyss or water.
761
763
 
762
 
When you hit them with a magic wand, puzzle stones behave differently.  
 
764
When you hit them with a magic wand, puzzle stones behave differently.
763
765
If the block of puzzle stones is fully connected (i.e., it has no open
764
766
sockets), the block immediately starts to explode, stone by stone.  If
765
767
the block is not fully connected, the stones in the row or column that
766
768
you hit shift by one place, either horizontally or vertically.
767
 
 
 
769
 
768
770
There's a rare variant of the common puzzle stone that behaves a
769
 
little differently.  Its main habitat are the levels of Oxyd 1, 
 
771
little differently.  Its main habitat are the levels of Oxyd 1,
770
772
and it's recognizable by the color of its pipes, which is orange
771
773
instead of the usual blue.  You cannot move these puzzle stones as a
772
774
unit. They behave like the blue puzzle stones do when you hit them
773
775
with a magic wand: The block explodes if it's fully connected, or
774
 
you shuffle the touched row or column of the block.  
 
776
you shuffle the touched row or column of the block.
775
777
 
776
778
@node Mail Stones, Chess Stones, Puzzle Stones, Stones
777
779
@subsection Mail Stones
833
835
@samp{User} group has three level packs that are initially empty:
834
836
@samp{Auto Folder}, @samp{History} and @samp{Search Result}.
835
837
 
836
 
You can search in the pool of levels by clicking on the @samp{Search} 
837
 
button in the level pack menu. Just move the mouse to the text field 
838
 
and enter the string to search. You may search within author, title 
839
 
and file name. The search is case insensitve. For example, 
 
838
You can search in the pool of levels by clicking on the @samp{Search}
 
839
button in the level pack menu. Just move the mouse to the text field
 
840
and enter the string to search. You may search within author, title
 
841
and file name. The search is case insensitve. For example,
840
842
you can search for the string ``jump''. Enigma provides the resulting levels
841
843
as a level pack called ``Search Results''.
842
844
 
857
859
 
858
860
If you are afraid of losing all your scores due to a hard drive
859
861
failure, or if you want to transfer your scores from one computer to
860
 
another, knowing how to back up Enigma's status information is helpful.  
 
862
another, knowing how to back up Enigma's status information is helpful.
861
863
To do that, first look up @samp{User Path} from Enigma's
862
864
@ref{Game options} menu.  You can simply back up that folder---the
863
865
important files are @samp{enigma.score} and @samp{state.xml}.
895
897
@node User Sound Sets, , Updating Enigma, Advanced Topics
896
898
@section User Sound Sets
897
899
 
898
 
A sound set is the sum of all sounds that appear in the game and the menus. 
 
900
A sound set is the sum of all sounds that appear in the game and the menus.
899
901
Enigma 1.01 and above allows you to switch between the default sound set and
900
902
sound sets you downloaded from the internet or created yourself.
901
903
 
902
904
To install a downloaded sound set, close Enigma and create a subdirectory named
903
 
@samp{soundsets} in your @samp{User Path}. Unpack the downloaded 
 
905
@samp{soundsets} in your @samp{User Path}. Unpack the downloaded
904
906
sound set if neccessary. Its files should all be inside one directory with the
905
907
name of the soundset, e.g. @samp{MyGreatSounds15}. Move this directory into the
906
908
@samp{soundsets} directory. Check that the @samp{soundset.lua} file is now
937
939
@section Walkthrough for Advanced Tutorial
938
940
 
939
941
The landscapes in the ``Tutorial'' level pack are supposed to be easy,
940
 
except for the last one, which is not @enddots{}  Jacob Scott 
 
942
except for the last one, which is not @enddots{}  Jacob Scott
941
943
contributed this section of the manual.
942
944
 
943
945
This walkthrough is for my level ``Advanced Tutorial'' in the
944
946
``Tutorial'' level pack (to change level packs, click on ``Level Pack''
945
 
at the bottom-left of the screen and select a level pack). You should 
 
947
at the bottom-left of the screen and select a level pack). You should
946
948
read all the documents in a room as soon as possible while you
947
949
are playing.
948
950
 
952
954
a row, they will both stay open.  Once you've matched up all pairs of
953
955
oxyd stones in a level, you have completed the level.
954
956
 
955
 
The ``Advanced Tutorial'' level contains about twenty rooms, 
956
 
organized into three separate areas.  In the first area, you will 
957
 
encounter some of the basic blocks and floor types you will see in 
958
 
other Enigma levels, and solve a couple of simple puzzles.  
959
 
The second area is more challenging and will introduce you 
 
957
The ``Advanced Tutorial'' level contains about twenty rooms,
 
958
organized into three separate areas.  In the first area, you will
 
959
encounter some of the basic blocks and floor types you will see in
 
960
other Enigma levels, and solve a couple of simple puzzles.
 
961
The second area is more challenging and will introduce you
960
962
to a useful technique in out-thinking an active enemy.  The
961
963
third and final area leads you to experiment with more advanced
962
 
interactions between Enigma objects.  In this particular level, you 
 
964
interactions between Enigma objects.  In this particular level, you
963
965
will find all of the oxyd stones in a single room at the end of area 3.
964
966
 
965
967
@subsection Area 1
1056
1058
return to the room where you initially started.  You will no longer be
1057
1059
able to see the rotor (it won't be in the room where you will be) but
1058
1060
if you look carefully, you will be able to see where it is.  The goal
1059
 
here is to get the rotor to go to a trigger and open a gate for you, 
 
1061
here is to get the rotor to go to a trigger and open a gate for you,
1060
1062
without exposing yourself to any danger.  Get the rotor to follow you from
1061
1063
the top-right to the top-left of this room.  It should be
1062
1064
pushed to the left by some slopes.  Bring the rotor down on the left
1131
1133
one @emph{above} the rightmost shogun dot.
1132
1134
 
1133
1135
@item I/31: Where Am I?
1134
 
Make use of the wooden stones if you have lost your way. 
 
1136
Make use of the wooden stones if you have lost your way.
1135
1137
 
1136
1138
@item I/32: The Grim Reaper
1137
1139
Ever thought of turning your mouse upside-down???
1149
1151
One of the blue dots behaves differently.  Make use of that fact!
1150
1152
 
1151
1153
@item I/80: Meditation
1152
 
Align the marbles horizontally. 
 
1154
Align the marbles horizontally.
1153
1155
 
1154
1156
@item II/15: Knock Knock!
1155
1157
Knock the walls.
1180
1182
Experiment!
1181
1183
 
1182
1184
@item II/69: Question of Speed
1183
 
Or rather: Question of Seed???  
 
1185
Or rather: Question of Seed???
1184
1186
 
1185
1187
@item II/77: Push Your Way
1186
 
Find the magic wand first! 
 
1188
Find the magic wand first!
1187
1189
 
1188
1190
@item II/97: Tool Time
1189
1191
Hide dangerous tools from children.
1201
1203
@item III/16: Control Panel
1202
1204
The message in the left room tells you how to arrange the blocks on the
1203
1205
first rows of triggers.  From there, use the color codes indicated in
1204
 
the left room. 
 
1206
the left room.
1205
1207
 
1206
1208
@item III/22: Portable Laser
1207
1209
Be grateful!
1239
1241
lower left all do the same.
1240
1242
 
1241
1243
@item IV/25: Light Switches
1242
 
Jam the lasers in case you're not fast enough. 
 
1244
Jam the lasers in case you're not fast enough.
1243
1245
 
1244
1246
@item IV/27: Robbery
1245
 
Enter the bank through cracks in the floor. 
 
1247
Enter the bank through cracks in the floor.
1246
1248
 
1247
1249
@item IV/34: Running Rings
1248
1250
Learn from ``Pharaoh's Tombs''.
1326
1328
@chapter Credits
1327
1329
 
1328
1330
@menu
1329
 
* Main developers::             
1330
 
* Special Thanks::              
1331
 
* Contributors::                
1332
 
* Utilized Software::           
 
1331
* Main developers::
 
1332
* Special Thanks::
 
1333
* Contributors::
 
1334
* Utilized Software::
1333
1335
@end menu
1334
1336
 
1335
1337
 
1398
1400
@item Erich Schubert
1399
1401
Debian/Ubuntu packages, level design
1400
1402
 
1401
 
@item Lukas Sch@"uller
1402
 
Level design
1403
 
 
1404
1403
@item Andrew ``Necros'' Sega
1405
1404
Menu music (@emph{Pentagonal Dreams})
1406
1405
 
1419
1418
 
1420
1419
@itemize @bullet
1421
1420
@item Roberto Bardin (Level design)
 
1421
@item Thomas Bernhardt (Level design)
 
1422
@item Helge Blohmer (Level design)
 
1423
@item Nathan Bronecke (Level design)
 
1424
@item Harry Bruder (LotM articles)
1422
1425
@item Alain Busser (Level design, French translation, manual)
1423
1426
@item Guy Busser (Level design)
1424
1427
@item Richi B@"utzer (Level design)
1425
1428
@item capkoh (Level design)
 
1429
@item Manfredi Carta (Level design)
1426
1430
@item Christoph & Anita (Level design)
 
1431
@item daydreamer (Level design)
1427
1432
@item Serge Dremuk (Russian translation)
1428
1433
@item Joseph Dunne (Level design)
1429
1434
@item Xerxes M. Dynatos (Level design)
1430
1435
@item Edward (Level design)
 
1436
@item Manuel Eisentraut (Level design)
1431
1437
@item Stephanie Fabian (Invaluable bug reports)
 
1438
@item Johann Freymuth (Level design)
1432
1439
@item Roberto Garc@'ia (Spanish translation)
1433
1440
@item Andy Geldmacher (Level design)
1434
1441
@item Edwin Groothuis (FreeBSD port)
 
1442
@item Daniel Hadas (Level design)
 
1443
@item Jonatan Hadas (Level design)
 
1444
@item Hairball (Level design)
1435
1445
@item Immanuel Herrmann (Level design)
 
1446
@item Brian Huffman (Level design)
 
1447
@item Johannes H@"using (Level design)
1436
1448
@item M@'at@'e Lehel Juh@'asz (Hungarian translation)
1437
1449
@item Samuele Kaplun (Italian translation)
 
1450
@item Manuel K@"onig (Level design, bug reports)
1438
1451
@item Jens-Christian Korth (Level design)
1439
 
@item Manuel K@"onig (Level design, bug reports)
1440
1452
@item Johannes Laire (Level design)
1441
1453
@item Joona Laire (Level design)
1442
1454
@item Markus Laire (Level design)
1443
1455
@item Dominik Lehmann (Level design)
 
1456
@item Dominik Leipold (Level design)
1444
1457
@item Edward Leuf (Feedback, bug reports)
1445
1458
@item Ingo van Lil (Feedback, bug reports)
1446
1459
@item Frank van der Loo (Dutch translation)
 
1460
@item Lurcane (Level design)
1447
1461
@item Sidney Markowitz (Mac OS X port)
1448
1462
@item Barry & Lori Mead (Level design)
1449
1463
@item Linda Mihalic (English proof reading)
1450
1464
@item moonpearl (Level design)
 
1465
@item Stephen Morley (Safalra) (Level design)
1451
1466
@item Krishnamurti Lelis Lima Vieira Nunes (Portuguese translation)
1452
1467
@item Daniel Nylander (Swedish translation)
1453
1468
@item Andreas Persenius (Level design)
 
1469
@item Mark Pulley (Level design)
 
1470
@item Rudolf (Level design)
1454
1471
@item Peter Santo (Level design)
1455
1472
@item Tobias Schmidbauer (Windows installer and icon)
 
1473
@item Lukas Sch@"uller (Level design)
1456
1474
@item Achim Settelmeier (RPM specfile)
 
1475
@item ShadowPhrogg32642342 (D@'aniel Borb@'ely) (Level design)
 
1476
@item Alex Smith (Level design)
 
1477
@item Alan Smithee (Level design)
1457
1478
@item Jon Sneyers (Level design)
1458
1479
@item Spaceman (Level design)
1459
1480
@item Ulf Stegemann (Level design)
1461
1482
@item Mikke Surakka (Finnish translation)
1462
1483
@item Andrzej Szombierski (Level design)
1463
1484
@item Tacvek (Lua 5.1 upgrade)
 
1485
@item James Taylor (Level design)
1464
1486
@item Michael Terry (.desktop file)
1465
1487
@item Ray Wick (Level design)
1466
1488
@item Joe Wreschnig (Manual page)
 
1489
@item Zephyr (Level design)
1467
1490
@item Yuriy Zhyromskiy (Russian Manual)
 
1491
@item /dev/null (Level design)
1468
1492
@end itemize
1469
1493
 
1470
1494
@node Utilized Software,  , Contributors, Credits
1472
1496
 
1473
1497
@table @strong
1474
1498
 
1475
 
@item SDL 
 
1499
@item SDL
1476
1500
@uref{http://www.libsdl.org/}
1477
1501
 
1478
1502
@item SDL_image