Documentation Home
Breadcrumbs

Tools

Tools

Skyreal VR allows you to extend its built-in tool list with your own custom tools. A tool is a 3D object (such as a wrench, screwdriver, or any instrument) that users can pick up and manipulate in VR.

Creating a Custom Tool

Prerequisites

  • An Unreal Engine editor project with your Skyreal VR simulation

  • A 3D model to use as a tool (from CAD preparation or an FBX import)

Step 1 — Create a SkrTool Blueprint

Right-click in the Content Browser and create a Blueprint Class. Choose the parent class SkrTool and save it anywhere under the Simulation folder.

[IMAGE: Create SkrTool — original at /pictures/all_v1.12_skyreal_experience_customization_skrtool.png]

Step 2 — Prepare the Mesh

If your tool is composed of multiple parts, merge them into a single StaticMesh:

  1. In the World Outliner, select the parts you want to use as a tool

  2. Go to Window > Developer Tools > Merge Actors

  3. Save the merged mesh under the Simulation folder

If you already have a single StaticMesh, you can use it directly.

[IMAGE: Merge actors — original at /pictures/all_v1.13_skyreal_experience_customization_merge_actors.png]

Step 3 — Assign the Mesh

Double-click the SkrTool blueprint to open it. Drag and drop your StaticMesh into the slot of the root StaticMeshComponent.

[IMAGE: Drop static mesh — original at /pictures/all_v1.13_skyreal_experience_customization_drop_sm_tool.png]

Step 4 — Set the Display Name

In the details panel of the tool (with the root component selected), set the Display Name that will appear in Skyreal VR.

[IMAGE: Root component — original at /pictures/all_v1.12_skyreal_experience_customization_tool_root.png]
[IMAGE: Tool display name — original at /pictures/all_v1.12_skyreal_experience_customization_tool_details.png]

Step 5 — Register the Tool

Save your tool blueprint and add it to the SkrController using the + button.

[IMAGE: Add tool to controller — original at /pictures/all_v1.12_skyreal_experience_customization_add_tool_controller.png]

Registering Tools via SDK

You can also register tools programmatically using the Skyreal VR SDK:

SDK Function

Description

Add Tool

Adds a SkrTool to the Skyreal VR tools list at runtime

This is useful for extensions that need to dynamically add tools based on context or user actions.