Finch Logo

Documentation

Get started

Below are described steps to implement Finch support into Unity-applications.

1. Create or Get Project

You can use the Unity project included in Finch Unity SDK as basis for your Unity project with Finch controller support. There are two ways to get Finch Unity SDK:

2. FinchMain

Add FinchMain prefab to your scene. It contains FinchVR script, which is necessary script for any Finch features. So, add FinchMain to all scenes where you want to use Finch features. Note that there should be only one FinchVR script (FinchMain prefab) on each scene.

3. Configure the project

To configure your Unity project with Finch controller support, read Settings section and choose the appropriate settings of FinchVR script. You can do this step later, if you don't know which options to choose.

3. Controller instance

The best way to start use Finch controller support in Unity is to use default prefabs. Both scenes and prefabs are described in section Scenes and prefabs.

Also, there are simple scenes, which have all necessary scripts and prefabs to start to work with Finch controllers, so you can simply choose the scene and start from it.

4. Check controllers

If you didn't connect your Finch controllers yet, now is the best time to do it. To learn how to connect and use your Finch controllers you can read here.

Choose a scene that contains Finch components.

If you want to check the controllers on your PC, pair controllers to PC and press Play.

If you want to check the controllers on Android, pair controllers to Android device, which you will use, and then build your project for Android. Read this tutorial if you don't know how to build for Android.

You should see your scene and controller instance in it. Calibrate your controller or controllers (read here and move them. You should see that the controller instance is moving on your scene too.

If not, make sure, that:

  1. You have connected controller correctly

  2. All necessary prefabs and scripts are presented in your scene

  3. You have the appropriate settings