Skip to content

alessandrofama/wwise-godot-integration

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Wwise Godot Integration

Build Discord

Welcome! This repository provides an integration of Audiokinetic's Wwise audio middleware into Godot Engine 4.3. At the moment, Wwise version 2024.1 is supported. Older versions can be downloaded in the releases section of the repository.

Features

  • GDExtension-based Wwise wrapper library for Windows, macOS, Linux, Android and iOS.
  • Multi-platform builds with SCons (Windows, macOS, Linux, iOS) and Gradle/CMake (Android). A Visual Studio 2022 solution is provided for Windows development.
  • Wwise profiler connection available in GDExtension debug and profile builds.
  • Stream manager uses the default blocking I/O implementation and it can be extended to use custom I/O devices.
  • Custom Godot Nodes: AkEvent3D, AkEvent2D, AkBank, AkListener3D, AkListener2D, AkState, AkSwitch, AkEnvironment, AkGeometry, AkRoom, AkPortal, AkEarlyReflections.
  • Wwise Types: WwiseAcousticTexture, WwiseAuxBus, WwiseBank, WwiseEvent, WwiseRTPC, WwiseState, WwiseSwitch, WwiseTrigger.
  • Support for Auto-Defined SoundBanks.
  • Event Callbacks exposed as Signals in AkEvent Nodes.
  • Wwise Browser: Query the integrated Wwise project and generate SoundBanks directly in the editor.
  • A Wwise IDs generator tool is embedded in the Wwise Browser.
  • Per-platform Wwise configurations in the Godot Project Settings.
  • In-engine documentation: quick access to reference materials and code snippets in the Godot Editor
  • Plugin Support: Plugin detection and export across all platforms, including custom plugin support.

Getting Started

If you're a game developer who wants to integrate Wwise into your Godot project, go to the Releases page to download the integration and check out the Getting Started guide.

If you would like to modify the GDExtension code or build it yourself, refer to the Building the GDExtension Library tutorial for detailed build instructions.

Documentation

Documentation for the GDExtension interfaces is available on the wiki.

Known issues

The known issues are being logged into the issues page of this repo. Please check this page first, then log a new issue if you haven't found it listed.

Contributing

Any contribution is welcome. Please send pull-requests with fixes or additions!

License

Audiokinetic offers a free Wwise license for indie developers. For detailed licensing information, visit https://www.audiokinetic.com/en/pricing/.

The licensing details for integration files, code, and scripts within this repository can be found here.