Oculus Go Development

On 6/23/20 Oculus announced plans to sunset Oculus Go. Information about dates and alternatives can be found in the Oculus Go introduction.

Oculus Quest Development

All Oculus Quest developers MUST PASS the concept review prior to gaining publishing access to the Quest Store and additional resources. Submit a concept document for review as early in your Quest application development cycle as possible. For additional information and context, please see Submitting Your App to the Oculus Quest Store.

Enable Keyboard Overlays for Text Input with Unreal Engine

The Quest system shows an on-screen system keyboard when a text field in Oculus Home receives focus. For example, the keyboard overlays Oculus Home when a user selects the search option.

You can also display the system keyboard on top of your apps to enable user text entry with a familiar and consistent interface. The keyboard overlay provides the same set of capabilities that you see in the system keyboard displayed by Oculus Home including voice dictation, smartphone input, and multiple language layouts. Note that the keyboard overlay is supported for all languages found in the Oculus App under More Settings > Change Language, except for Korean and Japanese. A user can also change the keyboard language once it displays by clicking the world icon at the lower left corner of the keyboard.

The following image shows an example of the English keyboard overlay that displays when a user selects the search option from Oculus Home.

keyboard overlay

Integrate Keyboard Overlay Support

You can use a setting to automatically display the keyboard overlay when the user selects a text field or manually display the keyboard.

Prerequisites

  • You must have the Oculus SDK v19.0 with OVRPlugin 1.51 or later. For more information on how to get the latest version, see Version Compatibility Reference.

    Note: If you’ve recently upgraded to Oculus SDK v19.0, restart your Oculus device to use the keyboard overlay functionality.

  • You must have focus awareness enabled. To do this, in the Unreal Editor, navigate to Edit > Project Settings > Plugins > Oculus VR > Mobile, and check Focus Aware. For more information, see Oculus Dash, Overlays and Input Focus.

Enable the System Keyboard With a Project Setting

When you enable the system keyboard, the keyboard automatically appears when an editable UI element receives input focus. For example if you enable the system keyboard and a user clicks a textbox in your app, the system keyboard appears automatically.

To enable the system keyboard, make the following changes:

  1. Navigate to Edit > Project Settings, and then to Platforms > Android > APKPackaging, and make sure Enable Improved Virtual Keyboard is selected. The following image shows this setting.

    improved virtual keyboard setting

  2. Under Edit > Project Settings, navigate to Plugins > OculusVR, and check Requires System Keyboard. This will add an entry (oculus.software.overlay_keyboard) to the app manifest, which indicates to the Oculus runtime to use a VR keyboard. The following image shows this setting.

     keyboard setting

With the settings enabled, when the keyboard displays, the app loses input focus, meaning the HasInputFocus flag returns false. Focus is returned to the app when the keyboard is closed.

Manually Display the System Keyboard

You can call the Unreal FSlateApplication::ShowVirtualKeyboard function to display the system keyboard manually. Similar to the keyboard setting, when you display the keyboard manually, the app loses input focus, and the HasInputFocus flag returns false. Focus is returned to the app when the keyboard is closed.

For more information, see FSlateApplication::ShowVirtualKeyboard in the Unreal documentation.

Preview Keyboard Overlay

To test or preview the keyboard overlay feature, do the following:

  1. Open the app in which you’ve implemented the keyboard overlay feature.
  2. Point the cursor in the editable UI text element.

    You can see the system keyboard overlay on the app.