Skip to Content

Config

Configure the default behavior, positions, and styling of the Nexus UI components.

All of the configuration lives in config.lua at the root of the resource directory. Since it is escrow-ignored, you can edit it freely.

config.lua
Config = {} Config.PrimaryColor = '#3a7af6' -- The brand accent color used across all components -- Notifications Config.NotificationPosition = 'top-right' Config.NotificationAudio = true -- Text UI Config.TextUIPosition = 'right-center' -- Progress Config.ProgressPosition = 'bottom' -- Menus Config.DefaultMenuPosition = 'top-left' -- Radial Menu default items Config.RadialMenuItems = {} -- Debug Logging Config.Debug = true

Settings breakdown

KeyTypeDefaultWhat it does
PrimaryColorstring'#3a7af6'Hex color code for the brand theme accent (e.g. active buttons, progress bars, and highlighted borders).
NotificationPositionstring'top-right'Default position on screen for notifications. See positions list below.
NotificationAudiobooleantrueWhen true, plays audio prompts for notifications if a sound payload is sent.
TextUIPositionstring'right-center'Default screen position for Text UI tooltips.
ProgressPositionstring'bottom'Default position for the progress bar / circle UI.
DefaultMenuPositionstring'top-left'Default position for the list menu container.
RadialMenuItemstable{}Pre-configured menu options added to the radial menu immediately when the resource starts.
DebugbooleantruePrints resource diagnostic messages to the server console. Set to false in production.

Screen Positions

The positions available for Notifications, Text UI, and Menus are standard screen coordinates:

Notifications

  • 'top'
  • 'top-right' (Default)
  • 'top-left'
  • 'bottom'
  • 'bottom-right'
  • 'bottom-left'
  • 'center-right'
  • 'center-left'

Text UI

  • 'right-center' (Default)
  • 'left-center'
  • 'top-center'
  • 'bottom-center'

List Menus

  • 'top-left' (Default)
  • 'top-right'
  • 'bottom-left'
  • 'bottom-right'
Last updated on