Beamable Documentation

Welcome! Here is everything you need to get setup and become a Beamable expert.

Begin with the Getting Started section, learn more about Beamable features in the Manual, and check out the Script Reference APIs for advanced workflows.

Choose from the following...













.








.

Step 1 - Getting Started

Overview

The purpose of this guide is to demonstrate everything needed for game makers to get started with the "Beamable SDK for Unity". Or watch this 5 minute video.

Steps

Follow these steps to get started.

1. Setup Unity

Create or ensure that the Unity project is version 2018.4.*f1 to Unity 2019.3.* .

For new projects, populate the Project Name, Location, and Template in the Unity "Hub" Window. Beamable is compatible with all template types. Click the "Create" button to continue.

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

  1. Sign up for Beamable today by choosing a plan! You can also contact us if you have any questions.
  2. Replace YOUR_CUSTOM_URL_GOES_HERE below with the url value included in your license confirmation.

3. Setup Beamable

Next, add the following field to the JSON object in Packages/manifest.json located in the project directory:

Addition

{
  "scopedRegistries": [
    {
      "name": "Beamable",
      "url": "YOUR_CUSTOM_URL_GOES_HERE",
      "scopes": [
        "com.disruptorbeam"
      ]
    }
  ]
}

Example With Addition

{
  "scopedRegistries": [
    {
      "name": "Beamable",
      "url": "YOUR_CUSTOM_URL_GOES_HERE",
      "scopes": [
        "com.disruptorbeam"
      ]
    }
  ],
  "dependencies": {
    "com.unity.modules.ai": "1.0.0",
    "com.unity.modules.animation": "1.0.0",
    "com.unity.modules.imageconversion": "1.0.0",
    "etc..."
  }
}

Open the Package Manager Window via "Unity → Window → Package Manager".

Then, in the Package Manager Window, select "Advanced → Show preview packages" and click the “Yes” button on the modal alert that pops up about trusting unverified packages.

In the search box, type "Beamable" and click the "Install" button.

📘

Best Practice

These hints make efficent use of concepts and workflows.

  • Come back and click the "Update" button whenever Beamable deploys a new version of the package.

The “Beamable” package in the Unity Package Manager

Congratulations the Beamable package is now installed!

Usage

To open the Toolbox window, select "Unity → Window → Beamable → Open Toolbox".

The “Beamable” Menu

Now see the Beamable "ToolBoxToolBox - The Beamable "ToolBox" Window which serves as the main entry point for using Beamable" Window prompts for dependencies and registration.

Click the "Accept" button to accept the dependencies of Addressables and TextMeshPro.

Next, register with email and password.

The Beamable "Toolbox" Window

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.

StepDetail
1. Expand the "Game Admin" Feature Group• Click the blue arrow button
2. Add the "Admin Flow" Prefab• Drag this Prefab from the Beamable Toolbox Window to the Unity Hierarchy Window
3. Play the Scene• Unity → Edit→ Play
4. Open the in-game console• Press the "~" key
5. Display the current player’s DBID on-screen and in the Unity Console Window• 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 Login Flow and Beamable will take care of the rest.

🚧

Gotchas

Here are hints to help explain some of the trickier concepts.

  • On updating the package through the package manager, Unity often has trouble updating the package cache to reference the new code. When this happens, go to the "Project" tab, expand "Packages", and right-click on "Beamable". Then, click the "Reimport" button. This should fix up the cache.

  • If there are still any issues, restarting Unity may help. Otherwise, please contact us.

Updated 4 days ago



Step 1 - Getting Started


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.