Setup - reeseschultz/godex GitHub Wiki

Godex is a cross-platform static module for Godot; this module can be compiled with the engine's core to guarantee better integration and compiler optimization. This page will show you how.

1. Clone Godex & Godot

In your shell, cd into your preferred workspace directory.

Then, you can either clone the Godex and Godot repositories with SSH, or HTTPS. Choose whichever you prefer:

SSH

git clone [email protected]:GodotECS/godex.git
git clone [email protected]:godotengine/godot.git

HTTPS

git clone https://github.com/GodotECS/godex.git
git clone https://github.com/godotengine/godot.git

Note: As you would be cloning the latest version of Godot on its master branch, please open an issue if it doesn't compile. The last tested, working version of Godex-compatible Godot is specified in the README, just in case.

2. Apply the Custom Iterator Patch

First, change into the cloned Godot repository like so:

cd godot

You must then patch Godot's core to support a custom iterator (see the proposal that would add this feature to Godot).

Here's how:

git apply ../godex/patches/add_custom_iterator.patch --reject --ignore-space-change --ignore-whitespace

3. Compile Godex & Godot

(Keep in mind that first-time compilation takes a while!)

Linux

scons -j$(nproc) platform=linuxbsd target=release_debug custom_modules="../godex"

Windows

scons platform=windows target=release_debug custom_modules="../godex"

MacOS

scons platform=osx target=release_debug custom_modules="../godex"

4. You're done!

Now you're ready to contribute to Godex, and/or create a new Godex project!