File	Date	Author	Commit
bin	2011-01-11	gusnan	[b86686] Initial git commit
cmake	2011-11-07	gusnan	[25be54] Add newline at end of file
data	2011-01-11	gusnan	[b86686] Initial git commit
lib	2011-01-11	gusnan	[b86686] Initial git commit
scripts	2011-09-10	gusnan	[1c3364] Fix the stairs in the maps.
src	2012-04-23	gusnan	[67756a] Fix C style pointer casting problems
.gitignore	2011-12-02	gusnan	[7c9a6b] Update gitignore
CHANGES	2011-01-11	gusnan	[b86686] Initial git commit
CMakeLists.txt	2011-09-12	gusnan	[4fb72c] Add decoration class for wall buttons
COPYING	2011-01-11	gusnan	[b86686] Initial git commit
CREDITS	2011-01-11	gusnan	[b86686] Initial git commit
Dev.txt	2011-01-11	gusnan	[b86686] Initial git commit
README	2011-01-11	gusnan	[b86686] Initial git commit
TODO	2011-01-11	gusnan	[b86686] Initial git commit
dotg.xml	2011-09-12	gusnan	[4fb72c] Add decoration class for wall buttons

Read Me

--------------------------------------------------------------------------------
Damnation of the Gods - README
--------------------------------------------------------------------------------

NOTICE:

This is an early development release (obviously), and it has only been tested on
Nvidia and Intel graphics, so testing on other hardware is required.


REQUIREMENTS:

DotG has been tested on my main machine with AMD64, and Nvidia graphicscards
of the 7xxx and 8xxx-series, but does also run on a machine with a Geforce 4xxx-
series card.

On a debian machine the required libraries to build are:

cmake
build-essential
liblua5.1-0-dev
libsdl1.2-dev
libsdl-image1.2-dev
libsdl-ttf2.0-dev
libboost-dev
libboost-serialization-dev



This should pull in all required libraries to build and run DotG.
In addition to this, libglew1.5-dev is optional. (There is a build
option to turn on/off the libglew usage.)

On windows, the following DLLs are required to run DotG, which are all
distributed in the DotG win32 package:

ALURE32.dll
libfreetype-6.dll
libpng12-0.dll
libtiff-3.dll
lua51.dll
OpenAL32.dll
SDL.dll
SDL_image.dll
SDL_ttf.dll
wrap_oal.dll
zlib1.dll


I havn't got any ATI card, so that hasn't been tested, please report any 
problems you run into with your hardware.

First time you run DotG, if you don't have a configuration-file (located in 
your home directory, and called .dotg_config.lua), it will be created and 
filled with default values. These values can be changed with the -D option to 
the cmake command and the DEFAULT_GRAPHICS_FOLDER and DEFAULT_SCRIPT_FOLDER 
options. See below for more info and an example.

*********
IMPORTANT
*********

Currently DotG requires the graphics of the DMJava project. I am constantly 
looking for graphics artists that can provide graphics under some kind of "open" 
license, but not having much luck finding any I use that graphics as the last 
resort. As I get (or make) more graphics, less will be used from un-unique 
sources.



--------------------------------------------------------------------------------
Building:
--------------------------------------------------------------------------------

DotG requires the SDL, SDL_ttf, SDL_Image, Boost and the LUA libraries to build, 
and uses the CMake build system for setup. The Glew library is optional.

Simple:

enter the build/ directory, and run 

cmake ..

This will generate the required makefiles in the same directory (and spit out 
errors if you are missing any required libraries). After this you can as usual 
simply run make to build.

If you want to build a debug version of DotG, generate the makefile by running

cmake .. -DDEBUG=on

which will create a debug makefile, and then to actually create the program,
run make.

If using MSys you might have to add the -G"MSYS Makefiles" option, while the
Unix build does default correctly. Otherwise, on unix and linux , add option 
-G"Unix Makefiles".

If you would like to change the default folders, you will need to see the file
ConfigHandler.cpp around line 100 - there the default folders are defined.
This is what is written to the config file which is created at program start if
it doesn't already exist. If it does exist, nothing is changed or overwritten.


--------------------------------------------------------------------------------
Config:
--------------------------------------------------------------------------------

The config system will check the folders listed in the config file for
graphics and scripts. If those folders doesn't contain the requested files,
the config system will check "../data" and "../scripts".


--------------------------------------------------------------------------------
Running:
--------------------------------------------------------------------------------


The config file has an option for how much a delay should be applied each 
vertical sync. - This is used to decide how much of the system resources should
be given to DotG - can be used to lower the battery-usage on laptops forexample.


--------------------------------------------------------------------------------
Command Line Options:
--------------------------------------------------------------------------------

--fullscreen, -f				Run in fullscreen

--windowed, -w					Run windowed

--loadMap=<filename>, 
-l=<filename>					Load a certain map (try dotg -l=init_dungeon.lua) 
									from the scripts folder

--directly_to_game, -d		Enter Game at once, without showing main menu
														
--delay=X, -de=X				Sets the SDL_Delay to value X.

--double_buffer, -db			Use double buffer, will prevent flickering

--------------------------------------------------------------------------------
Keyboard:
--------------------------------------------------------------------------------

ALT+X				Quit to mainmenu (or exit program if already in main menu)

CTRL+Alt+Z		Quit immediately to operating system (without asking)

CTRL+O			Options dialog

F1					Game Menu

N					Load a map (currently this loads the "init_dungeon.lua" map)

ALT+M				Show / Hide minimap

F6 / F7			Play around with game lighting

Alt+Enter 		Switch between fullscreen and windowed mode


--------------------------------------------------------------------------------
In Game
--------------------------------------------------------------------------------

You can change the item in the "attack" hand by simply clicking on it as any 
other inventory slot, but also by pressing the attack buttons to the right 
while holding the Ctrl button on your keyboard.


--------------------------------------------------------------------------------
Last notes:
--------------------------------------------------------------------------------

As said in several places, this is an early development release, and far away
from a fully playable game. It may contain files that are meant to be removed,
unfinished implementations of stuff, and missing features. 


--------------------------------------------------------------------------------
More info at:
http://dotg.sourceforge.net
email: gusnan@gusnan.se
--------------------------------------------------------------------------------