Lumberyard Release Notes – Beta 1.28 (May 2021) - Lumberyard Release Notes

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 Release Notes – Beta 1.28 (May 2021)

It’s been awhile, hasn’t it? If you’ve checked out our recent AWS Lumberyard blog series, you might’ve noticed that we’re working on something big. Really big. That work has been taking a fair amount of time and energy, but we’re also chugging right along with the current Lumberyard Beta, and we’re pleased to release version 1.28! This time around, we have an updated Twitch Gem, an improved setup and installation experience, and a fresh buffet of various smaller improvements to serve up for you, along with over 40 bug fixes.

Let’s check it out, shall we?

Keep sending feedback to our forums and to lumberyard-feedback@amazon.com! For the latest Lumberyard updates, follow us on Twitter, Facebook, and our blog.

Looking to get v1.28 of Amazon Lumberyard, or interested in giving it a spin? Download it here.

New to Lumberyard? Watch Learn Lumberyard in 20 Minutes. (And maybe subscribe to our official Lumberyard YouTube channel, too!)

Already a user? Share your feedback in the Amazon Lumberyard forums.

Lumberyard 1.28 Beta Visual Studio Requirements
  • Amazon Lumberyard Beta 1.28 now supports up to Visual Studio 2017 version 15.9.34 or 2019 version 16.9.2, including the Community Edition for both.

  • The minimum required versions are:

    • Visual Studio 2017 (any Edition): version 15.9.14, or:

    • Visual Studio 2019 (any Edition): version 16.2.4

NOTE: There are some issues that arise when using the MSVC compiler shipped with Visual Studio 2019 versions 16.8, 16.8.1, and 16.8.2. For more details, check out the Lumberyard 1.28 Known Issues.


         1 28 teaser 2

Installation Notes

Important

If you are using Visual Studio 2017, we recommend installing the Visual Studio C++ Redistributables for Visual Studio 2012 and Visual Studio 2019 before installing Lumberyard. See Amazon Lumberyard system requirements in the Welcome Guide for installation information.

  • If you are using Visual Studio 2017, use the Visual Studio 2019 version of Project Configurator (\dev\Bin64vc142\ProjectConfigurator.exe) to create and switch projects.

Highlights

Now, let’s review what’s shipping this time around. Here’s a sampling of our favorite new features and improvements found in Lumberyard Beta 1.28.

Twitch Integration

Integrating your game with Twitch streaming? Well, you’re in luck! We’re pleased to share the new Twitch API Gem, which provides an updated wrapper for the latest Twitch REST API. (The older Twitch Gem, written for what’s now the legacy Twitch v5 API, has been renamed to Twitch v5 and is considered deprecated.) This new Gem has the full API reflected to both Script Canvas and Lua. Hooray!

Read the Twitch API Gem documentation here. Developing with C++? Read the rewritten C++ API docs and check out the updated code examples!

Setup and Configuration

We’ve made some quality-of-life improvements to the Setup Assistant and Project Configurator that will make life a little clearer and friendlier for new users and current ones alike.

First, we clarified the differences between an Express Installation and a Full Installation during setup. We don’t need to write anything about it here because the UI now tells you what you get with either installation type. No need to go to the docs!


               setup assistant install options

We’ve also simplified, clarified, and generally cleaned up the heapin' helpin' of options you see when you start an install. Check it out! (Much nicer, huh?)


               setup assistant get started

And we’ve added a progress bar to builds that you kick off in Project Configurator!


               configurator build progress

We hope this helps!

Updated Cloud Gems

With the removal of the Cloud Gem Portal in Lumberyard Beta v1.28, several Cloud Gems have new lmbr_aws CLI commands to replace functionality that was previously available on the portal.

Dynamic Content Gem

The following new sub-commands are available for the lmbr_aws dynamic-content command:

  • list-uploaded-content - lists all uploaded content

  • delete-uploaded-content - deletes a manifest or package

  • show-logs - shows recent log events; replaces the Log Explorer in the portal

Use the existing set-staging-status command to transition the manifest or package state.

For more details, read the updated documentation.

Player Account Gem

The following new sub-commands are available for the new lmbr_aws player-account command:

  • add-player - creates a new player account in Amazon Cognito

  • ban-player - bans a player by account ID

  • confirm-player - confirms a player account whose status is "Unconfirmed" to make it usable

  • edit-player - edits a player’s settings

  • remove-player-ban - removes a player ban

  • reset-player-password - resets the password for a player account

  • show-banned-players - lists all banned players

  • show-logs - shows recent log events; replaces the Log Explorer in the portal

  • show-players - lists all registered players, using optional filters

  • show-player-details - lists account details for a player using their account ID

For more details, read the updated documentation.

Web Communicator Gem

The following new sub-commands are available for the new lmbr_aws web-communicator command:

  • list-channels - lists all the existing channels

  • list-users - lists all the existing users

  • register-client - registers an OpenSSL or WebSocket client connection, saving the device cert, port, endpoint, and private keys to files in the current or specified folder

  • send-message - sends a message to all clients on a channel, or to a specific user

  • set-user-status - sets the user status to either "banned" or "registered"

  • show-logs - shows recent log events; replaces the Log Explorer in the portal

Note that Web Communicator listening functions have not been implemented as lmbr_aws CLI commands. Use list-channels and list-users to find the subscription topic to listen to. You can use the AWS IoT console or the game client to subscribe and listen to messages. For more information on using this console to view messages, read View MQTT messages with the AWS IoT MQTT client.

For more details, read the updated documentation.

Also note that in place of the REST Explorer on the Cloud Gem Portal, you can use the Amazon API Gateway console. For more information on how to use this console, see Use the API Gateway console to test a REST API method.

Important

The Cloud Gems that were not updated have been deprecated. They are no longer functional without the portal.

Other Changes and Improvements

Gems

  • Added a field, CacheRelativePath, to the xmlschema system. This field lets a Gem developer declare a relative dependency on an asset which is not source-relative. (For example, an asset in a Gem can now have a dependency on a specific asset in the /Engine folder.)

Lumberyard APIs

  • Added a Reset() method to Asset<T> to restore an Asset to the state it was after default construction.

Feature Deprecations and Removals

(Note on usage: An Amazon Lumberyard feature that is marked as "deprecated" is no longer under development and will be removed from the product at a later date. Features marked as "removed" are no longer present or supported in the noted version.)

ChatPlay Gem

  • The old ChatPlay Gem is deprecated in Amazon Lumberyard release v1.28. This gem has been replaced by the new Twitch Chat API Gem, which has a dependency on the new Websockets Gem.

Cloud Gem Portal

  • The Cloud Gem Portal has been removed in Amazon Lumberyard release v1.28. We strongly recommend that you migrate any required CloudGemPortal functionality to the lmbr_aws CLI. See the updated DynamicContent, PlayerAccount, and WebCommunicator Gems for examples.

Cloud Gems

  • The following Cloud Gems are now deprecated: Compute Farm, Defect Reporter, Game Metrics, In-Game Survey, Leaderboard, Message of the Day, Speech Recognition, and TextToSpeech.

Twitch v5 Gem

  • The old Twitch Gem, renamed Twitch v5, is deprecated in Amazon Lumberyard release v1.28. This gem has been replaced by the new Twitch API Gem, which provides an updated wrapper for the latest Twitch REST API.

More Information