editor.config

Read/write access to Unreal Engine INI config files and project settings inspection

← API Reference

editor.config.get

Read a config value by section, key, and file.

Parameters:

Name Type Required Description
sectionstringYesINI section name (e.g. /Script/Engine.Engine)
keystringYesKey name within the section
filestringYesConfig file shorthand (Engine, Game, Input, Editor, Scalability, GameUserSettings, DeviceProfiles, EditorPerProjectUserSettings) or a direct path

Returns:

Name Type Description
foundbooleanWhether the key was found
sectionstringSection name queried
keystringKey name queried
filestringResolved config file path
valuestring|nullThe config value (string), or null if not found

Example Request:

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "editor.config.get",
  "params": {
    "section": "/Script/Engine.GarbageCollectionSettings",
    "key": "gc.MaxObjectsNotConsideredByGC",
    "file": "Engine"
  }
}

Example Response:

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "found": true,
    "section": "/Script/Engine.GarbageCollectionSettings",
    "key": "gc.MaxObjectsNotConsideredByGC",
    "file": "../../Saved/Config/Windows/Engine.ini",
    "value": "0"
  }
}

editor.config.set

Write a config value by section, key, and file. Creates the section/key if it doesn't exist.

Parameters:

Name Type Required Description
sectionstringYesINI section name
keystringYesKey name within the section
valuestring|number|boolean|nullYesValue to set (numbers and booleans are converted to strings)
filestringYesConfig file shorthand or direct path

Returns:

Name Type Description
successbooleanAlways true on success
sectionstringSection name written to
keystringKey name written to
valuestringValue that was written (as string)
filestringResolved config file path

Example Request:

{
  "jsonrpc": "2.0",
  "id": 2,
  "method": "editor.config.set",
  "params": {
    "section": "/Script/Engine.GarbageCollectionSettings",
    "key": "gc.MaxObjectsNotConsideredByGC",
    "value": "1024",
    "file": "Engine"
  }
}

Example Response:

{
  "jsonrpc": "2.0",
  "id": 2,
  "result": {
    "success": true,
    "section": "/Script/Engine.GarbageCollectionSettings",
    "key": "gc.MaxObjectsNotConsideredByGC",
    "value": "1024",
    "file": "../../Saved/Config/Windows/Engine.ini"
  }
}

editor.config.getCategories

List all section names in a config file. Useful for discovering available settings sections.

Parameters:

Name Type Required Description
filestringYesConfig file shorthand or direct path

Returns:

Name Type Description
filestringResolved config file path
countnumberNumber of sections found
sectionsstring[]Array of section names

Example Request:

{
  "jsonrpc": "2.0",
  "id": 3,
  "method": "editor.config.getCategories",
  "params": {
    "file": "Engine"
  }
}

Example Response:

{
  "jsonrpc": "2.0",
  "id": 3,
  "result": {
    "file": "../../Saved/Config/Windows/Engine.ini",
    "count": 12,
    "sections": [
      "/Script/Engine.Engine",
      "/Script/Engine.GarbageCollectionSettings",
      "/Script/Engine.StreamingSettings",
      "TextureStreaming"
    ]
  }
}

editor.config.getProjectSettings

Get all key/value pairs within a specific section of a config file.

Parameters:

Name Type Required Description
sectionstringYesINI section name (e.g. /Script/Engine.Engine)
filestringYesConfig file shorthand or direct path

Returns:

Name Type Description
sectionstringSection name queried
filestringResolved config file path
countnumberNumber of key/value pairs
settingsobjectKey/value pairs (all values are strings)

Example Request:

{
  "jsonrpc": "2.0",
  "id": 4,
  "method": "editor.config.getProjectSettings",
  "params": {
    "section": "/Script/Engine.GarbageCollectionSettings",
    "file": "Engine"
  }
}

Example Response:

{
  "jsonrpc": "2.0",
  "id": 4,
  "result": {
    "section": "/Script/Engine.GarbageCollectionSettings",
    "file": "../../Saved/Config/Windows/Engine.ini",
    "count": 3,
    "settings": {
      "gc.MaxObjectsNotConsideredByGC": "0",
      "gc.SizeOfPermanentObjectPool": "0",
      "gc.MaxObjectsInEditor": "12000000"
    }
  }
}