Readme.md

Some notes on building Boxer

The Boxer XCode project is designed to be a painless one-click build. Here's a quick rundown of how it's set up:

Build requirements

To build the Boxer project you will need OS X 10.8 or higher and XCode 4.5 or higher.

All necessary frameworks and other dependencies are included in the Boxer repo, so the project itself is all you'll need.

Build Targets

The Boxer project has three targets:

"Boxer": the standard Boxer emulator you know and love, as seen on http://boxerapp.com. This is almost certainly the one you'll want to use.

"Boxer Standalone": a cut-down version of Boxer that wraps up a gamebox into a single unified app. Game importing and settings UIs have been stripped out of this version, and it will only launch the gamebox that bundled inside it. This target is not meant to be used on its own: instead it's a build component for…

"Boxer Bundler": a graphical tool for converting gameboxes into standalone apps using its own self-contained copy of Boxer Standalone.

Build Configurations

The Boxer target has 2 build configurations: Release and Debug. Both of them compile fully optimized 32-bit binaries using the LLVM compiler. Debug works almost exactly the same as Release but turns on console debug messages and additional OpenGL error-checking.

Boxer currently does not compile for 64-bit because DOSBox is not fully 64-bit compatible. Boxer's bundled frameworks have been stripped down to 32-bit-only to save space.

App requirements

Boxer and Boxer Standalone both run on OS X 10.6 and above, while Boxer Bundler runs on OS X 10.8 and above.