repository·master·Indexed 21 days ago
https://github.com/utopia-rise/fmod-gdextensionA Godot 4 GDExtension that integrates the FMOD Studio API into the Godot Engine. It provides dedicated nodes for event emission and listening (FmodEventEmitter2D/3D, FmodEventListener2D/3D), seamless bank loading, and live updating. The extension exposes the majority of FMOD Studio API functions to GDScript via the FmodServer singleton, allowing developers to manage banks, event instances, and global parameters.
To follow the standard project structure, place your FMOD libraries in a libs folder that is a sibling to the fmod-gdextension repository. The hierarchy should look like this:
└── Project root
├── libs
| └── fmod
| └── {platform}
| └── [platform specific fmod api]
└── fmod-gdextension
├── SConstruct
├── godot-cpp (submodule)
└── srcFmodServer singleton is the core component of the plugin. It acts as the central bridge to the FMOD API, enabling programmatic control over audio behavior. While nodes provide convenience, FmodServer provides the underlying power and access to FMOD's system-level capabilities.This GDExtension exposes the majority of the FMOD Studio API functions directly to Godot's GDScript. It also includes high-level helpers for common tasks, such as:
Language Support Note:
The FMOD GDExtension plugin provides two distinct ways to integrate FMOD into your Godot project depending on your needs:
FmodServer API: Use the FmodServer singleton for direct access to FMOD's core and system APIs. This is intended for advanced or highly customized workflows that require low-level control.Note that all FMOD nodes are built on top of the FmodServer singleton.
The extension provides specialized nodes to simplify audio implementation in Godot scenes or via GDScript. These nodes handle the attachment of FMOD Studio events to Godot objects and manage positional audio.
Available nodes include:
FmodEventEmitter2DFmodEventEmitter3DFmodEventListener2DFmodEventListener3DProgrammer callbacks allow FMOD to trigger logic in your game to provide audio data (like dialogue) from an external bank/audio table.
set_programmer_callback.event_emitter.set_programmer_callback("welcome") # "welcome" is the key in the loaded bankFmodServer.load_bank("res://assets/Banks/Dialogue_EN.bank", FmodServer.FMOD_STUDIO_LOAD_BANK_NORMAL)
var event_instance = FmodServer.create_event_instance("event:/Character/Dialogue")
event_instance.set_programmer_callback("welcome")
event_instance.start()# Programmer callback example with FmodServer
FmodServer.load_bank("res://assets/Banks/Dialogue_EN.bank", FmodServer.FMOD_STUDIO_LOAD_BANK_NORMAL)
var event_instance = FmodServer.create_event_instance("event:/Character/Dialogue")
event_instance.set_programmer_callback("welcome")
event_instance.start()After adding the FMOD addon to your Godot project, you must configure the FMOD parameters within the project settings. The General category controls core engine behavior:
true, FMOD starts automatically when the engine starts.Channel objects (virtual voices) available. Virtual voices allow for high-count playback with minimal overhead by mixing a subset of 'real' voices based on priority and audibility.FMOD_INIT_MEMORY_TRACKING). This increases memory footprint and impacts performance. Use Studio::Bus::getMemoryUsage and Studio::EventInstance::getMemoryUsage to access these stats.true, FMOD nodes will load events and parameters using their string names instead of their IDs.Once the files are in your addons folder, you must enable the plugin within the Godot editor:
FMOD GDExtension and check the box to enable it.After activation, you can create FMOD nodes, use the bank explorer, and access the FmodServer via scripts.
To use FMOD on Android, you must follow these steps:
Use Gradle Build option is activated.Important Limitations:
armv8 architecture is supported for Android exports.x86 architecture, you must build the plugin manually.Fmod Explorer tool to browse and explore the banks included in your project.The FmodEventEmitter2D and FmodEventEmitter3D nodes are the primary way to play FMOD events within the Godot scene tree. You can assign an event using its name or GUID.
attached: If true, the event's position updates with the node's position.autoplay: If true, the event plays automatically when the node is ready.auto_release: If true, the emitter node is automatically freed when the event finishes.allow_fadeout: If true, the event fades out when stop() is called.preload_event: If true, the event is preloaded when the node is ready.play(restart_if_playing: bool = true): Starts the event. If restart_if_playing is true, it restarts the event if it is already playing.play_one_shot(): Starts a one-shot instance of the event that is not managed by the emitter (ideal for short SFX).stop(): Stops the event.set_event_name(name: String) / set_event_guid(guid: String): Changes the event. These methods stop and unload the current event and clear parameter values. If preload_event is true, the new event is preloaded; if autoplay is true, it is also played.# Example of setting up an emitter in code
var event_emitter = FmodEventEmitter2D.new()
event_emitter.event_guid = "{9aa2ecc5-ea4b-4ebe-85c3-054b11b21dcd}"
event_emitter.autoplay = true
add_child(event_emitter)By default, the build system expects FMOD libraries to be located in a libs/fmod/{platform} directory relative to the project root. If your libraries are located elsewhere, you can override this by passing the fmod_lib_dir argument to scons.
scons platform=windows arch=x86_64 target=editor fmod_lib_dir=libs/