Skip to content


Subversion checkout URL

You can clone with
Download ZIP
This is the development repo of Moai SDK. Current, but not necessarily tested or stable.
C++ Java Lua Objective-C++ CMake Shell Other
Latest commit ff876f6 @ConghuZhao ConghuZhao Version Increment
Failed to load latest commit information.
3rdparty-android Merge branch 'feature/android-studio' into develop-casinowonders
3rdparty removed spine; added fixes for batching indexed prims
ant added web support to android; fixed android build
bin pito lives!
cmake Merge branch 'remotes/develop-community' into develop
docs pito lives!
host-templates Merge pull request #1146 from seclorum/develop
hosts Fixed ignore
lib Fixed ignore
samples-legacy added method to get info about a virtual file system path and file co…
samples sample that rips a deck item to an image and generates an SDF; tweaks…
src removed #include <png.h> from MOAIImage.cpp (now should be exclusivel…
test fixed merge conflicts; updates xcode projects (ios and osx)
util Version Increment
vs2008 restored IDE projects
vs2010 restored IDE projects
xcode splitting up iOS build scripts for better job distribution across the…
.gitattributes set gitattributes to correctly identify text files
.gitignore put lib/ back into .gitignore
.gitmodules added civetweb as a submodule; upgraded jansson to 2.7
.travis.yml undoing travis changes Add clause about merging master into development collect notes about tool dependencies
appveyor.yml try to speed up build by skipping cmake install and debug build
circle.yml circle ci warning about bad project was too loud. revert
version.txt Organize files

Welcome to Moai!

Thanks for checking out the Moai source code. Here's the scoop.

Linux CI: Build Status OSX CI: Build Status


Moai SDK is an open source game framework for quickly developing great mobile games.

You can work in Lua or C++, and Moai SDK runs on multiple platforms including iOS, Android, Chrome, Windows, Mac and Linux.


Please clone the source in the following way.

git clone
cd moai-dev
git submodule init
git submodule update


Tools needed to build the MOAI SDK.

The following tools are required to build the API documentation.

On Mac OSX some tools need to be installed with homebrew:

$ brew install xctool ios-sim cmake

cmake needs to be 3.3 on osx

On Mac OSX, Linux and Windows, Android studio version should be 1.4+ and Android ndk can be r10e+

Please set the following environment variables.


export MOAI_BIN=<install_path>/moai-dev/release/osx/host-sdl/bin
export MOAI_CONFIG=<install_path>/moai-dev/samples/config


export MOAI_BIN=<install_path>/moai-dev/release/linux/host-sdl/x64/bin
export MOAI_CONFIG=<install_path>/moai-dev/samples/config


set MOAI_BIN=<install_path>\moai-dev\release\win32\host-sdl\bin
set MOAI_CONFIG=<install_path>\moai-dev\samples\config

Build Hosts

Please build according to the following procedure.

Windows Host

cd moai-dev

OSX Host

# Build
cd moai-dev

# Run
cd <sample_directory>
$MOAI_BIN/moai main.lua

iOS Host

cd moai-dev
./bin/ <lua_dir>

Linux Host

# Build
cd moai-dev

# Run
$MOAI_BIN/moai main.lua

Android Host

# Build
export ANDROID_NDK=<path_to_android_ndk>
cd moai-dev

# Edit Setting
cd release/android/host

# Run


export EMSCRIPTEN_HOME=<path_to_emscripten_1.7.1>
cd moai-dev

<http-serve> cmake/build/host-template/www

#see src\host-html\ for more info

Create IDE Projects

Visual Studio

Execute create-projects-win.bat in moai-dev\bin. By default, this creates a Visual Studio 2012 solution in moai-dev\cmake\projects\vs2012. To generate project files for a different version of Visual Studio, specify your desired version (vs2008, vs2010, vs2012, or vs2013) as a command-line argument.


open cmake/projects/moai-ios/moai.xcproj


open cmake/projects/moai-osx/moai.xcproj

Sample code

Go to the samples folder, which contains dozens of samples that can be run using one the hosts located in ant (Android), xcode (OSX and iOS), or Visual Studio (Windows).

One of our priorities is to build richer samples for Moai developers, so if you'd like to see a particular code sample, let us know by posting in the Moai forums.


This SDK uses the CPAL license. Refer to the for attribution screens to include with games made with Moai.



Moai Pages




Something went wrong with that request. Please try again.