Tracked Keyboard Sample (Deprecated)

Updated: Jan 23, 2025

Tracked Keyboard Deprecation

As of v72, Tracked Keyboard as a feature is being deprecated in favor of the new Generic Keyboard Tracker (available on Quest 3 and Quest 3S).

For Unity integration, we recommend using Trackables in MR Utility Kit:

Unity Trackables

Keyboard Tracking

For Native integration, please see:

Dynamic Object Tracker Documentation

This documentation is no longer being updated and is subject for removal.

This topic provides an overview of the tracked keyboard sample scene, which comes packaged with the Meta XR Core SDK. The Meta XR Core SDK is available individually or bundled as part of the Meta XR All-in-One SDK.

Follow these steps to import the sample into your Unity project:

In the Window > Package Manager menu, set the filter to My Assets.

Select Meta XR Core SDK and then on the Samples tab, click Import next to the listed samples.

On the Project tab, go to the Assets/Samples/Meta XR Core SDK/{SDK version}/Sample Scene/ folder and then open the TrackedKeyboard.unity scene. You can also look for Tracked Keyboard sample in the search field with the filter set as All.

The sample scene includes:

A visualization of the tracked keyboard

Two text fields you can type into

Keyboard status

Controls to change several properties in the OVRTrackedKeyboard prefab

The Tracked Keyboard sample scene included with the Meta XR Core SDK.

The tracked keyboard is visualized as a 3D model when your hands are far enough away from the keyboard and with passthrough when your hands are placed near. The VR representations of the keyboard match the real-world keyboard, allowing exact interaction between VR and physical keyboards.

Configure tracked keyboard

Select a text field with the controller and type on your tracked keyboard to add text.

Using your controller, you can enable and disable Tracking Enabled to start and stop tracking the keyboard. As long as it is enabled, the keyboard will be tracked even if it is disconnected and reconnected. You can enable enable or disable Connection Required, which continues tracking the keyboard’s position with cameras even when it’s powered off or disconnected.

Click Opaque Presentation and MR Presentation to choose between the two available presentation modes.

Click Select Keyboard to access system settings for selecting the current keyboard device. This tells the system which keyboard the cameras should track.

Build and run the tracked keyboard sample scene

In Project Settings > XR Plug-in Management, select Oculus on the Windows tab.

Note: ou don’t need to switch to the Windows platform in Build settings.

In your headset, enable Link and connect to your computer using either the Meta Quest Link cable or AirLink.

In Unity, click ▶ to launch the scene that you want to debug. Once your application has launched, the tracked keyboard should appear.

You can now debug your VR app in Unity as normal.

Did you find this page helpful?