Access the Settings Registry with Console Commands

The Settings Registry registers a list of commands with AZ::Console that allow you to add, update, or delete a key within the Settings Registry, and dump keys to the Console output window.

Console command list

Settings Registry Console commands have the prefix sr_, which stands for Settings Registry.

Examples

Use sr_regset to update or add a value

The following Console command examples update the project root path in the Settings Registry.

Use sr_regremove to remove a key value

The following Console command examples remove keys and their values from the Settings Registry.

Use the sr_regdump command to output a value

The following Console command examples output the values of specified keys to the Console.

Use the sr_regdumpall command to output the entire Settings Registry

The following Console command outputs the entire Settings Registry to the Console.

Use the sr_dump_origin command to output the filepath that last modified a key

The following Console command outputs the filepath responsible for the latest modification of each key to the Console. The code block shows an example of merging 2 JSON files in order and querying the file origin of "/Your/Custom/Setting1".

file1.setreg

{
    "Your": { "Custom": { "Setting1": "initialValue"} }
}

file2.setreg

{
    "Your": { "Custom": { "Setting1": "overrideValue"} }
}

Use the sr_regset_file command to merge a Settings Registry file

The following Console command merges a Settings Registry file to the Settings Registry from the Console. The file must be JSON formatted. The code block shows an example JSON file named engine.json with an example value for the engine_name key.

engine.json

{
   "engine_name": "o3de"
}