https://github.com/oparisy/gdextension-custom-audiostream

Example GDExtension providing a custom AudioStream (Godot 4)
https://github.com/oparisy/gdextension-custom-audiostream

Last synced: about 1 month ago
JSON representation

Example GDExtension providing a custom AudioStream (Godot 4)

• Host: GitHub
• URL: https://github.com/oparisy/gdextension-custom-audiostream
• Owner: oparisy
• License: mit
• Created: 2023-08-26T16:01:55.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-01-04T16:25:51.000Z (11 months ago)
• Last Synced: 2024-01-04T17:37:32.972Z (11 months ago)
• Language: C++
• Homepage:
• Size: 25.4 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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](https://docs.godotengine.org/en/stable/contributing/development/core_and_modules/custom_audiostreams.html) tutorial for Godot modules.

The template for the GDExtension mechanism is paddy-exe's excellent [GDExtensionSummator](https://github.com/paddy-exe/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

```bash

cd gdextension-custom-audiostream

```

3. Compile the extension

```bash

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

```