locksmyth / digbuild Goto Github PK

###########################################################################
# ABOUT
###########################################################################

Digbuild is an experimental project to create a voxel-based game with many
similarities to Minecraft (and many improvements as well).

###########################################################################
# DEPENDENCIES
###########################################################################

The following libraries are required to build Digbuild:

    * Agar (http://libagar.org)
    * Boost
    * GL
    * GLEW
    * GLU
    * GMTL (http://sourceforge.net/projects/ggt)
    * SDL
    * SDL Image
    * Threadpool (http://threadpool.sourceforge.net)

On Ubuntu 11.04 you can use ubuntu1104.sh to install these.

###########################################################################
# BUILDING
###########################################################################

In the top-level Digbuild directory, run 'scons'.  Depending on where your
Boost and GMTL header files are installed, you may need to use the following
options:

    --boost-include-dir=<PATH>
    --gmtl-include-dir=<PATH>

The following arguments may also be used to configure the build:

    optimize=(1|0) # Build the binary with optimizations.
    assert=(1|0)   # Build the binary with assertions left in.
    release=(1|0)  # Strip the binary, etc.
    profile=(1|0)  # Build gprof profiling information into the binary.

The 'define' argument accepts a comma separated list of C++ macros to define:

    define=DEBUG_CHUNKS,DEBUG_COLLISIONS,DEBUG_CHUNK_UPDATES,DEBUG_TIMERS

The following build targets may be useful:

    run      # Run the binary (after building it if necessary).
    prof     # Run the binary and generate profiling output when it exits.
    src/tags # Build an exuberant-ctags database file.

###########################################################################
# CREDITS
###########################################################################

Author: Evan Mezeske

Special thanks to Paul Bourke for his excellent free textures:
    http://paulbourke.net/texture_colour/