Introduction

Mutiny is an open-source (re)-implementation of the Unity 4.x API. Originally developed to port our simulations to HTML5/WebGL over 4 years prior to upstream Unity supporting Emscripten.

Getting Started

Getting Mutiny up and running is quick and simple. The main step is compiling Mutt, the Mutiny build system. The commands needed for this step are listed below.

Steps for Linux and Mac OS X

Check out the code from the repository or extract from tarball. Open up a command prompt and do the following:

$ cd <path to mutiny>
$ cd bootstrap
$ ./bootstrap.sh

Steps for Windows

Check out the code from the repository or extract from tarball. Open up a command prompt and do the following:

> cd <path to mutiny>
> cd bootstrap
> bootstrap.bat

Compiling a Project

Now that Mutt has been built, we can now go on to building and running one of the sample projects.

Note: Mutt is the recommended way to build Mutiny projects. Not only does it abstract between quirks of multiple C++ compilers but it also provides iterative builds and could potentially be used to generate code using many of the tools provided by the engine.

Steps for Linux and Mac OS X

$ cd samples/experiment
$ mutt
$ build/linux/bin/experiment

Steps for Windows

> cd samples\experiment
> mutt
> build\windows\bin\experiment

After the project is built and running successfully, now we can move on to creating a new project from scratch.