Kamran14 / BreqLabs

Documentation on how to use BreqLabs custom controllers with the Unity Game Engine.

BreqLabs Inc.

How to use the controller as input on Unity

1. In your scene, make an empty GameObject Called BreqLabsConnectionManager. Click on the Tag option and create a new tag called GloveConnectionManager. Make sure the Tag under BreqLabsConnectionManager is set to GloveConnectionManager.

2. Head over to your Project Tab and go into the Following Directory; BreqLabs-> Scripts.

3. Once there, click and drag the BreqLabsConnectionManager script onto your GameObject created in step 1.

4. Click on your BreqLabsConnectionManager GameObject and an Inspector tab should appear to the right of the screen. Under the BreqLabs Connection Manager Script, set the values to correspond with this image:

5. Find the parent that holds your right and left GameObjects that will be moved by the controllers and attach the BreqLabs Reader Script onto it.

6. Stay in the GameObject that contains your BreqLabs Reader Script and drag your right controller objects into: Or_PALM, Or_ARM, Or_FOREARM, Or_REF_SPINE and Parent Enable Right. Do the same for the left one, but place the objects inside Ol_PALM, OL_ARM, Ol_FOREARM and Parent Enable Left.

Step 7 is Optional

7. If you want to use the BreqLabsConnectionManager in other scenes, do this step. Click on the parent of your character GameObject and drag it into the Prefabs folder located under the BreqLabs folder in the Project Tab. Now click the BreqLabsConnectionManager GameObject and add drag that under the Prefabs folder as well. That will handle the movement part of the controller.

8. Now if you want to use the Buttons on the controller, lets head over to your main C# script. If you don't have one, go to your project tab click Create -> Folder. Then click on the folder and now click Create -> C# Script.

9. Add the following functions in your script:

   private void Reader_OnButtonClicked(){ }

   private void Reader_OnButtonReleased(){ }

10. In your Start() function, add the following: BreqLabsXR.BreqLabsReader.OnButtonClicked += Reader_OnButtonClicked; BreqLabsXR.BreqLabsReader.OnButtonReleased += Reader_OnButtonReleased;

11. In your Reader_OnButtonClicked() function, add whatever you would like to happen when the button is clicked. In your Reader_OnButtonReleased() function, please add whatever you would like to happen when the button is released.