+----------------------------------------------------------+
|                       SokobanLP v0.1                     |
|                  Copyright (c) 2006 nzero                |
+----------------------------------------------------------+

License:

See the included license.txt


Brief Description and Game Objective:

SokobanLP is the puzzle game Sokoban, written in LUA for
the PSP.  The objective is to push the diamonds
onto the goal squares.


Controls:

D-Pad:          Move your character in the given direction
Select button:  Restart current level
Square:         Undo move up to the first move of game
Triangle:       Redo last undo move, available until a new move is made
Right trigger:  Advance to next level in the current level collection
Left trigger:   Revert to previous level in the current level collection
Circle:         Load next level collection in collections directory
Cross:          Close current message box
Start:          Exit game


Game Objective:

You must push the diamond objects such that no goal square is left uncovered.
You may not pull the diamond objects, nor push more than one at a time.  It is
possible, and even easy to make unbeatable levels; however, none of the levels
included with the game are unbeatable.


Screen Description:

The upper portion of the screen shows you how many moves you've made in
the current level, the number of goals completed versus the total number of
goals, the current level number, and the remaining battery percentage.

The lower portion displays the board.  The black squares are floor tiles,
the squares containing stars are outer space, the dark gray squares are wall tiles,
the red squares are diamonds, the green squares are goal squares, and the little
blue fellow is the player.


Level Collections:

SokobanLP loads standard Sokoban level collection files.  This means
a semicolon followed by a number denotes the start of a level definition
and the following characters, given in quotation marks, represent various tiles:

"#" - wall tile
"@" - player tile
"$" - diamond
"+" - player standing on goal
"*" - diamond on goal
" " - space or floor tile

The first line in the file is assumed to be a brief description and is used
to introduce the collection.

You may create or download your own level collections and have SokobanLP load them
by placing them in the "collections/" subdirectory.  The file extension is disregarded.

All collections included with this release are created by and Copyright (c) David
Skinner (sasquatch@bentonrea.com).  See the Credits section for more information.


Future Additions:

-loadable tilesets
-configuration file
-popup menu for game operations
-save/load states
-screenshot mechanism
-replacement for hacked ui
-replacement for crude space/floor detection algorithm
-click and move algorithm for use with mouse cursor
-scrollable level field for levels larger than a certain size
 (levels over a certain size are currently unplayable due
  to the diamonds being too small to see)
-lots and lots more documentation in the code


Comments/Suggestions:

Please email all comments and suggestions to sokobanlp@gmail.com

I am specifically interested in feedback conerning the UI, and, obviously, any
bugs you find.  I do ask that if you discover a bug, you include a good deal of
information about what level you had loaded, if you were able to reproduce the
bug, what version of LuaPlayer you were running, and so on.


Known Bugs (don't report these!):

-floor sometimes appears outside the walls.  This isn't a bug so much as me
 being lazy and not wanting to write a proper floor/space detection algorithm


Credits:

coding and game design - nzero (sokobanlp@gmail.com)

I would like to thank David Skinner (sasquatch@bentonrea.com) for
graciously providing his wonderful Sokoban levels online for use
in Sokoban programs. 

David Skinner's Sokoban levels are available at: 
   http://users.bentonrea.com/~sasquatch/sokoban/

I also have to credit ema for creating the TwinTail LDE, which
I used heavily in the creation of my project, both for debugging
and as a reference.  I strongly recommend that you get this
program.  For text editing, if for nothing else.

TTLDE is available from: 
   http://geocities.com/lua_ema/
