Work in progress. These docs are new and are likely missing a lot of info. If you notice something wrong or missing, open an issue. PRs are welcome as well.

Get the code

To use the editor without building it, download a prebuilt build for Windows, macOS or Linux from the download page. Clone the repo to build the engine yourself, change it, or build for the web, Android or iOS.

Clone the repo

Hyperion pulls in a few libraries as Git submodules (Jolt, zlib, xatlas, meshoptimizer, ...), so clone with --recursive:

git clone --recursive https://github.com/HyperionGameTech/HyperionEngine.git

You'll land on the dev branch, which is where all the day-to-day work happens.

If you cloned without --recursive

Run this from the repo root:

git submodule update --init --recursive

Improve this page on GitHub