https://github.com/HeliumProject/Engine
C++ Game Engine (Under Construction!)
https://github.com/HeliumProject/Engine
Last synced: about 2 months ago
JSON representation
C++ Game Engine (Under Construction!)
- Host: GitHub
- URL: https://github.com/HeliumProject/Engine
- Owner: HeliumProject
- License: other
- Created: 2010-10-04T23:13:39.000Z (over 14 years ago)
- Default Branch: master
- Last Pushed: 2023-04-16T18:46:16.000Z (about 2 years ago)
- Last Synced: 2024-05-21T17:13:08.205Z (12 months ago)
- Language: C++
- Homepage: http://heliumproject.org/
- Size: 102 MB
- Stars: 438
- Watchers: 72
- Forks: 70
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- AwesomeCppGameDev - Engine
README
[](https://travis-ci.org/HeliumProject/Engine)
[](https://ci.appveyor.com/project/GeoffEvans/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
* [History](Documentation/Intro-History.md)
* [Architecture](Documentation/Intro-Architecture.md)
* [Organization](Documentation/Intro-Organization.md)
Systems
* [AssetLoader](Documentation/System-AssetLoader.md)
* [Components](Documentation/System-Components.md)
# Resources #
* Website: [http://heliumproject.github.io](http://heliumproject.github.io)
* GitHub: [http://github.com/HeliumProject/Engine](http://github.com/HeliumProject/Engine)
* Slack: [http://heliumproject.slack.com](http://heliumproject.slack.com) (ask @gorlak for an invite)
# Building #
Helium is built using [premake5](https://github.com/premake). Premake interprets lua script and generates platform-specific IDE project files.
## Prerequisites ##
#### All Platforms ####
* [FBX SDK 2016.1.2](https://www.autodesk.com/developer-network/platform-technologies/fbx-sdk-2016-1-2)
#### Windows ####
* [Visual Studio 2015](http://www.visualstudio.com)
* [DirectX SDK](https://www.microsoft.com/en-us/download/details.aspx?id=6812)
#### OSX ####
[XCode](https://developer.apple.com/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](https://gcc.gnu.org/gcc-6/changes.html)
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.