From c90c389a8a8d9d8661e9772ec4144c5cf2039f23 Mon Sep 17 00:00:00 2001 From: toma Date: Wed, 25 Nov 2009 17:56:58 +0000 Subject: Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features. BUG:215923 git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kdegames@1054174 283d02a7-25f6-0310-bc7c-ecb5cbfe19da --- doc/ksokoban/Makefile.am | 4 + doc/ksokoban/index.docbook | 429 +++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 433 insertions(+) create mode 100644 doc/ksokoban/Makefile.am create mode 100644 doc/ksokoban/index.docbook (limited to 'doc/ksokoban') diff --git a/doc/ksokoban/Makefile.am b/doc/ksokoban/Makefile.am new file mode 100644 index 00000000..368fc0da --- /dev/null +++ b/doc/ksokoban/Makefile.am @@ -0,0 +1,4 @@ + +KDE_DOCS = AUTO +KDE_LANG = en + diff --git a/doc/ksokoban/index.docbook b/doc/ksokoban/index.docbook new file mode 100644 index 00000000..93fbfbea --- /dev/null +++ b/doc/ksokoban/index.docbook @@ -0,0 +1,429 @@ + + + + + +]> + + + +The &ksokoban; Handbook + + + +Anders +Widell + +
&Anders.Widell.mail;
+ + + + + + +2000 +&Anders.Widell; + + +&FDLNotice; + +2006-06-19 +0.4.2 + + + +&ksokoban; is a &kde; implementation of the Japanese warehouse keeper +game sokoban. + + + + +KDE +kdegames +game +sokoban +ksokoban + + + + +Introduction + + +The first sokoban game was created in 1982 by Hiroyuki Imabayashi at +the Japanese company Thinking Rabbit, Inc. Sokoban is +japanese for warehouse keeper. The idea is that you +are a warehouse keeper trying to push crates to their proper locations +in a warehouse. + + + +The problem is that you cannot pull the crates or step over them. If +you are not careful, some of the crates can get stuck in wrong places +and/or block your way. + + + +It can be rather difficult just to solve a level. But if you want to +make it even harder, you can try to minimize the number of moves +and/or pushes you use to solve the level. + + + +To make the game more fun for small kids (below 10 years or so), some +collections with easier levels are also included in &ksokoban;. These +are marked (easy) in the level collection menu. +Of course, these levels can be fun for adults too, for example if you +don't want to expose yourself to too much mental strain. + + + + +The Game + + +The objective of the game is to push all the red gems to the goal +squares, which are marked with green glassy round things on the floor. + + + +Use the cursor keys or the mouse to move about. If you move onto a gem +using the cursor keys or the middle mouse +button, and there is nothing blocking it on the opposite side, then you +will push the gem. It isn't possible to pull the gems, so if you push +a gem into a corner it will be stuck there. You cannot step over the +gems either, so you can also get trapped in a part of the maze by +blocking the way with gems. Also note that it isn't possible to push +more than one gem at a time. + + + +If you notice that you have moved the gems in such a way that the +level is impossible to solve, then you can always use the undo feature +to go back to a position where the mistake has not yet been made. You +can of course also restart the level from the very beginning. + + + +Controls + + + + + +KeyAction + + + +Cursor keys Move one square in a direction +&Ctrl;Cursor keys Move as far as possible in a direction without pushing any gems +&Shift;Cursor keys Move as far as possible in a direction, pushing any gem in the way +Left mouse button Move to any place in the maze that can be reached without pushing any gems +Middle mouse button or &Ctrl;ZUndo the last move +Right mouse button Move up/down/left/right in a straight line, pushing any gem in the way +Mouse wheelTraverse the history +&Ctrl;&Shift;ZRedo the last undone move +N Go to the next level in the current level collection +P Go to the previous level in the current level collection +&Esc; Restart the current level +&Ctrl;QQuit the game + + + + + + + +Loading external levels + + +&ksokoban; has the ability to load external sokoban levels from text +files. You can load levels using the menu entry +Game Load +Levels... , or by specifying the level file +&URL; as a command line argument when starting &ksokoban; from a +shell. + + + +The external levels must be defined using the standard characters +shown in the table below. If the file contains more than one level, +the levels should be separated by blank lines. The file may also +contain text between the levels. + + + + + +CharacterMeaning + + + +#Wall +(space)Empty square +.Goal square +$Object on an empty square +*Object on a goal square +@Start position on an empty square ++Start position on a goal square + + + + + +As an example, below is a text representation of the first level in the +Microban level collection: + + + + +#### +# .# +# ### +#*@ # +# $ # +# ### +#### + + + + + + +Menu Reference + +This is a complete guide to the menus of &ksokoban;. + + +The <guimenu>Game</guimenu> Menu + + + + +Game +Load Levels... + + +Load an external level. See the section Loading External Levels for +more information. + + + + + +N +Game +Next Level + + +Load the next level. + + + + + +P +Game +Previous Level + + +Go back to the previous level. + + + + + +&Esc; +Game +Restart Level + + +Restart the current level. + + + + + +Game +Level Collection + + +Change to a different set of levels. &ksokoban; +comes with several level sets, and you can load more that you can find +on the internet. + + + + + +&Ctrl;Z +Game +Undo + + +Undo the last move + + + + + +&Ctrl;&Shift;Z +Game +Redo + + +Redo the last move you undid with the menu item +above. + + + + + +&Ctrl;Q +Game +Quit + + +Exit &ksokoban;. + + + + + + +The <guimenu>Animation</guimenu> Menu + + +The Animation Menu allows you to specify the speed that movement replay animations are shown at. + + + + + +Animation +Slow + + +Show replay animations at a slow pace. + + + + + +Animation +Medium + + +This is the default setting, and shows replay animations at a slightly faster pace. + + + + + +Animation +Fast + + +Show replay animations at the fastest pace. + + + + + +Animation +Off + + +Do not animate replay animations. + + + + + + + + +The <guimenu>Bookmarks</guimenu> Menu + + + + +Bookmarks +Set Bookmark + + +&ksokoban; allows you to set bookmarks with a level at a +particular state. You might use this to save yourself +repeating the same initial steps in a level. +You can have up to ten bookmarks at a time, and access them via the +hotkey &Ctrl;X, +where X is any digit between 0 and 9. + + + + + +Bookmarks +Go to Bookmark + + +Jump to a state you have previously saved as a +bookmark. + + + + + + + +The <guimenu>Help</guimenu> Menu + +&help.menu.documentation; + + + + + +Credits and License + + +&ksokoban; is copyright © 1998-2000 by &Anders.Widell; +&Anders.Widell.mail;. For +the latest info on &ksokoban;, see the &ksokoban; home page at + +http://hem.passagen.se/awl/ksokoban/ + + + +The background graphics starfield was taken from the +Gimp. All other graphics +were created by &Anders.Widell; &Anders.Widell.mail; using +the Povray ray tracer. + + + +All the currently included sokoban levels were created by David W. +Skinner sasquatch@bentonrea.com. See his sokoban page +at +http://users.bentonrea.com/~sasquatch/sokoban/ + + + +&underFDL; +&underGPL; + + + +Installation + +&install.intro.documentation; + +&install.compile.documentation; + + + +&documentation.index; + + -- cgit v1.2.3