Overview
Here is everything needed to use the Installing Beamable process and get started in the "Beamable SDK for Unity". Or watch this video.
Steps
Follow these steps to get started.
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 2018.4 LTS to 2020.x 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 |
|---|---|
|  • Unity → Assets → Import Package → Custom Package |
|  • Press the "Import" button |
|  • Click to continue |
|  • Click to continue Note: 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 "LoginLogin - The Beamable "Login" Window which serves as the main entry point for Beamable account setup" 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 |
Create Customer | • Click to continue |
Next, the Beamable "ToolBoxToolBox - The Beamable "ToolBox" Window which serves as the main entry point for using Beamable" Window prompts for dependencies.
The Dependency Import
Press the "Import Assets" button to continue.
Now the Beamable "ToolBoxToolBox - The Beamable "ToolBox" Window which serves as the main entry point for using Beamable" Window shows the available FeatureFeature - An individual aspect of the Beamable product used to create a great user experiences.
The Beamable "Toolbox" Window
Verify Success
As an optional step, verify that everything is properly setup. Display the current player’s DBIDDBID - The database identification. Beamable generates an anonymous account for the player when the project first runs on-screen and in the Unity Console Window.
Step | Detail |
|---|---|
| • Unity → File → New Scene |
| • Unity → Window → Beamable → Open Beamable Toolbox |
| • Drag this Prefab from the Beamable Toolbox Window to the Unity Hierarchy Window |
| • Unity → Edit→ Play |
| • Press the "~" key |
| • Type "dbid" to in the in-game input field |
|
DBID
• Beamable will generate an anonymous account DBIDDBID - The database identification. Beamable generates an anonymous account for the player when the project first runs 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 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 about a month ago
What's Next
| Step 2 - Using Account Management Flow |