GDExtension Custom AudioStream

This repository provides an example of defining a custom AudioStream for Godot 4.2 with its GDExtension system. It is based on the Custom AudioStreams tutorial for Godot modules. The template for the GDExtension mechanism is paddy-exe's excellent GDExtensionSummator. Have a look at that project for more details about GDExtension, debugger usage...

Cloning the Extension

Since this project includes godot-cpp as a submodule, you'll have to clone it with git clone --recurse-submodules.

Using the Extension

After building the extension successfully (see below), open game/project.godot in Godot Project Manager, and run it. You'll hear a generated sine wave being played.

Building the Extension

VSCode Compilation (only applicable if you are using VSCode as your code editor)

For the initial build you can run the vscode task initial-build-extension. This compiles both godot-cpp and the extension. For all subsequent builds, you only need to run the task build-extension.

Manual Compilation

To compile the extension you need to follow these steps:

1. Make sure you cloned the extension recursively as described above

2. Go to the top level of the project

cd gdextension-custom-audiostream

3. Compile the extension

scons # this will use the default values such as target=template_debug