Lumberyard

User Guide (Version 1.16)

What is Lumberyard?
- Lumberyard Systems
- Programming Concepts
- Editors and Tools
- Asset File Types
- Navigate the Documentation
- Key Terminology
Set Up
- System Requirements
- Download
- Upgrade
  - Files to Exclude
- Set Up a Development Environment
- Enable a Firewall
- Set Up Perforce
- Uninstall
Create a Game Project
- Creating and Switching Game Projects
- Configuring Advanced Settings
- Understanding the Project Configurator
- Troubleshooting
- Managing Game Projects with Lmbr.exe
Build a Game Project
Migrate a Game Project
- Lumberyard 1.15
- Lumberyard 1.14
  - Symlinks Removed for Third-Party Libraries
- Lumberyard 1.10
- Lumberyard 1.9
- Lumberyard 1.8
- Lumberyard 1.7
- Lumberyard 1.6
- Lumberyard 1.5
Lumberyard Editor
- Lumberyard Editor Interface
- Using the Menu Bar
- Using the Top Toolbar
- Using the Bottom Toolbar
- Using Keyboard Shortcuts
- Using the Viewport
- Using the Rollup Bar
- Using the Console Window
  - Console in Depth
  - Console Variable Tutorial
- Demo and Video Capture
  - Capturing Video and Audio
  - Recording Time Demos
- Customizing Lumberyard Editor
- Restoring the Default Layout for Lumberyard Editor
Sample Projects and Levels
- Samples Project
- Starter Game Sample
- Script Canvas Basic Sample
- Advanced_RinLocomotion Sample
- Simple_JackLocomotion Sample
- Multiplayer Sample
  - Gameplay Architecture
  - Network Features
- Virtual Reality Samples Project
- In-App Purchases Sample
- Woodland Asset Package – Legacy
- Beach City Sample Project – Legacy
- Legacy Sample Project (GameSDK)
Asset Pipeline
- Using Asset Processor
- Configuring the Asset Pipeline
- Configuring Image Processing
- Live Reloading and VFS
- Shader Compiler Proxy
- Shader Cache and Generation
- Game Startup Sequence
- Asset Browser
- Programming the Lumberyard AZCore Runtime Asset System
Component Entities
- Entity Outliner
- Entity Inspector
  - Customizing the Entity Icon
- Component Reference
- Working with Entities and Components
- Working with Slices
- Converting Entities with the Legacy Converter
- Programmer's Guide to Entities and Components
- Gameplay Bus
- Reflecting Lumberyard Classes, Methods, and EBus Interfaces
Add Features and Assets with Gems
- Enabling Gems
- Creating a Gem
- Programming with Gems
- Gems Available in Lumberyard
Input
Levels and Environment Effects
- Creating a New Level
- Creating Terrain
- Blending Environment Probes
- Working with Layers
- Working with Database Libraries
- Adding Sky Effects
- Adding Weather Effects
  - Adding Wind Effects
  - Adding Clouds
- Adding Vegetation
Shaders and Materials
- Concepts
- Shader Rendering System
- Shader Reference
- Selecting Material Surface Type
- Setting Material Opacity
- Setting Material Lighting and Color Settings
- Material ID Mapping in Autodesk 3ds Max
- Working with Textures
- Working with Substances
- Working with Blend Layers
- Parallax Mapping
- Using Vertex Colors
- Customizing Post-Processing Effects
- Toon Shading (Experimental Feature)
- Order-Independent Transparency
Lighting and Shadows
- Environment Lighting
- Environment Shadows
Screen Effects
- Temporal Antialiasing and Supersampling
- Voxel-based Global Illumination (SVOGI)
- Fog Systems
  - Standard Fog
  - Volumetric Fog
- Render Nodes
- Generating Stars .dat File
- Building DirectX 12 Supported Applications
Rendering Cameras
Create and Animate Characters
- Animation Editor Concepts and Terms
- Animation Editor User Interface
- Animation Editor File Types
- Getting Started with the Animation Editor
- Animation Editor Components
- Using Morph Targets to Deform Characters
- Customizing State Machine Routing with Sparse Motion Sets
- Creating Blend Trees
  - Creating and Visualizing Blend Spaces
  - Blending Poses with Blend Nodes
- Simplify Node Groups with Hub Nodes
- Using Tags with Animation Graphs
- Customizing EMotionFX Objects
- Best Practices for Working with Skinned Meshes for Animation
Enable AI
- AI System Concepts
- Spawning AI Agents
- AI Navigation
- Agent Perception
- AI Communications
- AI Modular Behavior Tree
- AI Agent Debugging
- AI Bubbles System
- AI Tactical Point System
- Path Following
- Movement System
- Auto-Disable
- AI Scripting
Particle Effects
- Using the Particle Editor
- Particle Effects Best Practices
- Advanced Particle Techniques
- Particle Debugging with Console Variables
PhysX System
- Exporting a PxMesh for PhysX Mesh Shape
- Creating a Static PhysX Object
- Creating a Dynamic PhysX Object
- Configuring PhysX Step Constants
- PhysXRigidBody API
- PhysX Ebuses
- Raycast and Shape Cast Queries (Preview)
- Legacy Physics System
Scripting
- Script Canvas
- Lua Scripting
- Scripting Questions and Answers
Audio and Sound
- Audio System Overview
  - Audio Translation Layer
    - Using the Audio Controls Editor
    - ATL Controls
- Audio Implementations
  - AudioKinetic Wwise
- Audio Console Variables Commands
- Audio Components
Cinematics
- Using the Track View Editor
- Track View Editor Nodes
- Creating Scenes
- Managing Track Events
- Cinematics Cameras
- Cinematics Lighting
- Animating Characters in Scenes
- Capturing Image Frames
- Debugging Cinematic Scenes
Game User Interfaces (UI)
- Using the UI Editor
- Working with UI Canvases
- Defining Game and Level Load Screens
- Working with UI Slices
- UI Elements
  - Using and Creating UI Prefabs
- UI Components
- Implementing New Fonts
- TrueType Fonts
- Animating the UI
  - Scripted Tweener Entity System
  - UI Animation Editor
- UI Lua Reference
Memory Management
- Code Example
- HPHA Memory Debugging
Profiling, Testing, and Debugging
- Profiler
- Using AZ Test Scanner
- Writing Tests for AzTest
- Statoscope Profiler
- Debugging Issues
- Tracking File Access
Localization
- Localization Checklist
- UI System Localization Features
- Font Features
- Localization Initialization
Create Game Builds
- Creating Release Builds for PC
- Compiling Shaders for Release Builds
- Adding Custom Game Icons
- Universal Remote Console
- Using the Waf Build System
Integrate Twitch
- Twitch ChatPlay System
- Twitch JoinIn
- Twitch API
- Twitch C++ API Reference for Lumberyard
  - General
  - User
  - Friends
  - Rich Presence
  - Channels
  - Data Types
- Twitch ChatPlay Lua Reference
Cloud Connected Features
- Overview
- Cloud Gems
- Gameplay Design and Engineering Guide
- Software Engineering Guide
  - Resource Manager in Depth
  - Cloud Gem Framework
- Administering Cloud Canvas
- Using the Command Line
  - Command Reorganization
Networking
- Tutorial: Getting Started with Multiplayer
  - Configuring the Multiplayer Sample for Amazon GameLift
- Overview
- Synchronizing Game State Using Components
  - Creating a NetBindable Component
  - Transform Component Interpolation
    - Providing Your Own Interpolation Logic
- Synchronizing Game State Using Scripts
- Using Encryption
  - Building with Encryption
  - Enabling Encryption
- Controlling Bandwidth Usage
- Using Bit Packing
- Setting up a Lobby
- Creating Dedicated Servers
- Using the TCP Stream Driver
- Using GridMate for Large-Scale Worlds
  - Writing Your Own Interest Manager Attributes, Rules and Rule Handlers in C++
- Using Amazon GameLift
- Useful Console Commands
Event Bus (EBus) System
- Usage and Examples
- Event Buses in Depth
- Common Tasks, EBuses, and Handlers
- Direct Access to EBus Handlers
Virtual Reality Games
- Configuring your Project for Virtual Reality
  - Configuring OSVR
- Configuring Required Console Variables
- Using the InstantVR Slice
  - InstantVR Lua Script Properties
- Setting Up Virtual Reality with Flow Graph
  - Setting Up a Basic Virtual Reality Flow Graph
  - Setting Up a Custom Playspace with Flow Graph
- Previewing your Virtual Reality Project
- Debugging your Virtual Reality Project
- Using EBus Request Bus Interface for Virtual Reality
- VR Lua Functions
Android and iOS Games
- Android Support
- iOS Support
- Design Considerations for Creating Mobile Games Using Lumberyard
- Lumberyard Performance Tuning Guidelines for Mobile Devices
- Updating Graphics Settings for Android and iOS
- Adding IP Addresses to Allow Access to the Asset Processor and Remote Console
- Running the Shader Compiler on Amazon EC2
- Testing Your Build on the AWS Device Farm
macOS Games
- Building macOS Games
- Building Game Assets for macOS Games
- Building Shaders for macOS Games
- Running macOS Games
- macOS Debugging and Troubleshooting
- Creating a Project for Your macOS Games
Create Executables for Linux
- Compiling Assets on a Windows Computer
- Building the Lumberyard Executable for Linux
- Testing the Windows Client to Linux Server Connection
- Preparing the GameLift Package
- Setting up Ubuntu on Amazon EC2
Automate Boilerplate with AZ Code Generator
- AZ Code Generator Integration with Waf
- AZ Code Generator Parameters
- Code Generation Templates
- Template Drivers
- Custom Code Generator Annotations
- Waf Debugging with AZ Code Generator
  - Setting Up PyCharm for Debugging Waf
- Template Driver Debugging
- Debugging the AZ Code Generator Utility
- Intermediate JSON Data Format
Blog, Forums, and Feedback
Legal
- Lumberyard Redistributables
- Alternate Web Services
Documentation Archive
Glossary

Navigating the Lumberyard Documentation

Amazon Lumberyard offers the following guides:

Amazon Lumberyard Getting Started Guide – Get familiar with Lumberyard basics, such as navigating the editor, building terrain, and lighting a scene.
Amazon Lumberyard C++ API Reference – Learn more about the fundamental C++ API operations of the Lumberyard component entity system.
Amazon Lumberyard Release Notes – Learn more about improvements, highlights, and known issues for Lumberyard features and systems.
Amazon Lumberyard Legacy Reference – Learn more about legacy features and tools for Lumberyard.

To navigate the Lumberyard documentation

To search in a specific guide, go to the guide that you want (for example, the Amazon Lumberyard Getting Started Guide) and in the search box, enter your keyword.
To search all Lumberyard documentation, in the drop-down menu, choose Documentation – This Product, and in the search box, enter your keyword.
In the header, use the path to navigate to other pages:
1. Choose AWS Documentation for all other AWS services.
2. Choose Lumberyard to go to the main Lumberyard documentation page.
3. Choose the guide name to go back to the home page.
You can also use the menu icon to see the documentation for other AWS services.

Warning Javascript is disabled or is unavailable in your browser.

To use the AWS Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions.

Document Conventions

« Previous Next »

© 2018, Amazon Web Services, Inc. or its affiliates. All rights reserved.