1. Tommy
  2. Rainbow

Overview

HTTPS SSH

Rainbow codecov

Rainbow is a fast, scriptable, cross-platform, 2D game engine written in modern C++.

Copyright © 2010-16 Bifrost Entertainment AS and Tommy Nguyen.

Distributed under the MIT License (see accompanying file LICENSE or copy at https://opensource.org/licenses/MIT). Licenses for third-party software can be found in file THIRDPARTY.

Features

Cross-platform

Rainbow runs on most popular operating systems:

Android iOS Linux Mac OS X Windows
Linux build Status Windows build status

Audio

Rainbow integrates FMOD Studio, giving you access to the same professional tools that AAA studios use. There is also an open source alternative built on OpenAL. Audio format support depends on the platform. Typically, MP3 and Ogg Vorbis on Android, and AAC, ALAC, and MP3 on iOS and OS X.

Graphics

Rainbow is mostly built on OpenGL ES 2.0 and features:

  • Scene graph
  • Sprites-based rendering with explicit batching
  • Animation with traditional sprite sheets, or…
  • Skeletal animation imported directly from Spine
  • Text rendering (supports TrueType and OpenType via FreeType)
  • Texture atlas (PNG and PVRTC)

Input

  • Accelerometer (Android and iOS)
  • Keyboard and mouse (Linux/Mac OS X/Windows)
  • Microphone (Android and iOS)
  • Touch (Android and iOS)

And more…

  • Lua scripting language with debugging console and hot reloading
  • 2d rigid body physics provided by Box2D

Structure

build/  # Build related files
demos/  # Lua demos
doc/    # Documentation
lib/    # Third party libraries Rainbow depend on
lua/    # Lua convenience libraries
src/    # Rainbow source code
tools/  # Tools such as the build script

Building

First of all, clone the repository:

$ git clone --recursive https://bitbucket.org/tido/rainbow.git

The repository only includes some of the libraries required to build Rainbow. The remaining requisites is listed on each platform's section. They must be installed or copied into the repository before you can start building Rainbow.

Easiest way to build Rainbow is to use the provided build scripts:

$ mkdir rainbow-build
$ cd rainbow-build
$ /path/to/rainbow/tools/build.sh [platform] [options]

Run build.sh help to get an overview of options and configurations. platform can be omitted if compiling a native build (i.e. not cross-compiling).

If you have problems running build.sh, please make sure it has execution permission:

$ chmod +x /path/to/rainbow/tools/build.sh

For Windows developers, run the PowerShell script tools\make.ps1 (right-click on it and select Run with PowerShell). It will take you through the steps.

For iOS builds, see the corresponding section.

Building with FMOD Studio

The default audio backend for all platforms is currently OpenAL. If you want to use FMOD Studio, run build.sh with -DUSE_FMOD_STUDIO=1 or replace RAINBOW_AUDIO_AL=1 with RAINBOW_AUDIO_FMOD=1 in the project file.

FMOD's licence prevents redistribution of its files so you'll have to download them yourself here. Extract or install it and move the files into the repository under lib/FMOD/. It should look similar to the listing below if you've done it correctly:

# Headers
lib/FMOD/inc/fmod.h
lib/FMOD/inc/fmod.hpp
lib/FMOD/inc/fmod_codec.h
lib/FMOD/inc/fmod_common.h
lib/FMOD/inc/fmod_dsp.h
lib/FMOD/inc/fmod_dsp_effects.h
lib/FMOD/inc/fmod_errors.h
lib/FMOD/inc/fmod_output.h
lib/FMOD/inc/fmod_studio.h
lib/FMOD/inc/fmod_studio.hpp
lib/FMOD/inc/fmod_studio_common.h

# Android
lib/FMOD/lib/android/armeabi/libfmod.so
lib/FMOD/lib/android/armeabi/libfmodstudio.so
lib/FMOD/lib/android/armeabi-v7a/libfmod.so
lib/FMOD/lib/android/armeabi-v7a/libfmodstudio.so
lib/FMOD/lib/android/fmod.jar
lib/FMOD/lib/android/x86/libfmod.so
lib/FMOD/lib/android/x86/libfmodstudio.so

# iOS
lib/FMOD/lib/ios/libfmod_iphoneos.a
lib/FMOD/lib/ios/libfmod_iphonesimulator.a
lib/FMOD/lib/ios/libfmodstudio_iphoneos.a
lib/FMOD/lib/ios/libfmodstudio_iphonesimulator.a

# Linux
lib/FMOD/lib/linux/x86/libfmod.so
lib/FMOD/lib/linux/x86/libfmod.so.5
lib/FMOD/lib/linux/x86/libfmod.so.5.14
lib/FMOD/lib/linux/x86/libfmodstudio.so
lib/FMOD/lib/linux/x86/libfmodstudio.so.5
lib/FMOD/lib/linux/x86/libfmodstudio.so.5.14
lib/FMOD/lib/linux/x86_64/libfmod.so
lib/FMOD/lib/linux/x86_64/libfmod.so.5
lib/FMOD/lib/linux/x86_64/libfmod.so.5.14
lib/FMOD/lib/linux/x86_64/libfmodstudio.so
lib/FMOD/lib/linux/x86_64/libfmodstudio.so.5
lib/FMOD/lib/linux/x86_64/libfmodstudio.so.5.14

# Mac OS X
lib/FMOD/lib/mac/libfmod.dylib
lib/FMOD/lib/mac/libfmodstudio.dylib

# Windows
lib/FMOD/lib/windows/fmod.dll
lib/FMOD/lib/windows/fmod64.dll
lib/FMOD/lib/windows/fmod64_vc.lib
lib/FMOD/lib/windows/fmod_vc.lib
lib/FMOD/lib/windows/fmodstudio.dll
lib/FMOD/lib/windows/fmodstudio64.dll
lib/FMOD/lib/windows/fmodstudio64_vc.lib
lib/FMOD/lib/windows/fmodstudio_vc.lib

Note that you don't need to download libraries for all platforms. They're only listed for sake of completeness. If you're on Mac OS or Linux, you can use tools/fmod-import-tool.sh to copy the files into place.

Android

Once you've installed both, open rainbow/tools/build-android.sh and change NDK_HOME to point at the NDK. The build script will create a debuggable and installable APK but is currently only available on Linux/Mac OS X. You can still compile for Android on Windows, it just requires some manual labour.

Follow the steps outlined earlier and specify android for platform:

$ /path/to/rainbow/tools/build.sh android [options]

iOS

Use the provided Xcode project under rainbow/build/xcode4/.

Linux (and cross-compiling for Windows)

You can install most of these using your favourite package manager.

Windows builds can be built using MinGW-w64 by issuing windows as platform. However, this method hasn't been maintained in quite some time and may no longer work.

Mac OS X

CMake and Ogg Vorbis can be installed through Homebrew or MacPorts. Xcode's Command Line Tools must be installed. SDL will be downloaded automatically by the build script.

Windows

The process of downloading and setting up OpenAL Soft and SDL is fully automated by the build scripts. Simply run the PowerShell script, tools\make.ps1, and follow the wizard. If you get a prompt about execution policy, you can simply dismiss it as the script doesn't require any special rights.

Alternatively, see "Linux" for cross-compilation.

Learning

Check out the documentation here or under doc, and the demos under demos. Note: In order to run a demo, you'll need to copy some files from lua into the folder of the demo you want to run. It's easier to copy all even if you won't need everything.

Some demos may use resources that (unfortunately) cannot be distributed with Rainbow.

Once you've copied all the necessary files, run rainbow inside the folder:

$ cd /path/to/demo
$ rainbow

Or with the path as argument:

$ rainbow /path/to/demo