Getting started

This article explains how to create a Beam interactive game project in Unity. A Beam Interactive game enables viewers to directly control the environment in and around streamers' broadcasts by interacting with the UI controls displayed.

1. Download the Beam SDK from the Unity Asset Store.
2. To import the Beam SDK, open the Unity Editor and select: Assets > Import Package > Custom Package. Locate your downloaded SDK package, select the package, and click Open. Leave all the files checked and click Import as shown in the screenshot below:

3. If the import process is successful, a Beam folder will be created under the Assets folder in your Unity project.
4. In the Unity editor, go to Beam > Prefabs, and drag the BeamManager prefab into your scene. We recommend that this prefab be the first asset you add into the scene.

5. Open the Beam menu and select Interactive Studio.
6. Create a new project and name it "HelloWorld". Then click Save.

7. Click the Build tab at the top of the Interactive Studio Editor as shown in the screenshot below:

8. Add a new scene called "default".
9. Add a new control. Make sure the control type is set to button (this is the default). Name the button "GiveHealth". This is the string is referenced in the game code.

10. Drop the button on the grid.
11. Click Save.
12. Go to the Code tab at the top of the Interactive Studio Editor.

13. Copy the Project Version ID to your clipboard.
14. Open the Beam menu and select Open Beam Editor.
15. Paste the Version ID from the earlier step into the Version ID field of the Beam Editor.
16. Go back to the Code tab at the top of the Interactive Studio Editor and click on the go to Developer Lab link.

17. In Developer Lab, click the Manage OAuth button to go to the OAuth Clients page.
18. On the OAuth Clients page, create a new OAuth client with the following information:

• Name: MyOAuthClient
• Website: http://beam.pro
• Hosts: *.beam.pro

19. Copy the OAuth Client ID of the newly created client
20. Go back to the Unity editor, go to the Beam tab and open the Beam Editor. Paste the OAuth Client ID into the OAuth Client ID field.
21. Click the Save project information button.
22. Create a new GameObject in the hierarchy window.
23. Create a new script and name it HelloBeam.cs.
24. Open the newly created HelloBeam.cs script. Add Beam.GoInteractive() to the Start function as shown below. Beam.GoInteractive is the API method to connect to the Beam service.

void Start() {
    Beam.GoInteractive();
}

25. Go to the Update function and add a call to receive input from the "GiveHealth" button you've created earlier.

void Update() {
   if (Beam.GetButton("GiveHealth")) {
       Debug.Log("Player health increased.");
   }
}

26. To test your set up, click on the Play button in the Unity editor.
27. Follow the instructions and enter the displayed code at http://beam.pro/go.
28. Open a web browser and go to your Beam channel: http://beam.pro/.
29. Click on the "GiveHealth" button.
30. If you have the Unity console open, you'll see "Player health increased." printed on the console.