Gem Reference in Open 3D Engine
Gems are redistributable packages that contain source code and assets that you can include in your Open 3D Engine (O3DE) projects to add new functionality. O3DE provides the following Gems:
Animation
| Gem | Description |
|---|---|
| EMotion FX Animation | The EMotion FX Animation Gem provides Open 3D Engine’s animation system for rigged actors and includes Animation Editor, a tool for creating animated behaviors, simulated objects, and colliders for rigged actors. |
| Maestro Cinematics | The Maestro Cinematics Gem provides Track View, Open 3D Engine’s animated sequence and cinematics editor. |
Artificial Intelligence
| Gem | Description |
|---|---|
| Kythera AI | The Kythera AI Gem provides support for Kythera AI features in Open 3D Engine (O3DE), and includes a demo project, levels, and assets that demonstrate the features of Kythera AI. |
| Recast Navigation | The Recast Navigation Gem provides support for building navigation meshes and calculating walkable paths within those navigation meshes. It uses open source library Recast Navigation . An example of its use can be found in AutomatedTesting project in Navigation Sample level. |
Assets
| Gem | Description |
|---|---|
| Asset Validation | The Asset Validation Gem provides seed-related commands to ensure assets have valid seeds for asset bundling. |
| Custom Asset Example | The Custom Asset Example Gem provides example code for creating a custom asset for Open 3D Engine’s asset pipeline. |
| Dev Textures | The Dev Textures Gem provides a collection of general purpose texture assets useful for prototypes and preproduction. |
| Prefab Builder | The Prefab Builder Gem provides an Asset Processor module for prefabs, which are complex assets built by combining smaller entities. |
| Primitive Assets | The Primitive Assets Gem provides primitive shape mesh objects with physics enabled. |
| Scene Processing | The Scene Processing Gem provides FBX Settings, a tool you can use to specify the default settings for processing .fbx files for actors, meshes, motions, and PhysX. |
| Test Asset Builder | The Test Asset Builder Gem is used to feature test Asset Processor. |
Audio
| Gem | Description |
|---|---|
| Audio Engine Wwise | The Wwise Audio Engine Gem provides support for Audiokinetic Wave Works Interactive Sound Engine (Wwise). |
| Audio System | The Audio System Gem provides the Audio Translation Layer (ATL), which adds support for audio in your Open 3D Engine projects. |
| Microphone | The Microphone Gem provides support for audio input through microphones. |
| MiniAudio | The MiniAudio Gem provides support for audio playback and positioning using MiniAudio . |
AWS
| Gem | Description |
|---|---|
| AWS Client Auth | The AWS Client Auth Gem provides solutions for client authentication and AWS authorization. |
| AWS Core | The AWS Core Gem provides basic shared AWS functionality such as AWS SDK initialization and client configuration. |
| AWS Metrics | The AWS Metrics Gem provides a solution for AWS metrics submission and analytics. |
| AWS GameLift | The AWS GameLift Gem provides a framework to extend the O3DE networking layer and Multiplayer Gem to work with Amazon GameLift. |
Core
| Gem | Description |
|---|---|
| O3DE Core (LmbrCentral) | The O3DE Core (LmbrCentral) Gem provides required code and assets for running Open 3D Engine Editor. |
Debug
| Gem | Description |
|---|---|
| Crash Reporting | The Crash Reporting Gem provides support for external crash reporting for Open 3D Engine projects. |
| Debug Draw | The Debug Draw Gem provides Editor and runtime debug visualization features for Open 3D Engine. |
| Immediate Mode GUI (IMGUI) | The Immediate Mode GUI Gem provides the 3rdParty library IMGUI which can be used to create run time immediate mode overlays for debugging and profiling information in Open 3D Engine. |
| Remote Tools | The Remote Tools Gem facilitates connections between Open 3D Engine applications for debugging purposes. |
Design
| Gem | Description |
|---|---|
| White Box | The White Box Gem provides White Box rapid design components for Open 3D Engine. |
Environment
| Gem | Description |
|---|---|
| Landscape Canvas | The Landscape Canvas Gem provides the Landscape Canvas editor; a node-based graph tool for authoring workflows to populate landscape with dynamic vegetation. |
| Surface Data | The Surface Data Gem provides functionality to emit signals or tags from surfaces such as meshes and terrain. |
| Vegetation | The Vegetation Gem provides tools to place natural-looking vegetation in Open 3D Engine. |
| Terrain | The Terrain Gem provides a terrain system that maps height, color, and surface data to regions of the world. It also provides gradient-based and shape-based authoring tools and workflows, integrates with physics for physical simulation and efficiently renders terrain. |
Framework
| Gem | Description |
|---|---|
| Graph Canvas | The Graph Canvas Gem provides a C++ framework for creating custom graphical node based editors for Open 3D Engine. |
| Graph Model | The Graph Model Gem provides a generic node graph data model framework for Open 3D Engine. |
Gameplay
| Gem | Description |
|---|---|
| Achievements | The Achievements Gem provides a target platform agnostic interface for retrieving achievement details and unlocking achievements. |
| Game State | The Game State Gem provides functionality to determine and manage game states in Open 3D Engine projects. |
| Game State Samples | The Game State Samples Gem provides a set of sample game states (built on top of the Game State Gem), including primary user selection, main menu, level loading, level running, and level paused. |
| Tick Bus Order Viewer | The Tick Bus Order Console Variable Gem provides a console variable that displays the order of runtime tick events. |
Input
| Gem | Description |
|---|---|
| Gestures | The Gestures Gem provides detection for common gesture-based input actions. |
| Local User | The Local User Gem provides functionality for mapping local user ids to local player slots and managing local user profiles. |
| Starting Point Input | The Starting Point Input Gem provides functionality to map low-level input events to high-level actions. |
| Starting Point Movement | The Starting Point Movement Gem provides a series of Lua scripts that listen and respond to input events. |
| Virtual Gamepad | The Virtual Gamepad Gem provides controls that emulate a gamepad on touch screen devices. |
Multiplayer
| Gem | Description |
|---|---|
| Multiplayer | The Multiplayer Gem provides high-level, advanced multiplayer gameplay functionality such as entity replication, local prediction, and server-side backward reconciliation. |
| Multiplayer Compression | The Multiplayer Compression Gem provides an open-source compressor to use with the Multiplayer Gem. |
Network
| Gem | Description |
|---|---|
| Certificate Manager | The Certificate Manager Gem provides access to authentication files for secure game connections from Amazon S3, files on disk, and other 3rd party sources. |
| Http Requestor | The HTTP Requestor Gem provides functionality to make asynchronous HTTP/HTTPS requests and return data through a user-provided call back function. |
| Metastream | The Metastream Gem provides functionality for an HTTP server that allows broadcasters to customize game streams with overlays of statistics and event data from a game session. |
| Presence | The Presence Gem provides a target platform agnostic interface for Presence services. |
| Twitch | The Twitch Gem provides access to the Twitch API v5 SDK including social functions, channels, and other APIs. |
Physics
| Gem | Description |
|---|---|
| NVIDIA Cloth (NvCloth) | The NVIDIA Cloth (NvCloth) Gem provides functionality to create realistic cloth and fabric simulation. |
| PhysX | The PhysX Gem provides physics simulation with NVIDIA PhysX including static and dynamic rigid body simulation, force regions, ragdolls, and dynamic PhysX joints. |
| PhysX Debug | The PhysX Debug Gem provides debugging functionality and visualizations for PhysX in Open 3D Engine (O3DE) projects. |
Rendering
| Gem | Description |
|---|---|
| Atom Common Features | The Atom Gem provides Atom Renderer and its associated tools (such as Material Editor), utilities, libraries, and interfaces. |
| Atom Content | The Atom Content Gem provides assets including models, textures, and materials, that can be used to test Atom Renderer in Open 3D Engine. |
| Atom O3DE Integration | The Atom O3DE Integration Gem provides components, libraries, and functionality to support and integrate Atom Renderer in Open 3D Engine. |
| Atom TressFX | The Atom TressFX Gem provides realistic hair and fur simulation and rendering in Atom and Open 3D Engine. |
| Camera | The Camera Gem provides a basic camera component that defines a frustum for runtime rendering. |
| Camera Framework | The Camera Framework Gem provides a base for implementing more complex camera systems. |
| Open Particle System | The Open Particle System Gem provides a particle simulation and rendering system, for visual effects. |
| PBR Reference Materials | The PBR Reference Materials Gem provides physically based reference materials for Open 3D Engine (O3DE) projects. |
| Stars | The Stars Gem provides physically-based animated resolution-independent distant stars. |
| Starting Point Camera | The Starting Point Camera Gem provides the behaviors used with the Camera Framework Gem to define a camera rig. |
| Video Playback Framework | The Video Playback Framework Gem provides the interface to play back video. |
Robotics
| Gem | Description |
|---|---|
| Human Worker | The Human Worker Gem provides a collection of animated human worker assets that can be used in robotic simulations. |
| Level Geo-referencing | The Level Geo-referencing Gem provides a way to reference real-world coordinates in robotic simulations. |
| OTTO Robots | The OTTO Robots Gem provides a collection of autonomous mobile robots assets that can be used in robotic simulations. |
| RGL | The Robotec GPU Lidar (RGL) Gem for Open 3D Engine (O3DE) enables GPU-accelerated LiDAR simulation for robotics. |
| ROS 2 | The ROS 2 Gem provides integration with the Robot Operating System (ROS) 2 library and enables the design of the simulation of robotics systems. |
| ROS 2 Controllers | The ROS 2 Controllers Gem enables robot control, manipulation, grippers, and vehicle dynamics in robotic simulations. |
| ROS 2 Robot Importer | The ROS 2 Robot Importer Gem allows you to import robots from URDF, SDFormat, and XACRO formats into O3DE. |
| ROS 2 Sensors | The ROS 2 Sensors Gem provides a collection of components to generate simulated sensor data in robotic simulations. |
| Simulation Interfaces | The Simulation Interfaces Gem allows to control the simulation and the simulation environment in O3DE using standardized ROS 2 API. |
| UR Robots | The UR Robots Gem provides a collection of robotic arms assets that can be used in robotic simulations. |
Script
| Gem | Description |
|---|---|
| Editor Python Bindings | The Editor Python Bindings Gem provides Python commands for Open 3D Engine Editor functions. |
| Expression Evaluation | The Expression Evaluation Gem provides a method for parsing and executing string expressions. |
| Python Asset Builder | The Python Asset Builder Gem provides functionality to implement custom asset builders in Python for Asset Processor. |
| Script Canvas | The Script Canvas Gem provides Open 3D Engine’s visual scripting environment Script Canvas. |
| Script Canvas Developer | The Script Canvas Developer Gem provides a suite of utility features for the development and debugging of Script Canvas systems. |
| Script Canvas Physics | The Script Canvas Physics Gem provides Script Canvas nodes for physics scene queries such as raycasts. |
| Script Canvas Testing | The Script Canvas Testing Gem provides a framework for testing for and with Script Canvas. |
| Scripted Entity Tweener | The Scripted Entity Tweener Gem provides a script driven animation system for Open 3D Engine projects. |
| Script Events | The Script Events Gem provides a framework for creating event assets usable from any scripting solution in Open 3D Engine. |
| Qt for Python | The Qt for Python Gem provides the PySide2 Python libraries to manage Qt widgets. |
SDK
| Gem | Description |
|---|---|
| In-App Purchases | The In-App Purchases Gem provides functionality for in app purchases in Open 3D Engine projects. |
UI
| Gem | Description |
|---|---|
| LyShine | The LyShine Gem provides the runtime UI system and creation tools for Open 3D Engine projects. |
| LyShine Examples | The LyShine Examples Gem provides example code and assets for LyShine, the runtime UI system and editor for Open 3D Engine projects. |
| Message Popup | The Message Popup Gem provides an example implementation of popup messages in an Open 3D Engine project. |
| UI Basics | The UI Basics Gem provides a collection of assets that can be used with LyShine, the Open 3D Engine runtime User Interface system and editor. |
Utility
| Gem | Description |
|---|---|
| Fast Noise | The Fast Noise Gradient Gem uses the third-party, open source FastNoise library to provide a variety of high-performance noise generation algorithms. |
| Gradient Signal | The Gradient Signal Gem provides a number of components for generating, modifying, and mixing gradient signals. |
| Save Data | The Save Data Gem provides an API to save runtime data in Open 3D Engine projects. |
| Scene Logging Example | The Scene Logging Example Gem demonstrates the basics of extending the Open 3D Engine SceneAPI by adding additional logging to the pipeline. |
| Texture Atlas | The Texture Atlas Gem provides the formatting for texture atlases in Open 3D Engine. |
Achievements
The Achievements Gem provides a target platform agnostic interface for retrieving achievement details and unlocking achievements for Open 3D Engine (O3DE) projects.
Asset Validation
The Asset Validation Gem provides seed-related commands to ensure assets have valid seeds for asset bundling.
Atom Common Features
The Atom Common Features Gem provides Atom Renderer and its associated tools (such as Material Editor), utilites, libraries, and interfaces.
Atom Content
The Atom Content Gem provides assets including models, textures, and materials, that can be used to test Atom Renderer in Open 3D Engine.
Atom O3DE Integration
The Atom O3DE Integration Gem provides components, libraries, and functionality to support and integrate Atom Renderer in Open 3D Engine (O3DE).
Atom TressFX
The Atom TressFX Gem provides realistic hair and fur simulation and rendering in Atom and Open 3D Engine (O3DE).
Audio System
The Audio System Gem adds support for audio in Open 3D Engine (O3DE) projects.
AWS Gems
Use AWS Gems to access AWS cloud-connected services in Open 3D Engine (O3DE).
Camera
The Camera Gem provides a basic camera component that defines a frustum for runtime rendering.
Camera Framework
The Camera Framework Gem provides a base for implementing more complex camera systems.
Certificate Manager
The Certificate Manager Gem provides access to authentication files for secure game connections from S3, files on disk, and other 3rd party sources.
Crash Reporting
The Crash Reporting Gem provides support for external crash reporting for Open 3D Engine (O3DE) projects.
Custom Asset Example
The Custom Asset Example Gem provides example code for creating a custom asset for Open 3D Engine’s (O3DE) asset pipeline.
Debug Draw
The Debug Draw Gem provides Editor and runtime debug visualization features for Open 3D Engine (O3DE).
Dev Textures
The Dev Textures Gem provides a collection of general purpose texture assets useful for prototypes and preproduction.
Editor Python Bindings
The Editor Python Bindings Gem provides Python commands for Open 3D Engine (O3DE) Editor functions.
EMotion FX Animation
The EMotion FX Animation Gem provides Open 3D Engine’s animation system for rigged actors including Animation Editor, a tool for creating animated behaviors, simulated objects, and colliders for rigged actors.
Environment
The Environment Gems provide the tools and framework to create natural-looking vegetation in Open 3D Engine (O3DE) projects.
Expression Evaluation
The Expression Evaluation Gem provides a method for parsing and executing string expressions in Open 3D Engine (O3DE).
Fast Noise
The Fast Noise Gradient Gem uses the third-party, open source FastNoise library to provide a variety of high-performance noise generation algorithms in Open 3D Engine (O3DE).
Game State
The Game State Gem provides functionality to determine and manage game states in Open 3D Engine (O3DE) projects.
Game State Samples
The Game State Samples Gem provides a set of sample game states (built on top of the generic Game State Gem), including primary user selection, main menu, level loading, level running, and level paused.
Gestures
The Gestures Gem provides detection for common gesture-based input actions in Open 3D Engine (O3DE).
Gradient Signal
The Gradient Signal Gem provides a number of components for generating, modifying, and mixing gradient signals in Open 3D Engine (O3DE) projects.
Graph Canvas
The Graph Canvas Gem provides a C++ framework for creating custom graphical node based editors for Open 3D Engine (O3DE).
Graph Model
The Graph Model Gem provides a generic node graph data model framework for Open 3D Engine (O3DE).
HTTP Requestor
The HTTPRequestor Gem provides functionality to make asynchronous HTTP/HTTPS requests and return data through a user-provided call back function.
Human Worker
The Human Worker Gem provides a collection of animated human worker assets that can be used in robotic simulations with Robot Operating System (ROS) 2 in Open 3D Engine (O3DE).
Immediate Mode GUI (ImGui)
The Immediate Mode GUI (ImGui) Gem provides the 3rdParty library Dear ImGui which can be used to create runtime immediate mode overlays for debugging and profiling in Open 3D Engine (O3DE) projects.
In-App Purchases
The In-App Purchases Gem provides functionality for in app purchases in Open 3D Engine (O3DE) projects.
Kythera AI
The Kythera AI Gem provides support for Kythera AI features in Open 3D Engine (O3DE), and includes a demo project, levels, and assets that demonstrate the features of Kythera AI.
Level Georeferencing
The Level Georeferencing Gem provides a way to reference real-world coordinates in Open 3D Engine (O3DE) levels.
Local User
The Local User Gem provides functionality for mapping local user ids to local player slots and managing local user profiles.
LyShine
The LyShine Gem provides the runtime UI system and creation tools for Open 3D Engine projects.
LyShine Examples
The LyShine Examples Gem provides example code and assets for LyShine, the runtime UI system for Open 3D Engine (O3DE) projects.
Maestro Cinematics
The Maestro Cinematics Gem provides Track View, Open 3D Engine’s animated sequence and cinematics editor.
Message Popup
The Message Popup Gem provides an example implementation of popup messages in an Open 3D Engine (O3DE) project.
Metastream
The Metastream Gem provides functionality for an HTTP server that allows broadcasters to customize game streams with overlays of statistics and event data from a game session.
Microphone
The Microphone Gem provides support for audio input through microphones in Open 3D Engine (O3DE) projects.
MiniAudio
The MiniAudio Gem provides support for audio playback using MiniAudio in Open 3D Engine (O3DE) projects.
Multiplayer
Create multiplayer games with the Open 3D Engine (O3DE) Multiplayer Gem.
Multiplayer Compression
Open 3D Engine (O3DE) offers a sample Gem containing an implementation of compression.
NVIDIA Cloth
The NVIDIA Cloth Gem provides functionality to create fast, realistic cloth simulation with the NVIDIA Cloth library.
O3DE Core (LmbrCentral)
The O3DE Core (LmbrCentral) Gem provides required code and assets for running Open 3D Engine Editor.
Open Particle System
The Open Particle System Gem provides particle simulation and rendering for special effects
OTTO Robots
The OTTO Robots Gem provides a collection of autonomous mobile robots assets that can be used in robotic simulations with Robot Operating System (ROS) 2 in Open 3D Engine (O3DE).
PBR Reference Materials
The PBR Reference Materials Gem provides physically based reference materials for Open 3D Engine (O3DE) projects.
PhysX
The PhysX Gem provides physics simulation with NVIDIA PhysX including static and dynamic rigid body simulation, force regions, ragdolls, and dynamic PhysX joints.
PhysX Debug
The PhysX Debug Gem provides debugging functionality and visualizations for PhysX in Open 3D Engine (O3DE) projects.
Prefab Builder
The Prefab Builder Gem provides an Asset Processor module for prefabs, which are complex assets built by combining smaller entities.
Presence
The Presence Gem provides a target platform agnostic interface for Presence services.
Primitive Assets
The Primitive Assets Gem provides primitive shape meshes with physics enabled for Open 3D Engine (O3DE).
Python Asset Builder
The Python Asset Builder Gem provides functionality to implement custom asset builders in Python for Asset Processor.
Qt for Python
The Qt for Python Gem provides the PySide2 Python libraries to manage Qt widgets.
Recast Navigation
The Recast Navigation Gem provides navigation mesh calculation and path finding functionality and visualizations in Open 3D Engine (O3DE) projects.
Remote Tools
The Remote Tools Gem provides an API for O3DE applications to connect to each other for debugging purposes.
RGL
The Robotec GPU Lidar (RGL) Gem for Open 3D Engine (O3DE) enables GPU-accelerated LiDAR simulation for robotics.
ROS 2
The ROS 2 Gem helps build robotic simulations with Robot Operating System (ROS) 2 in Open 3D Engine (O3DE).
ROS 2 Controllers
The ROS 2 Controllers Gem extends the ROS 2 Gem with robot control, manipulation, grippers, and vehicle dynamics.
ROS 2 Robot Importer
The ROS 2 Robot Importer Gem allows you to import robots from URDF, SDFormat, and XACRO formats into Open 3D Engine (O3DE).
ROS 2 Sensors
The ROS 2 Sensors Gem extends the ROS 2 Gem with sample sensor implementations.
Save Data
The Save Data Gem provides an API to save runtime data in Open 3D Engine (O3DE) projects.
Scene Logging Example
The Scene Logging Example Gem demonstrates the basics of extending the Open 3D Engine (O3DE) SceneAPI by adding additional logging to the pipeline.
Scene Processing
The Scene Processing Gem provides FBX Settings to specify the default settings for processing .fbx files for actors, meshes, motions, and PhysX.
Script Canvas
The Script Canvas Gem provides Open 3D Engine’s (O3DE) visual scripting environment Script Canvas.
Script Canvas Developer
The Script Canvas Developer Gem provides a suite of utility features for the development and debugging of Script Canvas systems.
Script Canvas Physics
The Script Canvas Physics Gem provides Script Canvas nodes for physics scene queries.
Script Canvas Testing
The Script Canvas Testing Gem provides a framework for testing for and with Script Canvas.
Script Events
The Script Events Gem provides a framework for creating event assets usable from any scripting solution in Open 3D Engine (O3DE).
Scripted Entity Tweener
The Scripted Entity Tweener Gem provides a script driven animation system for Open 3D Engine (O3DE) projects.
Simulation Interfaces
The Simulation Interfaces Gem provides a set of interfaces for simulating robots in Open 3D Engine (O3DE).
Stars
The Stars Gem provides physically-based animated resolution-independent distant stars.
Starting Point Camera
The Starting Point Camera Gem provides the behaviors used with the Camera Framework Gem to define a camera rig.
Starting Point Input
The Starting Point Input Gem provides functionality to map low-level input events to high-level actions in Open 3D Engine (O3DE).
Starting Point Movement
The Starting Point Movement Gem provides a series of Lua scripts that listen and respond to input events in Open 3D Engine (O3DE).
Test Asset Builder
The Test Asset Builder Gem is used to feature test Asset Processor.
Texture Atlas
The Texture Atlas Gem provides the formatting for texture atlases in Open 3D Engine (O3DE).
Tick Bus Order Viewer
The Tick Bus Order Viewer Gem provides a console variable that displays the order of runtime tick events in Open 3D Engine (O3DE) projects.
Twitch
The Twitch Gem provides access to the Twitch API v5 SDK including social functions, channels, and other APIs.
UI Basics
The UI Basics Gem provides a collection of assets that can be used with LyShine, the Open 3D Engine (O3DE) runtime User Interface system and editor.
UR Robots
The UR Robots Gem provides a collection of robotic arms assets that can be used in robotic simulations with Robot Operating System (ROS) 2 in Open 3D Engine (O3DE).
Video Playback Framework
The Video Playback Framework Gem provides the interface to play back video in an Open 3D Engine (O3DE) project.
Virtual Gamepad
The Virtual Gamepad Gem provides controls that emulate a gamepad on touch screen devices for Open 3D Engine (O3DE) projects.
White Box
The White Box Gem provides White Box rapid design components for Open 3D Engine (O3DE).
Wwise Audio Engine
The Wwise Audio Engine Gem provides support for using Audiokinetic Wave Works Interactive Sound Engine (Wwise) in Open 3D Engine (O3DE) projects.