Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ikbencasdoei/godot-voip
godot-voip is a Godot Engine addon which makes it very easy to setup a real-time voice-chat system in your Godot game. This addon also includes a demo project.
https://github.com/ikbencasdoei/godot-voip
audio demo game-development godot godot-addon godot-voip godotengine microphone voice voice-chat voice-communication voip
Last synced: about 1 month ago
JSON representation
godot-voip is a Godot Engine addon which makes it very easy to setup a real-time voice-chat system in your Godot game. This addon also includes a demo project.
- Host: GitHub
- URL: https://github.com/ikbencasdoei/godot-voip
- Owner: ikbencasdoei
- License: mit
- Created: 2019-10-20T22:12:39.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-09-22T23:36:16.000Z (about 2 months ago)
- Last Synced: 2024-09-29T05:17:05.458Z (about 1 month ago)
- Topics: audio, demo, game-development, godot, godot-addon, godot-voip, godotengine, microphone, voice, voice-chat, voice-communication, voip
- Language: Rust
- Homepage: https://godotengine.org/asset-library/asset/425
- Size: 212 KB
- Stars: 194
- Watchers: 9
- Forks: 13
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# godot-voip 🎙️🌐
godot-voip is a [Godot Engine](https://godotengine.org/) addon which makes it very easy to setup a real-time voice-chat system in your Godot game. This addon also includes a demo project.
⚠ currently unmaintained ⚠
## Engine Compatibility
* **_Godot Engine 3.2_:** godot-voip 2.0
* **_Godot Engine 3.3+_:** godot-voip 3.0+
* **_Godot Engine 4:_** ❌unavailable❌
## Setup
### Adding to a existing project
(Any kind of high-level multiplayer peer is required.)
1. Click on the AssetLib inside editor or go to the [Godot Asset Library](https://godotengine.org/asset-library/asset/425) to download the latest release, or you can clone/download this repository to get the latest commit.
2. Select the `addons/godot-voip/` folder and move it into your Godot project.
(**Note**: make sure the structure is still `res://addons/godot-voip/`)
3. Go to project-settings/audio and enable audio input.
4. Now go to the plugins tab also inside project-settings and enable the godot-voip plugin.
5. Add either a `VoiceInstance` (one connection) or a `VoiceOrchestrator` (more than 2 participants) node to your scene.
6. Set `$VoiceInstance.recording` or `$VoiceOrchestrator.recording` to `true` and it will send your microphone input to connected participants.
### Running demo
1. Go to the templates tab in the Godot Engine project manager and look for godot-voip, or go to the [Godot Asset Library](https://godotengine.org/asset-library/asset/951) to manually download the latest release, or you can clone/download this repository to get the latest commit.
2. Open and run downloaded project.
### For macOS users
Users running godot-voip on macOS need to make sure the microphone format in macOS audio settings is equal to the mix-rate in Godot project-settings.
## GDNative
Some parts of this library have been ported to [gdnative-rust](https://godot-rust.github.io/) to improve performance and to implement compression using the [opus-codec](https://opus-codec.org/) and other audio processing. To use the gdnative implementation use the `NativeVoiceInstance` node instead of the usual `VoiceIntance`.
### Building
To compile the gdnative parts of this library you will need **Rust** installed on your machine: https://www.rust-lang.org/. Then open `addons/gdnative/` in your terminal and run `cargo build`. You'll find the compiled binary in `target/`. Then add the compiled binary to your platform in the godot-voip gdnative library called `godot-voip-native.tres` also found in the gdnative directory.
## Todo
- [ ] Implement audio compression.
# Documentation
## VoiceInstance 
This node implements a single voice connection.
### Signals
* `received_voice_data(data: PoolRealArray, from_id: int)` Emitted when voice data is received.
* `sent_voice_data(data: PoolRealArray)` Emitted when recording and data is sent.
### Properties
| Type | Name | description |
| ---------- | -------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| `NodePath` | custom_voice_audio_stream_player | When used, the referenced `AudioStreamPlayer`/`AudioStreamPlayer2D`/`AudioStreamPlayer3D` will be used as output for incoming audio data. |
| `bool` | recording | If true, the VoiceInstance will process and send microhphone audio to the other VoipInstance. |
| `bool` | listen | If true, the VoiceInstance will also play any microhphone data it records. |
| `float` | input_threshold | Value above which microhphone data will be sent. Set to `0` to disable. |
## NativeVoiceInstance 
This node implements a single voice connection using rust-gdnative.
### Signals
* `received_voice_data(data: PoolRealArray, sender_id: int)` Emitted when voice data is received.
* `sent_voice_data(data: PoolRealArray)` Emitted when recording and data is sent.
### Properties
| Type | Name | description |
| ---------- | -------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| `NodePath` | custom_voice_audio_stream_player | When used, the referenced `AudioStreamPlayer`/`AudioStreamPlayer2D`/`AudioStreamPlayer3D` will be used as output for incoming audio data. |
| `bool` | recording | If true, the NativeVoiceInstance will process and send microhphone audio to the other NativeVoiceInstance. |
| `bool` | listen | If true, the NativeVoiceInstance will also play any microhphone data it records. |
| `float` | input_threshold | Value above which microhphone data will be sent. Set to `0` to disable. |
## VoiceOrchestrator 
This node implements multiple voice connections. It will automatically spawn new VoiceInstances when a player connects to the server and will remove them again after they disconnect.
### Signals
* `received_voice_data(data: PoolRealArray, from_id: int)` Emitted when voice data is received.
* `sent_voice_data(data: PoolRealArray)` Emitted when recording and data is sent.
* `created_instance(id: int)` Emitted when a new `VoiceInstance` is created.
* `removed_instance(id: int)` Emitted when a `VoiceInstance` is removed.
### Properties
| Type | Name | description |
| ------- | ------------------- | -------------------------------------------------------------------------------------------- |
| `bool` | recording | If true, the VoiceInstance will process and send microhphone data to the other VoipInstance. |
| `bool` | listen | If true, the VoiceInstance will also play any microhphone data it records. |
| `float` | input_threshold | Value above which microhphone data will be sent. Set to `0` to disable. |
| `enum` | type_voice_instance | Type of VoiceInstance used. `NATIVE, GDSCRIPT` |
**VoiceOrchestrator does not support a custom `AudioStreamPlayer`.**