Overview
This page includes everything needed to use this feature in the "Beamable SDK for Unity". Or watch this 5 minute video.
The purpose of this feature is to offer the game maker an in-game UI for executing game commands and cheats.
Within the Unity Editor, press the “~” key to open the in-game console.
Related Guides
A common use case for the feature is covered in the guides. See Getting Started for more info.
The User Interface
When setup properly, the player's user interface in the game project will be as follows.
The Beamable "Admin Flow" UI in the Unity Game Window
Steps
Follow these steps to get started.
| Step | Detail |
|---|---|
| 1. Open the "Toolbox" Window | • Unity → Window → Beamable → Open Beamable Toolbox |
| 2. Add the "Admin Flow" Prefab | • Drag this Prefab from the Beamable Toolbox Window to the Unity Hierarchy Window |
Here is the "Beamable" menu as seen in Unity.
The “Beamable” Menu
Here is the feature Prefab as seen in the Beamable Toolbox.
The Beamable "Admin Flow" in the Beamable Toolbox Window
Admin Commands
Once the Admin Flow is open, type an admin command into the input field and press return.
There are built-in Beamble admin commands and game makers can create custom admin commands for additional functionality.
Using Beamable Admin Commands
| Command | Detail |
|---|---|
help | Shows the list of all admin commands |
TRACK_PAYMENT | Track a test payment audit |
ECHO <message> | Repeat message to console. |
WHERE <command> | Find where a specific console command was registered from, if it was registered with a DBeamConsoleCommand attribute |
account_toggle | emit an account management toggle event |
account_list | list user data |
IDFA | print advertising identifier |
RESET | Clear the access token and start with a fresh account |
LOCALNOTE [<delay> [<title> [<body>]]] | Send a local notification. Default delay is 10 seconds. |
TIMESCALE <value> | variable | Sets the current timescale |
SUBSCRIBER_DETAILS | Query subscriber details |
DBID | Show current player DBID |
ENTITLEMENTS <symbol> <state> | Show current player entitlements |
HEARTBEAT <dbid> | Get heartbeat of a user |
LOGIN_ACCOUNT <email> <password> | Log in to the DBID designated by the given username and password |
MAIL_GET <category> | Get mailbox messages |
MAIL_UODATE <id> <state> <acceptAttachments> | Update a mail |
REGISTER_ACCOUNT <email> <password> | Registers this DBID with the given username and password |
EXPIRE_TOKEN | Expires the current access token to trigger the refresh flow |
CORRUPT_TOKEN | Corrupts the current access token to trigger the refresh flow |
TEST-ANALYTICS | Run 1000 events to test batching/load |
IAP_BUY <listing> <sku> | Invokes the real money transaction flow to purchase the given item_symbol. |
IAP_PENDING | Displays pending transactions |
Creating Custom Admin Commands
Game makers can create custom admin commands for additional functionality.
- Create a
DBeamConsoleCommandProviderclass
- Create a new class like below.
- Ensure that the class does not extend MonoBehavour
[DBeamConsoleCommandProvider]
public class CustomCommandProvider
{
}
- Add a command method
- Any method marked with a
[DBeamConsoleCommand]attribute, returns a string, and accepts an array of strings, will be treated as an available command.
[DBeamConsoleCommand ("Add", "A sample addition command", "Add <int> <int>")]
public string Add(string[] args)
{
var a = int.Parse(args[0]);
var b = int.Parse(args[1]);
return "result: " + (a + b);
}
- Test the new command by calling it from the in-game "Admin Flow".
- Type "help" in the in-game "Admin Flow"
- See the custom command listed in the output
Bonus: To see the location of your command script, type where <your command name> in the in-game console.
Advanced
Here are a few advanced configuration options and workflows.
Force-Enabled
Within the Unity Editor, press the “~” key to open the in-game console. This always works, regardless of player privileges or "Admin Flow" settings.
Within the game running on-device, use a three-finger swipe up gesture to open the in-game console. This works only sometimes, depending on player privileges and "Admin Flow" settings.
Best Practice
These hints make efficent use of concepts and workflows.
- For security reasons, it is not recommended to allow a players to access the in-game console. Beamable has precautions in place
The in-game console, on-device, will only appear if the force-enabled checkbox is true, or if the current player's account has tester, developer, or admin privileges.
The Portal allows game makers to grant player privileges. This privilege-requirement only applies to device, not the Unity Editor.
Updated 6 days ago