Keyboard

Keyboard

You can create custom VR keyboards and add them to the keyboard selection in Skyreal VR.

Step 1 — Create the Keyboard Description

1. Open the Content Browser and navigate to any RegistrableAssets folder.

[IMAGE: RegistrableAssets folder — original at /pictures/v1.19/keyboard_custom_folder.png]

2. Right-click to open the asset creation menu. Select Miscellaneous > DataAsset.

[IMAGE: Create DataAsset — original at /pictures/v1.19/keyboard_custom_DA.png]

3. Select the class KeyboardDescription and name your data asset.

[IMAGE: KeyboardDescription class — original at /pictures/v1.19/keyboard_custom_description.png]

4. Skyreal VR scans all RegistrableAssets folders at launch, so restart Skyreal VR to use your new keyboard.

Step 2 — Create the Keyboard Blueprint

There are two keyboard types:

2D Keyboard

1. Create a WidgetBlueprint and open it.

2. Click Graph in the upper right corner.

3. Click Class Settings.

4. Set the Parent Class to CustomizableWidgetKeyboard.

[IMAGE: Reparent 2D keyboard — original at /pictures/v1.19/Keyboard_custom_Etape3.png]

3D Keyboard

1. Create an Actor blueprint.

2. Click Class Settings and set Parent Class to Customizable3DKeyboard.

[IMAGE: Reparent 3D keyboard — original at /pictures/v1.19/Keyboard_custom_Etape4.png]

Step 3 — Link Description to Blueprint

1. Open your keyboard description data asset.

2. Enter a name in the Skr Display Name field.

3. Link it to your keyboard blueprint (2D or 3D).

4. Assign an icon.

[IMAGE: Link keyboard description — original at /pictures/v1.19/Keyboard_custom_Etape5.png]

[IMAGE: Keyboard icon — original at /pictures/v1.19/Keyboard_custom_Etape6.png]

Your keyboard now appears in the keyboard selection dropdown.

[IMAGE: Keyboard selection dropdown — original at /pictures/v1.19/Keyboard_custom_combobox.png]

Step 4 — Implement Input Functions

Three functions are available for keyboard input:

Call these functions from your button events (e.g., OnClicked).