Skip to content
ROKOKO Device SDK ROKOKO Device SDK

Quick Start

This guide walks through a minimal setup so you can install the SDK, verify your environment, and connect your first device.

Prerequisites

Section titled “Prerequisites”
  • A supported Windows, macOS, or Linux machine
  • A Rokoko Device SDK license
  • A terminal and build toolchain for your platform

1. Install the SDK

Section titled “1. Install the SDK”

Pick the installation method for your platform:

2. Sign in to your account

Section titled “2. Sign in to your account”

After installation, sign in to your Rokoko account using the CLI:

Terminal window
rokoko signin

This will open your default browser and prompt you to log in onb the Rokoko ID website. After signing in, you can return to the CLI to manage your devices and data.

3. Verify the installation

Section titled “3. Verify the installation”

Check that the CLI or runtime components are available:

Terminal window
rokoko doctor

This will run a series of checks to verify that the SDK is installed correctly and can access necessary system resources. If any issues are detected, the output will include guidance on how to resolve them.

4. Connect a device

Section titled “4. Connect a device”

Start your application and initialize the SDK using your project’s preferred language binding. Once initialized, discover nearby or attached devices and subscribe to state and motion updates.

5. Stream data into your app

Section titled “5. Stream data into your app”

After discovery succeeds, subscribe to the device data stream and forward events into your animation, telemetry, or gameplay systems.

Next steps

Section titled “Next steps”