Skip to main content

Getting Started

Official documentation on GDExtensions can be found here.

Self-built​

The SDK contains several scripts for building the SDK with scons. They are also provided below for reference:

Windows​

Build debug​

build-win.bat

scons platform=windows use_static_cpp=False

Build release​

build-win-release.bat

scons platform=windows use_static_cpp=False target=template_release

Clean​

clean-win.bat

scons --clean

Mac​

Build debug​

build-mac.sh

scons platform=macos

Build release​

build-mac-release.sh

scons platform=macos target=template_release

Clean​

clean-mac.sh

scons --clean

Pre-built​

Building the GDExtension is only required in order to contribute to, or modify, the Godot SDK for Inworld.ai. To utilize the GDExtension without modification, simply download the release .zip from the latest release: https://github.com/inworld-ai/inworld-godot-sdk/releases/

Installation​

Extract the .zip file to your Godot project directory.

Edit the .godot file in this directory, and add or modify to include the following:

[native_extensions]

paths=["res://addons/inworld/inworld.gdextension"]