Settings Registry

With the Settings Registry, you can provide settings and configurations for Open 3D Engine (O3DE) applications and tools.

Settings are stored in JSON files with .setreg and .setregpatch extensions. You can define, query, and change O3DE application settings using JSON Pointer syntax . In the following example, the JSON Pointer path is "/O3DE/CustomSetting":

{
    "O3DE": {
        "CustomSetting": false
    }
}

Settings can be merged and modified through JSON Patch or the JSON Merge Patch format files.

You can interact with the Settings Registry in O3DE through the following methods:

Topics

Topic	Description
Command Line Arguments and the Settings Registry	Learn how to modify the Settings Registry from the command line and access the command line supplied to the application.
Settings Registry Script API	Learn the Settings Registry Script API with examples for Python and Lua.
Access the Settings Registry with Console Commands	Use Console commands to read and modify the Settings Registry.
Issue Console Commands from the Settings Registry	Learn how to run Console commands using the Settings Registry.
Output the Settings Registry to Stream with C++	Output the Settings Registry to an IO stream with C++.
Settings Registry Developer Guide	Provides detailed developer information about the Settings Registry. Settings Registry examples are provided for multiple scenarios. The interaction between the CMake Build Generation system, the Settings Registry, and the Gem Module System are described in detail.
Gem Loading and the Settings Registry	Learn how the Settings Registry is used to load Gem Modules and configure Gem settings.
Settings Registry Chaining	Learn how the Settings Registry can trigger imports of other Settings Registry files.

Topic	Description
Gem Module system	Explains how O3DE Loads and Initializes Gems in C++.

Command Line Arguments

Learn how to modify settings through command line arguments and access command line arguments stored in the Settings Registry in Open 3D Engine (O3DE).

Script API

Learn how the Settings Registry Script API exposes the Settings Registry to Lua, Python, and Script Canvas in Open 3D Engine (O3DE).

Console Commands

Learn how to access the Settings Registry using AZ Console Commands in Open 3D Engine (O3DE).

Issue Console Commands

Learn how to run Console commands using the Settings Registry in Open 3D Engine (O3DE)

Output the Settings Registry

Learn how to dump an in-memory Settings Registry to stream using C++ in Open 3D Engine (O3DE).

Developer Guide

Explains the Settings Registry feature of O3DE and how developers can interact with it.

API Examples

Provides information about the available Settings Registry APIs with examples

Gem loading and the Settings Registry

Learn how the Settings Registry is used to load and configure Gems.