Lumberyard

User Guide (Version 1.14)

What Is Lumberyard?
- Lumberyard Systems
- Lumberyard Editors and Tools
- Lumberyard Asset File Types
- Navigating the Lumberyard Documentation
- Key Lumberyard Terminology
Setting Up Lumberyard
- System Requirements
- Downloading Lumberyard
- Upgrading Lumberyard
- Files to Exclude When Upgrading Lumberyard
- Using Lumberyard Setup Assistant to Set Up Your Development Environment
- Enabling a Firewall
- Using the Perforce Plugin with Lumberyard
- Uninstalling Amazon Lumberyard
Creating Lumberyard Game Projects
- Creating and Switching Game Projects
- Configuring Advanced Settings
- Understanding the Project Configurator
- Troubleshooting
- Managing Game Projects with Lmbr.exe
Building Your Game Project
Migrating Lumberyard Game Projects
- 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
Using 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
Using Lumberyard 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
- VR Islands Level
- Virtual Reality Samples Project
- In-App Purchases Sample
- Woodland Asset Package – Legacy
- Beach City Sample Project – Legacy
- Legacy Sample Project (GameSDK)
Working with the Asset Pipeline and Asset Files
- Using Asset Processor
  - Importing Assets
  - Using Resource Compiler
- 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 Run-time Asset System
Working with 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
- Behavior Context
- Gameplay Bus
- Reflecting Lumberyard Classes, Methods, and EBus Interfaces
Using Gems to Add Modular Features and Assets
- Enabling Gems
- Creating a Gem
- Programming with Gems
- Gems Available in Lumberyard
Input in Amazon Lumberyard
Creating Levels and Adding 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
Working with 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
Adding Lighting and Shadows
- Environment Lighting
- Environment Shadows
Creating 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
Working with Rendering Cameras
Creating and Animating Characters
- Working With Character Assets
  - Modeling Characters
  - Rigging Characters
- Transitioning from Legacy (Geppetto and Mannequin) to the Lumberyard Animation System (Animation Editor)
- Lumberyard Animation System
  - Working with the FBX Settings
  - Animation Editor (EMotionFX)
Employing Artificial Intelligence
- 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
Adding Particle Effects
- Using the Particle Editor
- Particle Effects Best Practices
- Advanced Particle Techniques
- Particle Debugging with Console Variables
Simulating Physics Behavior with the 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
Creating Gameplay with Script Canvas
- Script Canvas Concepts and Terms
- Script Canvas Editor Interface
- Referencing Entities for Nodes
- Pins and Connections
- Adding Scripts to Entities
- Other Script Canvas Menus and Tools
- Managing Script Canvas Variables
- Adding Comments for Script Canvas
- Adding Bookmarks for Script Canvas
- Script Canvas Tutorials
- Script Canvas Node Reference
  - Rendering Nodes
- Creating Custom Nodes in Script Canvas
- Best Practices
- Script Canvas and the Behavior Context
- Script Canvas Errors and Troubleshooting
Adding Audio and Sound Effects
- Audio System Architecture
- Installing Audiokinetic Wwise and 3D Plugins
  - Replacing Wwise with Full Version
  - Building Lumberyard for 3D Audio
- Installing Audiokinetic Wwise LTX
- Using the Audio Controls Editor
- ATL Default Controls
- Audio PlayTriggers and StopTriggers
- Obstructing and Occluding Sounds
- Adding Ambient Sounds to Levels
- Adding Reverb Effects to Levels
- Adding Collision Sounds to Levels
- Adding Sound to Sequences in the Track View Editor
- Adding Sound to Animations
- Audio Console Variables Commands
Creating Cinematic Sequences
- Cinematics Best Practices
- Using the Track View Editor
- Using Component Entity Sequences or Entity Object Sequences (Legacy)
- Track View Editor Nodes
- Creating Scenes
- Managing Track Events
- Cinematics Cameras
- Cinematics Lighting
- Animating Characters in Scenes
- Adding Player Interactivity
- Capturing Image Frames
- Debugging Cinematic Scenes
Creating and Customizing Game User Interfaces
- 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
Profiling, Testing, and Debugging Game Projects
- Profiler
- Using AZ Test Scanner
- Writing Tests for AzTest
- Statoscope Profiler
- Debugging Issues
- Tracking File Access
Localizing Game Projects
- Localization Checklist
- UI System Localization Features
- Font Features
- Localization Initialization
Creating Game Builds
- Creating Release Builds for PC
- Compiling Shaders for Release Builds
- Adding Custom Game Icons
- Universal Remote Console
- Using the Waf Build System
Engaging Broadcasters and Viewers on 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
Implementing Connected Features with Cloud Canvas
- 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
Using Lumberyard 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
Working with the Event Bus (EBus) System
- Usage and Examples
- Event Buses in Depth
- Common Tasks, EBuses, and Handlers
- Direct Access to EBus Handlers
Lua Scripting
- Adding Lua Scripts to Component Entities
- Basic Structure of a Component Entity Lua Script
- Properties
- Network Binding
- Using EBuses in Lua
- Lua Editor
- Debugging Lua Scripts
- The Lua Environment (Advanced)
- Component Entity Lua API Reference
Creating Virtual Reality Games in Lumberyard
- Configuring your Project for Virtual Reality
  - Configuring OSVR
- Configuring Required Console Variables
- Using the InstantVR Slice
  - InstantVR Lua Script Properties
  - InstantVR Known Issue
- 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
Creating Android and iOS Games
- Android Support
- iOS Support
- Design Considerations for Creating Mobile Games Using Lumberyard
- 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
- Using the AppDetective to Test Your Build on the AWS Device Farm
Creating 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
Creating Lumberyard 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
Automating 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
Glossary
Lumberyard Blog, Forums, and Feedback
Legal
- Lumberyard Redistributables
- Alternate Web Services

PhysX Gem

Lumberyard's PhysX system acts upon entities to create realistic physical effects such as collision detection and rigid body dynamics simulation. Add the PhysX gem to use the PhysX

For more information about the PhysX gem and how to use its features, see Simulating Physics Behavior with the PhysX System.

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.