README

Open Dungeons
=============

Welcome into the Open Dungeons (OD) project README file.

Website: http://opendungeons.sourceforge.net/
Forums: http://forum.freegamedev.net/viewforum.php?f=15
Official repository: https://github.com/OpenDungeons/OpenDungeons ('development' branch)
Media source files: https://github.com/OpenDungeons/OpenDungeons-media-source

--- Folders structure ---
Data files :
------------

config/          - Several game config files
dist/            - Icons and linux desktop entry file.
gui/             - CEGUI files + corresponding Gui images
levels/          - Game levels
licenses/        - License files used for game data and code
materials/       - Materials (models texturing scripts and textures)
models/          - Model files
music/           - Music files
packs/           - Ogre files useful to run the starting pop-up
scripts/         - Our AngelScript code files
sounds/          - Game Sounds

Code files:
-----------

cmake/           - Helper files for CMake
 |- config/      - Variable input files for the CMake script
 |- modules/     - Addon scripts for CMake to find dependencies
dependencies/    - All external projects
 |- angelscript/ - AngelScript SDK, our scripting language
sources/         - All our own .cpp and .h files of the game
.gitignore       - The files and folders that are ignored by git locally
CMakeLists.txt   - CMake script for generating the Makefile and IDE projects
od.cppcheck      - Project file for Cppcheck (cppcheck.sourceforge.net)
README           - The file you are currently reading

-- Coding Guideline ---
Before you start coding you should take a glimpse at our guideline
over at the wiki:
  http://opendungeons.sourceforge.net/wiki/doku.php?id=code_style_guidelines

It contains a rather deep introduction on how we name, indent, structure and
extend our code. It also has some performance optimisation tips.

--- Build Instructions ---
More detailed, and usually up to date build instructions can be found at:
  http://opendungeons.sourceforge.net/wiki/doku.php?id=building_from_source

To build the game run the following commands from the directory where this
README file is. You will need CMake for this (http://cmake.org/).

    mkdir build && cd build
    cmake ..
    make
    ./opendungeons

To build the game, you will need to link against the following libraries:
*  OGRE SDK (1.9.x)
*  boost (same version as the one used by Ogre)
*  CEGUI SDK (0.8.x)
*  SFML (2.x)

On windows, make sure you have the MSVC corresponding SDK, or either compile from source.

Then, use CMake-Gui to generate project files for your IDE.

You can also have a look at our FAQ.txt file for more information.