Skip to content

Commit b61aaac

Browse files
Update README (#136)
- Replace links to Wiki tutorials with the new version for 24.1. - Add an image of the Godot Editor with Wwise integrated at the top (it looks cool!). - Update the features list to include new features. - Rephrase some sentences for improved clarity.
1 parent 409258a commit b61aaac

File tree

1 file changed

+17
-14
lines changed

1 file changed

+17
-14
lines changed

README.md

+17-14
Original file line numberDiff line numberDiff line change
@@ -4,30 +4,33 @@
44

55
Welcome! This repository provides an integration of [Audiokinetic's Wwise audio middleware](https://www.audiokinetic.com/products/wwise/) into [Godot Engine](https://godotengine.org) 4.3. At the moment, Wwise version 2024.1 is supported. Older versions can be downloaded in the releases section of the repository.
66

7+
<img src="https://github.com/user-attachments/assets/e0a3dd1c-36de-4a9a-ad14-c6fe18303f90" width="720">
8+
79
## Features
810

911
* [GDExtension](https://docs.godotengine.org/en/stable/tutorials/scripting/gdextension/what_is_gdextension.html)-based Wwise wrapper library for Windows, macOS, Linux, Android and iOS.
10-
* Multi-platform build with SCons for Wwise and Wwise Authoring API wrappers. Visual Studio 2022 solution provided for Windows development.
11-
* Wwise profiler connection available in GDExtension debug builds.
12+
* Multi-platform builds with SCons (Windows, macOS, Linux, iOS) and Gradle/CMake (Android). A Visual Studio 2022 solution is provided for Windows development.
13+
* Wwise profiler connection available in GDExtension debug and profile builds.
1214
* Stream manager uses the default blocking I/O implementation and it can be extended to use custom I/O devices.
13-
* Custom Godot nodes: AkEvent3D, AkEvent2D, AkBank, AkListener3D, AkListener2D, AkState, AkSwitch, AkEnvironment, AkGeometry, AkRoom, AkPortal, AkEarlyReflections.
14-
* Event callbacks exposed as Signals in AkEvent nodes.
15-
* WAAPI picker for querying Wwise projects, generating soundbanks from Godot's editor.
16-
* C++ to GDScript Wwise IDs converter tool embedded in WAAPI Picker.
17-
* Configurable per-platform Wwise settings in Godot editor.
18-
* Support for spatial audio API.
19-
* Compatibility with Wwise plug-ins.
20-
15+
* Custom Godot Nodes: AkEvent3D, AkEvent2D, AkBank, AkListener3D, AkListener2D, AkState, AkSwitch, AkEnvironment, AkGeometry, AkRoom, AkPortal, AkEarlyReflections.
16+
* Wwise Types: WwiseAcousticTexture, WwiseAuxBus, WwiseBank, WwiseEvent, WwiseRTPC, WwiseState, WwiseSwitch, WwiseTrigger.
17+
* Support for Auto-Defined SoundBanks.
18+
* Event Callbacks exposed as Signals in AkEvent Nodes.
19+
* Wwise Browser: Query the integrated Wwise project and generate SoundBanks directly in the editor.
20+
* A Wwise IDs generator tool is embedded in the Wwise Browser.
21+
* Per-platform Wwise configurations in the Godot Project Settings.
22+
* In-engine documentation: quick access to reference materials and code snippets in the Godot Editor
23+
* Plugin Support: Plugin detection and export across all platforms, including custom plugin support.
2124

22-
## Getting started
25+
## Getting Started
2326

24-
If you are a game developer that would like to integrate Wwise into your Godot project, go to the [releases](https://github.com/alessandrofama/wwise-godot-integration/releases) page to download the addon and read the [getting started](https://github.com/alessandrofama/wwise-godot-integration/wiki/Getting-Started-(4.0)) guide.
27+
If you're a game developer who wants to integrate Wwise into your Godot project, go to the [Releases](https://github.com/alessandrofama/wwise-godot-integration/releases) page to download the integration and check out the [Getting Started](https://github.com/alessandrofama/wwise-godot-integration/wiki/Getting-Started-(24.1)) guide.
2528

26-
If you would like to modify the code of the GDExtensions or build them yourself, go to the [Building tutorial](https://github.com/alessandrofama/wwise-godot-integration/wiki/Building-the-GDExtension-Library) for build instructions.
29+
If you would like to modify the GDExtension code or build it yourself, refer to the [Building the GDExtension Library tutorial](https://github.com/alessandrofama/wwise-godot-integration/wiki/Building-the-GDExtension-Library-(24.1)) for detailed build instructions.
2730

2831
## Documentation
2932

30-
The docs for the GDExtensions interfaces, custom nodes and addons can be accessed through the [wiki](https://github.com/alessandrofama/wwise-godot-integration/wiki).
33+
Documentation for the GDExtension interfaces is available on the [wiki](https://github.com/alessandrofama/wwise-godot-integration/wiki).
3134

3235
## Known issues
3336

0 commit comments

Comments
 (0)