Setup

Godex is a Godot Engine cross platform static module; compiled with the engine core to guarantee a better integration and better compiler optimization.

To compile Godot with Godex, you need to copy the Godex module in Godot and compile the engine as usual ⭐.

⭐ note the Step 3 you need to apply a patch to Godot, before be able to use Godex.

Let's do it step by step.

Godot & Godex compilation

In the following steps I'll use git submodule but you can simply copy ./godex in ./godot/modules or use the new custom module feature.

Step 1, clone godot.

cd ./your/workspace/dir
git clone https://github.com/godotengine/godot

Note: The tested Godot version is master 36c943260ed40c6e31a6ecff7f6e1674714b4fcb, please open an issue if the current master is not working or doesn't compile.

Step 2, clone Godex.

Within your just cloned Godot directory, let's add Godex as sub module.

cd ./godot
git submodule add https://github.com/AndreaCatania/godex.git modules/godex

In alternative you can just download Godex and copy its content into the Godot modules directory.

Step 3, Custom iterator patch.

To guarantee a low level integration, is necessary to add a custom iterator in Godot link to proposal.

This feature is not yet available in Godot, you can introduce it in you local branch by applying the following git patch:

# Within the godot directory
git apply modules/godex/patches/add_custom_iterator.patch

Step 4, Godot compilation.

At this point everything is ready to be compiled using scons (How To Compile Godot):

# Linux
scons platform=linuxbsd

# Windows
scons platform=windows

# Osx
scons platform=osx