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.

Usage

The Admin Flow can be opened at runtime in multiple ways...

• Within the Unity Editor, press the “~” key
• Within a Mobile Build, use a "three-finger swipe-up gesture"

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.

📘

Related Guides

A common use case for the feature is covered in the guides.

• See Getting Started for more info

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.

Code

📘

Beamable SDK Examples

• This and all examples are available for download at GitHub.com/Beamable_SDK_Examples

using Beamable.ConsoleCommands;
using UnityEngine;

namespace Beamable.Examples.Features.AdminFlow
{
    [BeamableConsoleCommandProvider]
    public class CustomConsoleCommandProvider 
    {
        [BeamableConsoleCommand ("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);
        }
    }
    
    /// <summary>
    /// Demonstrates <see cref="AdminFlow"/>.
    /// </summary>
    public class AdminFlowCustomCommandExample : MonoBehaviour
    {
        //  Unity Methods  --------------------------------
        protected void Start()
        {
            Debug.Log($"Start() Instructions...\n" + 
                      " * Run The Scene\n" + 
                      " * Type '~' in Unity Game Window to open Admin Console\n" + 
                      " * Type 'Add 5 10'\n" + 
                      " * See 'Result: 15' in Unity Console Window\n");
        }
    }
}

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.

On device, use a three-finger swipe gesture to open the in-game console. This only works if the player has sufficient privileges, or if the "Admin Flow" settings specify the console should always be available.

📘

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.