https://github.com/4players/odin-sdk-unity

Unity integration plugin to add 4Players ODIN technology into your game
https://github.com/4players/odin-sdk-unity

chat cross-platform ingame integration sdk spatial-audio unity voice voip

Last synced: 6 days ago
JSON representation

Unity integration plugin to add 4Players ODIN technology into your game

• Host: GitHub
• URL: https://github.com/4players/odin-sdk-unity
• Owner: 4Players
• License: mit
• Created: 2021-09-06T10:06:00.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-11-13T17:07:59.000Z (about 1 month ago)
• Last Synced: 2024-11-13T18:20:47.423Z (about 1 month ago)
• Topics: chat, cross-platform, ingame, integration, sdk, spatial-audio, unity, voice, voip
• Language: C#
• Homepage: https://www.4players.io
• Size: 20.3 MB
• Stars: 4
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 4Players ODIN Unity SDK

ODIN is a cross-platform software development kit (SDK) that enables developers to integrate real-time chat technology into multiplayer games, apps and websites.

The ODIN package for Unity adds real-time VoIP communication to your game, thus making it more social and interactive, while increasing the immersion of the experience for your players.

[Online Documentation](https://www.4players.io/developers/)

## Prerequisites

- Unity 2019.4 or any later version

This Unity version was chosen as it is Long Term Supported and provides compatibility with all targeted platforms.

**Note**: WebGL is not natively supported. To integrate ODIN with your WebGL builds, use our [JavaScript/TypeScript SDK](https://www.npmjs.com/package/@4players/odin).

## Installation

The package can be installed in multiple ways.

### Unity Package

Please download the latest version of the ODIN Unity SDK as a `.unitypackage` from the [Github releases](https://github.com/4Players/odin-sdk-unity/releases) page. Just double-click the `.unitypackage` to import it into your current Unity editor project.

### Package Manager

Using the Package Manager will ensure that all dependencies are set up correctly and that you will have the most up to date version of the SDK. In most cases, using the Package Manager is the way to go.

To open the Package Manager, navigate to `Window` and then click `Package Manager` in your Unity Editor menu bar.

#### Using a Git Repository

Click the + button in the upper left and select `Add package from git URL`. Next, enter this URL and hit enter to import the package:

[https://github.com/4Players/odin-sdk-unity.git](https://github.com/4Players/odin-sdk-unity.git)

#### Using a Tarball Archive

Click the + button in the upper left and select `Add package from tarball`. Next, select the odin.tgz archive you've downloaded from the [Github releases](https://github.com/4Players/odin-sdk-unity/releases) page to import the package.

## Samples

We ship a sample package with the Unity SDK, which contains several examples and a demo scene. To import it into your project, open the Package Manager and hit import on on the `*`Examples` package.

### Usage

The base Prefab Asset is available at `Packages/io.fourplayers.odin/Runtime/OdinManager.prefab` and Script accessibility with the `OdinHandler` class.

## Troubleshooting

Contact us through the listed methods below to receive answers to your questions and learn more about ODIN.

### Discord

Join our official Discord server to chat with us directly and become a part of the 4Players ODIN community.

[![Join us on Discord](https://developers.4players.io/images/join_discord.png)](https://4np.de/discord)

### Twitter

Have a quick question? Tweet us at [@4PlayersBiz](https://twitter.com/4PlayersBiz) and we’ll help you resolve any issues.

### Email

Don’t use Discord or Twitter? Send us an [email](mailto:[email protected]) and we’ll get back to you as soon as possible.