Skip to content

Augmenta-tech/AugmentaUnityWebsocket

Repository files navigation

Augmenta WebSocket Client for Unity

Augmenta is a tracking technology to bring interactivity to immersive spaces. This package provides utilies to connect to an Augmenta Server using a WebSocket Outputand to consume the received data.

Features

This is a new Augmenta native package for Unity, which is designed to receive data from Augmenta's WebSocket output. It supports:

  • Tracking features (clusters IDs, positions, bounding boxes, speed, etc.)
  • Point Cloud streaming
  • Zone triggering and control

⚠️ This package is currently in beta and provided as is, please send feedback or contact us !

Requirement

Augmenta 1.5.0b+ OR Augmenta (new) simulator 1.5.0b+ : Augmenta new Simulator (beta)

Getting started

In Unity:

To get started, add the Augmenta Client prefab to your scene. You'll have access to websocket protocol options in the Inspector. By default, the client will connect on your localhost on the port 6060. If you press play, you'll be able to see the Augmenta scene from Unity's Scene panel.

Dependencies

Augmenta SDK

This package makes use of the Augmenta Client C# SDK.

Third party

ZstdNet websocket-sharp

License

This Unity plugin is open source under the MIT License (see LICENSE).
However, it uses the proprietary Augmenta SDK, which is not open source.
Use of the SDK is subject to the Augmenta SDK License.
You may not redistribute the SDK itself without permission from Augmenta.

Contributors 5

Languages