Getting Started with the Cloud Gem Framework - Lumberyard User Guide

Getting Started with the Cloud Gem Framework

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.

Lumberyard cloud gems make it easy to create cloud-connected functionality for your games. You can use the cloud gems included with Lumberyard, or use Lumberyard's Cloud Gem Framework to create your own cloud gems.

Cloud Gems

Cloud gems are Lumberyard gems that use Cloud Canvas Resource Manager (CCRM) to define AWS resources that support their operation. CCRM provides the infrastructure needed to create, configure, and access AWS resources. A cloud gem defines resources and implements the required operations to create a complete game subsystem.

Cloud gems use general purpose AWS features that operate in your AWS account. They are not game-specific services operated by Amazon. Cloud gems follow a serverless microservice architecture that makes use of AWS Lambda functions for computation, and Amazon DynamoDB, Amazon RDS, and Amazon S3 for data storage. However, a cloud gem can use any AWS service.

For example, a cloud gem could provide a leaderboard system that uses a DynamoDB table to store high scores. The gem could use an AWS Lambda function to validate submitted scores and allow fraudulent high scores to be deleted.

In this scenario, CCRM performs the following tasks:

  • Creates the DynamoDB table and Lambda function defined by the gem.

  • Enables the game client to invoke the API to submit a score.

  • Protects the integrity of the leaderboard by removing fraudulent scores automatically.

  • Permits the creation of a user interface that enables an authorized employee to remove fraudulent scores manually.

Cloud Gem Framework

The Cloud Gem Framework is a collection of tools and API operations that support the creation and operation of cloud gems.

The following diagram shows a high-level view of the Cloud Gem Framework architecture.

        Cloud Gem Framework architecture

The Cloud Gem Framework contains the following major components:

  • Cloud Gem Framework Service API – An API that provides a secure interface to a cloud gem's functionality.

  • AWS API Jobs – Integrates the AWS API with the Lumberyard job execution systems (not illustrated).

  • HTTP Request Job – A Lumberyard job for executing HTTP requests (not illustrated).