Setup

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

SSH

git clone git@github.com:GodotECS/godex.git
git clone git@github.com: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.md, just in case.

2. Apply the Custom Iterator Patch

First, change into the cloned Godot repository like so:

cd godot

You have to 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

At this point everything is ready to be compiled using scons (here more additional info about how to compile Godot), Keep in mind that first-time compilation takes around 15 ~ 20 minutes!

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!

Enjoy using Godex! Don't forget to join Discord if you need any support.

⬅️ ➡️ Consult the Glossary or if you are already familiar with most of the terms jump to the next page Create Godex Project