Meta Developers

This page provides a guide to help you quickly get started using the Tracked Keyboard packaged with the Meta XR Core SDK for Unity, which is available individually or bundled as part of the Meta XR All-in-One SDK.

Prerequisites

To get started with tracked keyboards, you need the following:

An Meta Quest 2, Quest Pro, or Quest 3 headset with Meta Horizon OS before V72,
One of the keyboards listed on the Tracked Keyboards for Meta Quest support page.
Unity 2021 LTS or later with Android build support enabled.
Meta XR All-in-One SDK before V72, or Meta XR Core SDK before V72 as a standalone package.

Use the latest version of the Meta Quest operating system and Meta XR Core SDK before starting with tracked keyboard. To verify this, do the following:

In the headset, go to Settings > System > Software Update.
Check the version.
If the version is not v37 or later, update the software to the latest available version.

Keyboard Tracking Setup

As mentioned in the Prerequisites section, Meta Quest supports tracking of a limited number of keyboard models. Use one of the supported keyboards.

Put the keyboard into pairing mode.
In the headset, go to Settings > Devices > Bluetooth and select Pair.
Select the tracked keyboard from the list of available devices. If the keyboard is not listed, make sure it is not connected to any other device such as your computer.
Using the tracked keyboard, type the pairing code and then press Return/Enter. The See Your Keyboard in VR dialog will appear once the keyboard is paired with the headset.
Select OK and restart the headset to finish.

To set up your keyboard for tracking in VR using a remote desktop application instead of a Bluetooth connection to the device, follow these steps:

In the headset, go to Settings > Keyboards > Remote Keyboards and select Edit.
Select the tracked keyboard from the list of supported models.

The keyboard should now appear in VR. If you place your hands on or close to the top of the keyboard, you will see your hands in passthrough. If you do not, ensure there is good lighting and the keyboard is set against a contrasting surface.

Apply Basic Settings

To ensure your app builds correctly, set up the following basic settings for new projects. If you have an existing project built with the Meta XR Core SDK or submitted to Meta Store, these settings are likely already applied.

Preview the Physical Tracked Keyboard

The Meta XR Core SDK package includes a sample scene that you can build and run on the headset with a few settings. Preview the paired keyboard using this scene. The Meta XR Core SDK can be installed as part of the Meta XR All-in-One SDK or as an individual SDK.

To import the sample scene, go to Windows on the menu > Package Manager. Filter packages to show My Assets. Select Meta XR Core SDK and then on the Samples tab, click Import to download sample scenes and mixed reality samples.

On the Project tab, open the TrackedKeyboard scene by following this folder path: Assets/Samples/Meta XR Core SDK/{SDK version}/Sample Scene/TrackedKeyboard.unity.
On the Hierarchy tab, select OVRCameraRig to open the Inspector tab.
On the Inspector tab, go to OVR Manager > Quest Features, and then on the General tab, do the following:
1. In the Hand Tracking Support list, select Controllers and Hands.
2. In the Tracked Keyboard Support list, select Required.
3. In the Passthrough Support dropdown list, select Supported.
4. Under Insight Passthrough, enable the Enable Passthrough checkbox.
On the File menu, go to Build Settings, and then drag the scene in the Scenes in Build section.
In the Run Device list, select the headset. For more information, go to the Enable Headset for Debugging and Testing topic.
Click Build and Run, and then when the APK file is compiled, put on the headset and preview the keyboard.
Check the connection status that is displayed in the app and test the keyboard by typing text.

Did you find this page helpful?