From fead7bcc5a80c61d13cb4206468b15fa0d418b18 Mon Sep 17 00:00:00 2001 From: Ian C Date: Fri, 19 May 2017 11:03:26 +0000 Subject: Added README --- README | 66 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 66 insertions(+) create mode 100644 README (limited to 'README') diff --git a/README b/README new file mode 100644 index 0000000..14a47d7 --- /dev/null +++ b/README @@ -0,0 +1,66 @@ +BUILDING +-------- +To build just run 'make'. + + +DESCRIPTION +----------- + +dbox is a simple brute-force Sokoban level solver. Usage is: + +dbox [-v|-i|-p|-P] file [file2 ...] + +-v - Be verbose. Print depth of search tree as searching is done. +-i - Interactive. Show an interactive version of the map once solved. +-P\-p - Play. Allows you to play the level. + +The file is a Sokoban level defined like this: + + +Level 1 + ### + #.# + # #### +###B B.# +#. B@### +####B# + #.# + ### + +The first line is the title of the level. + +The subsequent lines must all be of the same width and define the level. The +'#' character defines a wall. The 'B' character defines a box. The '.' +character defines a target square. The 'X' character can be used to define a +box already on a target square. + +If no interactive mode is used the level will be displayed along with the +route to solve it, e.g. + +Solving Level 1 + + ### + #.# + # #### +###B B.# +#. B@### +####B# + #.# + ### + +Route = 'DULLRUUDRR' + + +INTERACTIVE MODE KEYS +--------------------- + +In interactive mode the following keys can be used. + +P - Follow the solution path if one was found. +Backspace/B - Step back one move on the solution path. +Cursor Keys - Move. Note that the move will be blocked if the state of the + map is already known or moving a block will make the level + insoluble. +Q - Quit. + +Cursors to move, P to follow path, Q to quit, Backspace/B to step back -- cgit v1.2.3