File: sokoban3d_readme.txt | Size: 5,281 bytes | Download file | Back to directory listing | BWPOW's homepage
Sokoban3D
by Two Citronas
email: bwpow@two-citronas.com
web  : http://two-citronas.com/

Personal contact info:
Samuel 'bwpow' Kupka
email: bwpow@ideaz.sk
web  : http://bwpow.eu/

===========
1. Foreword
===========
This is the first of my weekly game releases. Since I used new Allegro5 library, which I didn't have any former experiences with,
the result is quite poor. But, at least it works somehow, so please, enjoy :)

===========
2. Controls
===========
Right now, only keyboard can be used to play the game. You can use arrows to move about the map and also these keys:
1 - toggles 3D view on and off (when it bothers you while looking at the map)
2 - toggles map on and off
SPACE - push the crate
DEL - destroy the crate (only wooden crates can be destroyed and it will cost you one BANG)
PLUS PAD - zoom in the map
MINUS PAD - zoom out the map
ESCAPE - show menu

========
3. Usage
========
As usual, you can control the behavior of the game in two ways. The first is in-game menu, which is quite simple. It allows you to
select desired map and quit the game.
The second option is using configuration files and your own addons. I've designed the game, so it can be easily extended with your
own maps or even graphics.

Configuration file 'config.ini' should be stored in your documents directory, under 'twocitronas'. If you are using windows and run
the game for the first time, this directory will be created (in 'My Documents' or just 'Documents' depending on your windows version).
You have to create configuration file manually and place it there (the path will be 'Documents\twocitronas\config.ini'). Right now,
you can change resolution and display mode. Here are the examples, that you can copy&paste into the configuration file:
--- example 1 begin ---
[screen]
mode=fullscreen
width=1920
height=1200
--- example 1 end ---
This first example will use fullscreen mode with resolution 1920x1200.
--- example 2 begin ---
[screen]
mode=window
width=1000
height=800
--- example 2 end ---
This second example will create window 1000x800 pixels.
--- example 3 begin ---
[screen]
mode=fullwindow
--- example 3 end ---
This last example will create window, that is stretched right across the whole screen, but isn't full screen mode. I don't know, why you
would need to use this mode, but well, allegro supports it, so why not :)

========================
4. Creating your own map
========================
While loading, the game tries to look into your 'Documents\bwpowgames\sokoban3d\' directory and index all zip files located there. These
zip files can contain new textures, fonts and maps. To find all maps, game looks into each zip file and looks for files with '.map' extension.
When found, it also looks, if there is file with the same name, but with the extension '.info'. These two files together hold all information
needed to make a complete level.

So, to create your own map, create two files, for example 'mylevel.map' and 'mylevel.info'. First, example of the '.info' file:
--- example 4 begin ---
name=Tutorial #4 - Push or blow up?
author=Samuel BWPOW Kupka
email=bwpow@ideaz.sk
web=bwpow.eu
w=20
h=14
dyno=4
--- example 4 end ---
In this example you can see information about the fourth tutorial map named 'Push or blow up?'. Most important lines are 'name', 'w', 'h' and 'dyno'.
Field 'name' is the name of the level, that will appear in the menu. Fields 'w' and 'h' are columns and rows of the map respectively. And 'dyno'
is the number of BANGs, you will have in the game.

Example of the '.map' file:
--- example 5 begin ---
......##....#####...
......##....#...#.#.
...########.#...#.#.
............#...#.#.
...#.#.#.#..#.###.#.
..................#.
.#.################.
.#.#oo..oo..........
.#.#bbBBbbBB####.###
.#..oobboobb#..#.#..
.############.......
...#........#..#.###
.#.#....s......#.#..
.....#####..##...#..
--- example 5 end ---
This is the layout of the level corresponding to example 4. It is very important, that you have exactly 'h' lines containing exactly 'w' (or less) characters.
Allowed characters are:
# (or X or x) - wall
. - empty space
o - destination for the crate
b - wooden crate (may be destroyed)
B - concrete crate (may not be destroyed)
s - starting position
Game is very strict when loading maps, so if your map doesn't show up in the menu, you have done something wrong. Unfortunately, it won't tell you what.

When you are satisfied with your two files, pack them into the zip file and place it under 'Documents\twocitronas\sokoban3d\'. Be creative choosing file names,
because if you create more maps with the same file names and even place them in different zip files, only one (the last one indexed) will be visible.

The same principle can be applied when replacing graphics or any other resource. When indexing, file with the same file name as the file previously indexed will
replace the former one and be used in it's place.

==========
5. Credits
==========
I've been using MinGW32 and Code::Blocks. Also, I wouldn't make anything without Allegro library.
The textures were generated with free Genetica viewer found here: http://www.spiralgraphics.biz/index.htm
Game logo was made in some old Xara Webstyle (I think it is version 1.2), that was included on a CD shipped with some magazine many years ago.