Add build info to the readme

This commit is contained in:
jan-weil 2024-01-16 17:35:33 +01:00 committed by GitHub
parent 1d7fc91a7b
commit 4824499682
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 20 additions and 0 deletions

View File

@ -33,6 +33,26 @@ func play_data(data: PackedFloat32Array) -> void:
```
## Building
In order to build this project, you need scons. Currently only Windows x64 (MSVC) is supported.
1. Clone repo with submodules (godot-cpp)
```
git clone --recurse-submodules https://github.com/microtaur/godot4-opus.git && cd godot4-opus
```
2. Build debug
```
scons
```
3. Build release
```
scons target=template_release
```
More information on building GDExtensions: [https://docs.godotengine.org/pl/4.x/tutorials/scripting/gdextension/gdextension_cpp_example.html](https://docs.godotengine.org/en/stable/tutorials/scripting/gdextension/gdextension_cpp_example.html)
## Known limitations
- This is more POC than a production-ready solution although it's not too far from achieving this status. I'm using this code successfully in a scenario similar to the one presented in this demo: