Since the Mutiny engine is mainly a developer tool, it is currently distributed in source form to maintain flexibility and portability to different platforms and their package systems. This means that in order to use it, it must be compiled. The following steps detail how this can be achieved. Experienced developers may recognise that Mutiny uses a fairly typical cmake setup and so it should be simple enough for them to "wing it".
Before attempting to compile, the following dependencies must be met:
Note: For Windows users it can be quite time consuming to manually compile each dependency for your toolchain. For convenience, all the dependencies are included for both VS2010 and VS2013. Simply extract the files from the respective .zip files found in the import directory.
Note: Linux and BSD users can add the required packages using their package manager. For some distributions of Linux, make sure to add the *-dev or *-devel packages to ensure that the required developer libraries and headers are installed.
Now that the dependencies have been installed, grab a copy of the source code by either extracting a tarball or checking out the latest version from the repository. The following steps will then take you through compiling the engine, tools and example projects.
Open up a terminal, cd into the directory and run the following commands.
$ mkdir build $ cd build $ cmake .. $ make
Open up the Visual Studio command prompt, cd into the directory and run the following commands.
> mkdir build > cd build > cmake -G "NMake Makefiles" -DCMAKE_BUILD_TYPE=RELEASE .. > nmake
Note: Microsoft NMake Makefiles are explicitly specified in the above commands because this is what the Mutiny Editor uses. If you want to create a Visual Studio solution then you can ignore the -G parameter. However, be aware that Visual Studio generates extra Debug and Release folders which may cause issues.
Once the initial build is complete, from now on, only the make and nmake steps are necessary from within the build directory. You should now see a new folder called bin within the root directory of Mutiny. You should be able to run these and have a quick play around to make sure the engine is working on your platform.
Congratulations. At this point, Mutiny is now ready for you to get started.