Player Account Cloud Gem - Lumberyard User Guide

Player Account Cloud Gem

Open 3D Engine (O3DE), the successor to Lumberyard, is now available in Developer Preview. Download O3DE or visit the AWS Game Tech blog to learn more.

The Player Account Cloud Gem provides a standalone player authentication and management solution that uses Amazon Cognito. The cloud gem includes a player registration API, built-in two-step verification, and support for both anonymous and authenticated players. You can use the lmbr_aws CLI to administer players and manually register, delete, ban, and update their accounts.

You are responsible for (a) providing legally adequate privacy notices to your end users; (b) obtaining any necessary consent from the end user for the collection, use, transfer, and storage of any name, password, other login information, or personally identifiable information or personal data of any end user that you (or any third-party plug-in or service provider you use) may access; (c) using and authorizing others to access and use the information only for the purposes permitted by the end user; and (d) ensuring the information is collected, used, transferred, and stored in accordance with all laws, rules, and regulations applicable in jurisdictions in which your applications are used.

Using the Player Account Cloud Gem

Player accounts have the following automatic or required fields:

  • Amazon Cognito Identity ID – The unique ID of the player in the Amazon Cognito database. This ID field is initially empty and is filled after the player signs in for the first time.

  • Account ID – An automatically assigned ID.

  • User Name – The Amazon Cognito user name, required during account creation.

  • Email – The email of the player, required during account creation.

  • Account Status – The current status of the account. The following statuses are possible:

    • Archived – The account has been archived due to inactivity. You can change this from the Amazon Cognito console.

    • Compromised – This account requires further investigation from Amazon Cognito console.

    • Disabled – The player account is currently disabled. You can reenable it on the Amazon Cognito console.

    • Force Change Password – An AWS administrator has used Amazon Cognito to create the player account, and the player now must change their temporary password before they can successfully sign in.

    • Reset Required – The player's account was imported, but the player has not logged in.

    • Unconfirmed – The player account hasn't confirmed the account's email address or phone number. The account is unusable until it has been confirmed.

    • Unknown – The account is in an unknown state. Use the Amazon Cognito console to investigate further.

In addition, this gem supports setting the following optional fields:

  • Player Name

  • Family Name

  • Given Name

  • Nickname

  • Gender

  • Locale

Only the Username and Email fields are required when creating a new player account. Validation is performed server-side using the OpenID Connect specification rules.

Use the lmbr_aws player-account CLI commands to add, edit, confirm, ban, and show players in your game.