NAME

crates - extensible 3D puzzle game

SYNOPSIS

crates [-v] [--version]

DESCRIPTION

crates is a three dimensional puzzle game. It consists of missions that consist of levels. To pass a mission, you must move player to the exit by interacting with the different kinds of crates in the level. Before that you must also collect all the keys and toggle all the toggles that the level might contain. Every level has a password that makes it possible to continue playing from that level whenever you want, but if you want to get your name in the hall of fame, you must play the whole mission at one go. On that case, the faster you are, the better is your position in the hall of fame.

crates is controlled with a keyboard or a gamepad. Passwords can be written faster with the alphanumeric keys of the keyboard or a little slower by using the D-pad of gamepad to select the letters one at a time. The default buttons of the gamepad and many other settings of the game can be changed in a configuration file config.lua in the resources-directory of the game. Sound effects are disabled as a default, and if you want to enable them you can do it by changing setting config.sounds from false into true in the configuration file. See the configuration file for the other configurable settings.

Player is moved around with a keyboard or a gamepad. It continues movement until something stops it. It can be moved only when it is not already moving - you cannot change player's direction if it is moving. If nothing stops it, it will fly out of the level and the level is restarted.

OPTIONS

-v, --version

Display version information.

CONFIGURATION

Available configuration options can be seen and modified in resources/config.lua.

CONTROLS

Game is controlled with a keyboard or a gamepad. The default controls are listed below. The default buttons of gamepad can be changed in the configuration file.

FILES

resources/

This directory and its subdirectories contain all the different resources of the game. That is, it contains the configuration file, all the textures, meshes, Lua scripts for the missions and for the different game states.

resources/config.lua

All the configurable settings of the game. The configuration file is a Lua script.

resources/missions

Directory containing all the missions of the game. If you have new mission(s), you can drop those to this directory and (re)start the game. After that those new missions can be selected from the game's menu and played. Missions are Lua scripts.

resources/states

Directory containing Lua scripts for all the different states of the game. New states can be dropped to this directory and those will be loaded when game is (re)started.

resources/entities

Directory containing Lua scripts for all the different crates of the game. New entities can be dropped to this directory and those will be loaded when game is (re)started.

resources/textures

Directory containing all the textures of the game. New textures can be dropped to this directory and those will be loaded when game is (re)started.

resources/meshes

Directory containing Lua scripts for the 3D meshes of the game. New meshes can be dropped to this directory and those will be loaded when game is (re)started.

resources/sounds

Directory containing sound effects of the game. New sound effects can be dropped to this directory and those will be loaded when game is (re)started.

resources/musics

Directory containing musics of the game (might be empty if there is no musics). New music-files can be dropped to this directory and those will be loaded when game is (re)started.

resources/halloffame

Directory containing the hall-of-fame-files of the different missions.

resources/log.txt

The log file for the last run of the game. This file is generated only if the setting config.filelog is set to true in the configuration file.

NOTES

crates uses major.minor.build version numbering scheme as defined in http://docs.rubygems.org/read/chapter/7

BUGS

If you find a bug, please see the crates homepage www.octaspire.com/crates/ for up-to-date instructions on reporting bugs.

Please note that if you enable sounds and your systems has PulseAudio, the SDL(_mixer) + PulseAudio combination might cause problems at least on some GNU/Linux-systems. See for example "the pulseaudio hack". For example, at the time of writing in Ubuntu, if your system has SDL with ALSA option (libsdl1.2debian-alsa) installed, sounds might be crackling, channels will ebb away and game will get jammed when you try to quit playing. In this case removing libsdl1.2debian-alsa and installing SDL with PulseAudio options (libsdl1.2debian-pulseaudio) instead helped.

COPYRIGHT

Crates ‐ extensible 3D puzzle game. Copyright (C) 2008‐2010 Octaspire (www.octaspire.com)

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.