This is an experimental, general purpose game engine. Its core programming language is C++, and Squirrel for scripting. I develop it as a hobby, for fun.
It is a spin-off of an earlier version called "Snowfeet Framework", with a completely new modular structure and integrated scripting.
The engine is in its early stages of development, so lots of code is WIP, unoptimized, breaking changes may occur, and the main platform I develop on/for is win32 with Visual Studio 2013. However, the engine is aimed at being cross-platform and cross-system (desktop, mobile or even web), so any platform-specific code goes in separate implementation files.
Engine structure
The engine is built upon 3 layers:
- The core, a fixed C++ library, designed to be extended
- Modules, C++ libraries you can add or remove for your needs without having to recompile everything
- Projects, folders where you put scripts, assets and data that make up your games.
For more info about how these layers work, see documentation files.
Notes
What the engine does now
Testing Oculus Rift display with engine-rendered distortion
My current focus is on the TGUI module, then scripting, rendering foundation improvements and other various things.
Features
- Oculus Rift support
- OpenGL 3.3 rendering
- Hot-reloading of assets
- Entity hierarchy
- Dynamic module system
- Multi-screens
- GUI (WIP)
- Scenes described with human-readable text files
- Javascript/Lua-like scripting (Squirrel)
- JSON-superset data format
Web export
I should try Emscripten as a new platform, one day. Sounds like fun.
Binaries
There are no pre-built binaries available. At the moment, the whole engine and its modules must be compiled with the SAME compiler, no matter which one, for compatibility reasons. Building your own binaries is the best way to fit your platform, if it is supported enough by the engine.
This is not a library
Althought there are exports and shared libraries, this project is not aimed at being a library. It's actually an "end-user" framework, based on simple libraries, just as actual applications. That's why headers and cpp files aren't separated and why everything is self-contained as much as possible (rather than dependencies supposedly setup in your build environnment).
How to compile
The whole engine is entirely provided as source code.
You will need the following to compile everything:
- A C++11 compiler
- Premake5 (See bottom of this README)
- Optionally, an IDE
- Optionally, Git
That's all, the project should work out of the box.
The premake build system is used to generate IDE solutions or makefiles. I choosed it because I know it better than Cmake, it is very small, and it uses a well-known language (Lua), which makes writing build scripts very easy.
All you have to do to obtain working project files is to run one of the scripts named "premake_xxx". For Windows, the one I mostly use is premake_vs2013_debug.bat.
Another thing to keep in mind: Never manage files and build options from IDEs, because sometimes they end up in the wrong place. You should create them by hand and re-run premake to update project files.
For any question or issues, PM me.
License
I don't have decided yet which license the engine should have, but you guessed that the core is free and open-source.
However, modules could have different licenses:
Essential ones such as graphics or sound may have the same license as the core, also depending on which third-party code they include / modified.
And obviously, because user applications will be modules, they can be private-source and/or paid if you want to.
Premake5
You can get builds of the executable here: http://premake.github.io/download.html#v5
There are also nightlies on SourceForge: http://sourceforge.net/projects/premake/files/Premake/nightlies/