Configuration

Shape the look, timing, and sound of GTM UI from a single config file.

All settings live in config.json at the root of the gtm-ui resource.

Localization

Option	Type	Default	Description
`Localization.Locale`	string	`"en"`	Locale code for UI strings

Theme

Option	Type	Default	Description
`UI.Theme`	`"nui"` \| `"native"` \| `"custom"`	`"nui"`	Rendering theme for all UI

Custom theme exports

When UI.Theme is "custom", point each surface to a resource export in the form "resource:exportName":

Option	Default	Description
`UI.Custom.NotificationExport`	`""`	Custom notification export
`UI.Custom.HelpTextExport`	`""`	Custom help text export
`UI.Custom.InstructionCardExport`	`""`	Custom instruction card export
`UI.Custom.MenuExport`	`""`	Custom menu export

NUI notifications

These apply when the theme is nui:

Option	Type	Default	Description
`UI.Nui.NotificationPosition`	string	`"top-right"`	Where toasts appear
`UI.Nui.NotificationDuration`	number (ms)	`4000`	Default auto-dismiss duration

Positions: top-right, top-left, bottom-right, bottom-left, top-center, bottom-center

Sound

Option	Type	Default	Description
`UI.Sound.Notification`	boolean	`false`	Play a sound with notifications
`UI.Sound.HelpText`	boolean	`false`	Play a sound with help text

Example

{
  "Localization": {
    "Locale": "en"
  },
  "UI": {
    "Theme": "nui",
    "Nui": {
      "NotificationPosition": "top-right",
      "NotificationDuration": 4000
    },
    "Sound": {
      "Notification": false,
      "HelpText": false
    }
  }
}

Restart the resource after saving changes.