Technical Documentation Overview

[Warning] The documentation is under construction, with content being added and grammar/spelling still being checked.

This guide is being developed and maintained by Project Workbench to document the team’s technical development process as a reference to other developers. Project Workbench used Lumberyard to create a Twitch-integrated game called Krossis (watch the trailer). The document is purely our understanding and interpretation of Lumberyard and does not represent the views of Amazon. This is not an extensive documentation of the game engine. Please refer to the official documentation of Amazon Lumberyard and Twitch for further information.

Version: The most recent release of Lumberyard at the time of writing this documentation is 1.13.0.0.

LumberJam: To learn about LumberJam and LumberJam resources, LumberJam.

The documentation fits into two places of flow for developers. While learning, it is expected that developers are going through Amazon’s official documentation, Getting Started Guide YouTube series, and their tutorials (although mostly deprecated). If a developer has experience with Unity, we highly recommended they read our Unity to Lumberyard documentation, although it should be helpful to other developers as well. This technical documentation is to be used as a reference while developing, meaning that this document acts as a supplement to the official documentation as well as sample projects available in the engine. If the problem you are tackling cannot be solved after going over any of these resources, Amazon’s GameDev forums is a good place to ask your question.

Below is a general workflow of resources to refer to during your development process. Along with this, each section has specific resources listed out at the end of the sections.