Create a game namespace
Overview
With AccelByte Gaming Services (AGS), you will use namespaces in the AGS Admin Portal to manage features, attributes, and accessibility. While a publisher namespace is what your studio will use to apply certain configurations across a portfolio of games, a game namespace is used to make configurations for one specific game. Each of your studio's games requires a game namespace.
If you have registered an AGS account already, you will have created your first game namespace as part of that process. This How-to will walk you through creating additional game namespaces in the AGS Admin Portal or with the AGS CLI.
Prerequisites
You will need an AGS account to gain access to the AGS Admin Portal. If you don't have one, you can create a free Public Cloud account or reach out to your AccelByte account representative.
To follow the AGS CLI steps, install the AGS CLI and sign in with an account that has access to these features. See Install and sign in. The examples use a Bash shell.
Create a game namespace
To make AGS configurations on a game-by-game basis, each game using AGS requires a game namespace. Follow these steps to create a game namespace.
- Admin Portal
- AGS CLI
- Log in to your AGS Admin Portal.
- Ensure you're on the Your Titles page that shows all of your namespaces (YOUR STUDIO and GAMES, no sidebar).
- If you're not on the Your Titles page and are instead inside of a namespace (the sidebar is visible), click the dropdown in the upper-left corner under NAMESPACE.
- Click View All to be taken to the Your Titles page.
- On the Your Titles page, click + CREATE.
- On the New Game Setup page, enter the following information for your game:
- Game Name: The official title of your game.
- Game Title ID: An ID for your game to use for data and configuration purposes (e.g., URL names or code implementation). It is automatically generated from your Game Name into a compatible format (e.g., spaces removed).
warning
While you can change your Game Name later, your generated Game Title ID cannot be changed after completing this form.
Your game namespace has been created and you've been redirected to it in the Admin Portal.
-
Create the game namespace. Replace
<GameName>with the official title of your game and<GameTitleId>with the ID for your game:ags basic namespaces create --json '{"displayName": "<GameName>", "namespace": "<GameTitleId>"}'If the name contains an apostrophe (
'), put the JSON in a file and pass it with--json @<FileName>.jsoninstead.displayName: the Game Name.namespace: the Game Title ID. Use only letters and numbers. AGS converts it to lowercase. The Admin Portal generates it from your Game Name by removing every character that isn't a letter or number. In AGS Public Cloud, AGS adds your studio namespace and a hyphen in front of it, so the ID of the new namespace is<YourStudioNamespace>-<GameTitleId>.
The command prints the new namespace. Its
namespacefield is the ID you use in other commands. -
If you use AGS Public Cloud, refresh your access token so that it includes your roles in the new namespace:
ags auth refresh
A namespace Display Name is the name of your studio or game and can be changed at any time. This differs from a Title ID, which is an identifier used for data and configuration purposes (e.g., URL names or code implementation). A game namespace's Title ID cannot be changed after it's been created.
What's next?
- Switch namespaces in the Admin Portal, so you can configure the proper one.
- Edit the display name of a namespace.
- Set game namespaces active or inactive.
For more information about namespaces, see Namespaces.