Installing Beamable (Unity)
1. Setup Unity
Create or open a Unity Project. For new projects, populate the Project Name, Location, and Template in the Unity "Hub" Window.
Press the "Create" button to continue.
Beamable SDK Compatibility
• Beamable supports Unity versions 2020 LTS to 2022 LTS and is compatible with all template types
• Beamable supports many Unity target platforms including iOS/Android on Mobile and Windows/Mac for PC
The Unity "Hub" Window
2. Setup Licensing
A Beamable license is required before completing the setup process below. Beamable cannot be downloaded, installed, or used without a license.
License Required
• Sign up for Beamable today by choosing a plan! You can also contact us if you have any questions
• License confirmation includes the Beamable SDK Installer Package file required for Step 3 below
3. Setup Beamable
Now use the Beamable SDK Installer Package file to install the Beamable SDK.
| Step | Detail |
|---|---|
| 1. Import the Beamable SDK Installer Package |  • Unity → Assets → Import Package → Custom Package |
| 2. Verify the import |  • Press the "Import" button |
| 3. Install the Beamable SDK |  • Click to continue |
| 4. Remove the Beamable SDK Installer Package |  • Click to continueNote: Now that the installation process is complete, the installer package is no longer needed. |
Congratulations the Beamable SDK is now installed!
Usage
To open the Toolbox window, select "Unity → Window → Beamable → Open Toolbox".
Now see the Beamable "Login" Window prompts for user account registration.
The Beamable "Login" Window
| Name | Detail |
|---|---|
| Customer Alias | • Enter the name of your studio (e.g. "MyGameStudio") Note: This may contain spaces |
| Game Name | • Enter the name of your game project. Use the real name of the game if possible (e.g. "My Game Name") Note: This may contain spaces |
| • Enter a valid email address. This is important for notifications about the service Note: This may contain numbers, letter, and symbols | |
| Password | • Enter a secure password |
| Confirm Password | • Confirm you typed it correctly |
| Agree To Terms | • Beamable is available free for development, but you agree to a commercial agreement when you ship your game Note: See Pricing and FAQ for more info |
| Create Customer | • Click to continue |
| Open The Library | - Click the "See Samples" button at the end of the login flow. |
Verify Success
As an optional step, verify that everything is properly setup. Display the current player’s PlayerId on-screen and in the Unity Console Window.
| Step | Detail |
|---|---|
| 1. Create a new Unity Scene | • Unity → File → New Scene |
| 2. Open the "Beam Library" Window | • Unity → Beam Button → Open Beam Library |
| 3. Add the "Admin Flow" Prefab | • Add this prefab to your scene |
| 4. Play the Scene | • Unity → Edit→ Play |
| 5. Open the in-game console | • Press the "~" key |
| 6. Display the current player’s PlayerId on-screen and in the Unity Console Window | • Type "dbid" into the in-game input field and submit |
| 7. Success! |
PlayerId
• Beamable will generate an anonymous account PlayerId for a player when the project is run. Stopping and restarting the project will persist the player account.
• Want to track player accounts across multiple games? Easy. Add the Account Management Flow - Prefab and Beamable will take care of the rest.
Gotchas
Here are hints to help explain some of the trickier concepts:
• Sometimes copy/paste operations into Beamable text fields can carry hidden characters. If you are getting an error with copy/paste, try to manually type the desired value
• If there are still any issues, restarting Unity may help. Otherwise, please contact us
Updated 17 days ago