C++ Game Engine (Under Construction!)
C++ HLSL Lua C Shell Perl
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.vscode fix args json type Apr 7, 2018
Core @ 7ab366f Add pch as premake option, update Core Jul 19, 2018
Dependencies update path to fbx on uac systems Apr 24, 2018
Documentation Update for renamed repo Jun 14, 2018
Projects Update Core from master Jul 17, 2018
Source Add pch as premake option, update Core Jul 19, 2018
.gitignore bump platform, add .vs/ to .gitignore Aug 5, 2017
.gitmodules Move core submodule to root, update build scripts Jul 13, 2018
.travis.before_install.linux.sh move package install guts to scripts in /Dependencies, leaving travis… Aug 8, 2017
.travis.before_install.osx.sh move package install guts to scripts in /Dependencies, leaving travis… Aug 8, 2017
.travis.yml fix premake args Jul 19, 2018
CODING.md CODING.md Jun 14, 2018
Core.lua Update Core from master Jul 17, 2018
Data.sublime-project Update Data sublime project Jan 1, 2016
Doxyfile update Doxyfile Nov 8, 2012
Helium.code-workspace add vscode workspace Apr 7, 2018
Helium.lua Add pch as premake option, update Core Jul 19, 2018
Helium.sublime-project update sublimetext project Sep 18, 2013
Info.plist Build a valid MacOSX bundle with icon and Info.plist, add premake api… Dec 29, 2013
LICENSE.md tidy up docs Jun 14, 2018
Premake.sublime-project add core-only flags, build core on travis, re-enable osx Mar 10, 2018
README.md Update for renamed repo Jun 14, 2018
Runtime.lua add core-only flags, build core on travis, re-enable osx Mar 10, 2018
Shared.lua Add pch as premake option, update Core Jul 19, 2018
Tools.lua Add pch as premake option, update Core Jul 19, 2018
autoexp.dat Update autoexp.dat Sep 4, 2011
make-all-core.sh Fix premake deprecations Mar 12, 2018
make-all.sh move generated build scripts/projects to /Build Apr 8, 2018
premake.bat Add premake submodule, migrate some straggler submodules to Helium fo… Oct 21, 2017
premake.sh switch linux and macosx to internal premake bootstrap Oct 22, 2017
premake5.lua Add pch as premake option, update Core Jul 19, 2018

README.md

Build Status

Helium Game Engine

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

Systems

Resources

Building

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

Prerequisites

All Platforms

Windows

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.