Helium aspires to be a fully-featured open-source game engine:

• Permissively licensed (BSD-style)
• Designed to scale to desktop, console, and mobile
• Utilize familiar industry-standard DCC user interface and usability design
• Import content using production proven interchange formats (like FBX)

Documentation

Introductions

• History
• Architecture
• Organization

Systems

• AssetLoader
• Components

Resources

• Website: http://heliumproject.github.io
• GitHub: http://github.com/HeliumProject/Engine
• Slack: http://heliumproject.slack.com (ask @gorlak for an invite)

Building

Helium is built using premake5. Premake interprets lua script and generates platform-specific IDE project files.

Prerequisites

All Platforms

• FBX SDK 2016.1.2

Windows

• Visual Studio 2015
• DirectX SDK

OSX

XCode Command Line Tools (install from within XCode preferences):

xcode-select --install

Prerequisites can be installed via:

sudo Dependencies/install-packages-macos.sh

Linux

GCC 6

Prerequisites can be installed via:

sudo Dependencies/install-packages-linux.sh

Compile

First, grab our source tree from git and ensure that you fetch all the submodules by doing:

git submodule update --init --recursive

Next, generate the project files using premake. An appropriate build of premake is includedin the repository.

On Windows, generate Visual Studio 201x projects (replace 201x with your desired version):

cd Dependencies
..\premake vs2015
start Build\Dependencies.sln

cd ..
premake vs2015
start Build\Helium.sln

On OSX and Linux, use premake to generate makefiles (Xcode support inside premake is on hold as of late):

cd Dependencies/Build
../premake.sh gmake
make -j8

cd ../Build
./premake.sh gmake
make -j8

Caveats

• On OSX you may get a dependency check error about your FBX SDK containing spaces, to work around it just make a symlink without spaces and set the FBK_SDK environment variable. See mklink and export (amending your .bash_profile file) for help setting those up.