User Guide (Version 1.14)

Cloud Gems Overview

A Lumberyard gem is an individual package of specific functionality and assets. The gem includes everything required for you to include that functionality in your project.

Lumberyard cloud gems are Lumberyard gems that provide AWS functionality for a game. A more complete definition of a cloud gem might be the following:

A cloud gem is an individual package of specific cloud-connected functionality, assets and AWS resource definitions. A cloud gem includes everything required for you to include that cloud-connected functionality in your project.

Cloud Gems Included with Lumberyard

Lumberyard includes the following cloud gems. To enable them in a project, use the Lumberyard Project Configurator tool.

  • Dynamic Content – Allows Lumberyard .pak files that contain new and updated game assets to be uploaded to the cloud for later automatic downloading to the game client.

  • In-Game Survey – Create surveys for your game, test them, and publish them. View survey results and manage your surveys in the Cloud Gem Portal.

  • Leaderboard – Stores a player's high scores and provides leader boards that show player rankings.

  • Message of the Day – Schedules the delivery of messages (for example, new product announcements or holiday greetings) to game clients.

  • Player Account – Provides a standalone player authentication and management solution that uses Amazon Cognito.

  • Speech Recognition – Add speech recognition and natural language processing to your Lumberyard game. The Speech Recognition Cloud Gem uses the Amazon Lex service, which recognizes and understands spoken input.

  • Text to Speech Cloud Gem – Enhance your gameplay and workflows with synthesized speech. The Cloud Canvas Text-to-Speech (TTS) Cloud Gem uses Amazon Polly, which is a text-to-speech service that turns text into lifelike speech.

For more information, see Cloud Gems.

Cloud Gem Portal

The Cloud Gem Portal provides webpages that can be used to configure the cloud gem and perform maintenance operations. The Cloud Gem Portal also provides access to Cloud Canvas Resource Manager functionality, such as deployment management. For more information, see Cloud Gem Portal.

Cloud Gem Framework

The Cloud Gem Framework is a software development kit (SDK) that is included with Lumberyard. You can use the framework to implement the cloud gems that come with Lumberyard, as well as your own cloud gems. For more information, see Cloud Gem Framework.