Overview

This page includes everything needed to use this feature in the "Beamable SDK for Unity". Or watch this 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.

Steps

Follow these steps to get started.

Here is the "Beamable" menu as seen in Unity.

Here is the feature Prefab as seen in the Beamable Toolbox.

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

Creating Custom Admin Commands

Game makers can create custom admin commands for additional functionality.

1. Create a DBeamConsoleCommandProviderclass

• Create a new class like below.
• Ensure that the class does not extend MonoBehavour

[DBeamConsoleCommandProvider]
public class CustomCommandProvider 
{
}

2. 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);
}

3. 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.