Minimalist C++ game framework with no graphical editor based on SDL2 and OpenGL.

Uses the common subset of OpenGL 3.3 core profile and OpenGL ES 3.0.
Tested under Ubuntu and Windows using GCC/Clang/MSVC.

• Windows
• Linux
• Android
• Web (via Emscripten)

• Full Lua API for 2D (you don't need to touch any C++ code if you don't want to)
• Online texture atlassing
• Pixel-precise collision detection with rotation and scaling
• OpenGL immediate mode emulation
• Steamworks integration
• Lightweight and fast

You will need CMake version 3.12 or above for build configuration. Mustard has been tested generating Unix Makefiles on Linux and MinGW Makefiles on Windows. No other generators have been tested, so YMMV.

You will also need to install SDL2 as it is not vendored in this repo.

Download the latest SDL2 Development Library for your compiler and extract it somewhere permanently.
Clone the Mustard repository and navigate into it.

Edit this line of src/platform/desktop/CMakeLists.txt:

set(SDL2_DIR "/libs/SDL2-2.26.5/cmake")

...to point to your SDL2 installation's cmake directory.
You will likely want to copy SDL2.dll into ./projectTemplate and ./projectTemplate/dist.

From the command line, run build all

Install SDL2 with sudo apt-get install libsdl2-dev
Clone the Mustard repository and navigate into it.
Run ./build.sh all

Copy the projectTemplate folder somwhere (Mustard's parent folder is a good place) and rename it to your project name.

Edit project.cfg: Change PROJECT_NAME to the name of your project, obvi.

MUSTARD_PATH should point to wherever you've installed Mustard. You'll need to edit this if you've copied the projectTemplate folder to anywhere other than Mustard's parent folder.

If you're on Windows, you'll also need to edit SDL2_PATH to point to your SDL2 installation's cmake directory.

Run build or ./build.sh (depending on your development platform) without arguments to see a list of build options. Use the run script to run your project after building.

Images:

• 24 or 32 bit TGA with or without RLE compression

Audio:

• WAV
• MP3
• FLAC

During development you will typically not need to invoke the asset compiler- building a project in the dist configuration will call the asset compiler to build the archive for you.

If you must use it for some exotic reason, the binary is Mustard-AssetCompiler in the bin directory. This is a command line tool that compiles every file in the directory it was launched, and every file in every subdirectory recursively, into a single glob.

There is an option to specify a key for a laughably weak encryption scheme.

There are few options and no error checking with this program. It is a loose cannon.

C++ documentation can be built with Doxygen and the Lua API documentation can be built with LDoc.

Mustard is licensed under an unmodified zlib/libpng license, which is an OSI-certified, BSD-like license that allows static linking with closed source software. Check LICENSE for further details.

Andrew Krause - ajkrause@gmail.com

Project Link: https://github.com/scgrn/Mustard-Engine