nomlib

C++11 2D game framework using SDL2

Projects Using nomlib

• i8degrees/ttcards

Building

First, ensure that you have the following core dependencies installed:

• cmake v2.8.12+
• git
• doxygen v1.8.x and graphviz only if you want to generate developer documentation.

Next, you should visit the dependencies section for your platform. After these mundane chores are complete, you should be ready to start the building process for your platform!

Mac OS X

After you have the dependencies taken care of, execute the following commands at your terminal prompt:

git clone https://github.com/i8degrees/nomlib
cd nomlib
mkdir build && cd build
# XCode project files can be generated by passing -GXcode
cmake -DDEBUG=on -DDEBUG_ASSERT=on -DEXAMPLES=off -DNOM_BUILD_TESTS=on -DCMAKE_OSX_DEPLOYMENT_TARGET=10.7 -DCMAKE_INSTALL_PREFIX=~/Library/Frameworks ..
make
make test
make install

Upon a successful build, you should have the library modules built as OS X framework bundles, installed wherever CMAKE_INSTALL_PREFIX was set to.

Linux

Linux builds are broken at the moment.

Until I get around to writing the proper instructions, you may take a look at my .travis.yml build script in the project root of nomlib for hints!

Windows

NOTE: Alpha build quality. This has only been tested on MS Windows 7.

After you have the dependencies taken care of, execute the following commands at the DOS prompt:

git clone https://github.com/i8degrees/nomlib
cd nomlib
mkdir build && cd build
cmake -G"Visual Studio 12" -DARCH_32=on -DDEBUG=on -DDEBUG_ASSERT=on -DEXAMPLES=off -DNOM_BUILD_TESTS=on ..

Upon a successful generation, you should have populated your current build directory with several Visual Studio project files -- nomlib.vcxproj is the top-level solution.

Project Options

Build options are passed to cmake with the -D option. For example, to change the installation prefix:

cmake -D CMAKE_INSTALL_PREFIX=~/Library/Frameworks ..

• Installation path: -D CMAKE_INSTALL_PREFIX=<DIRECTORY_PREFIX>

  • Defaults to your current build directory

• Documentation: -D DOCS=<BOOLEAN>

  • Defaults to OFF
  • When built (ON), the resulting documentation will reside in a new directory named docs

• Examples: -D EXAMPLES=<BOOLEAN>

  • Defaults to OFF
  • When built (ON), the resulting binaries will reside in a new directory named examples

• Debugging: -D DEBUG=<BOOLEAN> -D DEBUG_ASSERT=<BOOLEAN>

  • Defaults to OFF

• Universal binary: -D UNIVERSAL=<BOOLEAN>

  • Defaults to OFF

Removal is provided by executing make uninstall within your current build directory.

IMPORTANT: If you are building multiple target types with the generated MSVCPP or Xcode project files, each of these targets must be kept in separate build directories!

Mac OS X Dependencies

Required OS X version: 10.7

See third-party/README.md for where to obtain pre-packaged libraries and how to install them.

Microsoft Windows Dependencies

Required version: Microsoft Windows Vista

NOTE: This has not been verified.

See third-party/README.md for where to obtain pre-packaged libraries and how to install them.

• Microsoft Visual Studio Express 2013 for Windows

  • Required software tools in your system PATH
    • MSVSCPP -- <MSVSCPP_INSTALL_PATH>\bin
    • CMake -- <CMAKE_INSTALL_PATH>\bin
    • Git -- <GIT_INSTALL_PATH>\bin

If this is your first time installing the tools, you might be happy to know that the official installers can do this task for you automatically.