Open 3D Engine (O3DE) User Guide

Welcome to the O3DE User Guide! This documentation contains information and guidance for users working on an O3DE project.

Read about the features provided by Open 3D Engine.

DocumentationDetails
AssetsLearn about O3DE’s asset management tools and pipeline.
BuildLearn how to use the CMake generator with O3DE projects to generate IDE projects and build them.
ComponentsLearn about the components that add functionality to your entities in O3DE.
EditorLearn how to use the O3DE Editor.
Settings RegistryLearn how to use the Settings Registry to maintain settings and configurations for O3DE applications and tools.
GemsLearn about the Gems that extend O3DE.
InteractivityLearn how to simulate robots, implement player navigation controls and other world interaction methods.
NetworkingLearn about the low-level networking stack in O3DE and the multiplayer framework that uses it to provide multiplayer features in games and simulations.
ProfilingLearn about the performance and memory profiling tools available for the GPU and the CPU in 03DE.
OptimizationLearn how to optimize your O3DE project.
PackagingLearn how to package your O3DE-based product for release.
ProgrammingLearn about core engine programming concepts in O3DE.
Project ConfigurationLearn how to configure and customize your O3DE project.
Remote ContentLearn about Remote Content, a built-in way to share and download Gems, Projects and Templates.
ScriptingLearn about Script Canvas, O3DE’s visual scripting solution, and Lua to create logic and behaviors in your project.
TestingLearn how to test your O3DE components and project.
VisualizationLearn about Atom-based visualization components in O3DE.

Reference documentation

DocumentationDetails
GlossaryCommon terms and concepts used in O3DE development.
Asset file typesReference for the asset file types supported in O3DE by default.
Console variable referenceReference for the O3DE console variables (CVARs).
Log filesLearn where to find common log files in O3DE.
DocumentationDetails
Tutorials and ExamplesCheck out video tutorials, written tutorials, and samples to practice the concepts and techniques that you learn from the sections of the User Guide.

Editor

Learn about the elements and features of Open 3D Engine’s (O3DE) Editor.

Project Configuration

Learn the basics of project configuration in Open 3D Engine (O3DE), and get the details on the Project Manager and O3DE CLI tools.

Build

Learn the basics of Open 3D Engine’s support for the CMake build system, and get started with your first full build of the Open 3D Engine Source and Atom test project.

Action Manager

Learn how to create or extend editor behaviors, menus, toolbars and hotkeys.

Settings Registry

Learn how to provide settings and configuration options for the tools and applications in Open 3D Engine (O3DE) with the Settings Registry.

Gems

You can use Gems to add features and assets to your Open 3D Engine game project.

Components

Programming

Learn about the core systems of Open 3D Engine (O3DE) and how you can extend those systems by programming.

Assets

The complete guide to assets, asset processing, and the Asset Pipeline in Open 3D Engine (O3DE).

Interactivity and simulation

Scripting

Learn about the scripting languages supported in Open 3D Engine (O3DE) to add gameplay logic and behaviors in your project.

Networking

Learn about the low-level networking stack in Open 3D Engine (O3DE) and the Multiplayer Gem that uses it to provide multiplayer features in games and simulations.

Visualization

Learn about the various systems that provide animation and rendering in Open 3D Engine (O3DE).

Profiling

Learn about the profiling tools for Open 3D Engine.

Optimization

Testing

Platforms

Learn about the platforms supported by Open 3D Engine.

Packaging and Release

Learn how to create release and content update packages for your Open 3D Engine (O3DE) project.

Remote Content

You can share and download Gems, Projects and Templates in Remote Repositories.

Appendix