Overview
This page is your guide to the Unity plugin documentation: an overview of how everything is organised, a recommended reading path for newcomers, and direct links to every section you might need.
The Teslasuit Unity plugin provides ready-made drag-and-drop components, example scenes, and sample assets for devices, haptics, motion capture, and biometrics. No API knowledge is needed to start quickly, and for advanced work the underlying Teslasuit C# API remains fully available for custom scripting.
Reading flow#
If you're starting out, read the sections in this order. Each step links to a section overview, so this doubles as a guided tour.
- Getting started: install the SDK, import the package, add a device component, and get your first connection.
- Main concepts: the component model, and what each subsystem exposes to your scene.
- Prefabs & assets: the ready-made prefabs and asset files you drop straight into a scene.
- Examples: the shipped scenes, each working end to end on hardware.
- Reference · Core then Reference · Subsystems: the class-by-class component reference, for when you know what you want to build.
The full map#
1 · Introduction#
Set up the plugin and get oriented.
| Page | What's there |
|---|---|
| Overview (this page) | How the docs are organised and where to start. |
| Getting started | Install the SDK, import the package, add a device component, and connect. |
2 · Main concepts#
The component model, and what each subsystem does.
| Page | What's there |
|---|---|
| Overview | A per-topic reading list across every capability. |
| Component model | How you build: GameObject, device behaviour, subsystem components, your MonoBehaviour on top. |
| Haptics & EMS | Touches, playables, simplified channels, collision building, and haptic materials. |
| Mocap | Motion providers, live streaming, and human versus hand animation with retargeting. |
| PPG | Heart-rate PPG streaming. |
| Advanced development | Bootstrap, the native session, device pairing, and custom connection handling. |
3 · Reference · Core#
The layer beneath the subsystems: bootstrap, device access, assets, and shared helpers. Generated from the plugin source.
| Page | What's there |
|---|---|
| Devices | TsDeviceBehaviour, TsSuitBehaviour, and TsGloveBehaviour. |
| Core & bootstrap | TsInitializer and the TsManager root. |
| Assets | The asset base types and haptic asset ScriptableObjects. |
| Utilities | Conversion, transform, and hand-avatar helpers. |
4 · Reference · Subsystems#
One reference group per device capability. Generated from the plugin source.
| Page | What's there |
|---|---|
| Haptic | TsHapticPlayer, simplified channels, collision handlers, materials. |
| Motion capture | Motion providers and the human and hand animators. |
| Biometry | TsPpgProvider. |
5 · Prefabs & assets#
The ready-made building blocks the package ships.
| Page | What's there |
|---|---|
| Overview | What ships, and what is reusable versus reference-only. |
| Hand prefabs | The hand_l and hand_r glove mocap prefabs. |
| Haptic assets | Sample .ts_asset haptic assets, and how to play them. |
6 · Examples#
Complete example scenes, grouped by capability.
| Page | What's there |
|---|---|
| Overview | Every example scene, grouped by capability. |
| Demo launcher | The hub scene that loads each example additively. |
| Haptic animation playback | Play a .ts_asset haptic animation. |
| Playing touches | Build and play touches with CreateTouch. |
| Bone channels & collision | Drive haptics from collisions on a character. |
| Suit mocap | Full-body motion capture onto an avatar. |
| Glove mocap | Hand tracking onto a hand prefab. |
| PPG viewer | Stream and display PPG heart-rate data. |
Next: head to Getting started to install the SDK, import the package, and get your first connection.