GCMod

Configuration

Configuration reference and runtime behavior for gcm_referral.

Root config (config.lua)

Config.Debug
  • Type: boolean
  • Current: true
  • Allowed: true / false
  • Impact: Enables debug prints through debugger(...).
Config.Language
  • Type: string
  • Current: 'en'
  • Allowed: locale JSON names under locales/*.json
  • Impact: Selects UI/messages language loaded at runtime.
Config.CodePrefix
  • Type: string
  • Current: 'GCM'
  • Allowed: alphanumeric prefix
  • Impact: Prefix for generated referral codes.
Config.AutomaticIntro
  • Type: boolean
  • Current: true
  • Allowed: true / false
  • Impact: Auto-opens intro UI for players without claimed code.
Config.AutomaticIntroTime
  • Type: number
  • Current: 10
  • Allowed: positive seconds
  • Impact: Delay before intro opens when automatic intro is enabled.
Config.SplitPoints
  • Type: boolean
  • Current: false
  • Allowed: true / false
  • Impact: Splits claim points between claimer and referrer when enabled.
Config.GroupPermissions
  • Type: string[]
  • Current: ['god', 'admin', 'superadmin']
  • Allowed: framework/ACE groups
  • Impact: Controls admin access to referral management actions.
Config.ClaimOnUseCode.enabled
  • Type: boolean
  • Current: false
  • Allowed: true / false
  • Impact: Enables point rewards when a referral code is claimed.
Config.ClaimOnUseCode.points
  • Type: number
  • Current: 10
  • Allowed: integer >= 0
  • Impact: Points granted on successful code claim.
Config.Command.enabled
  • Type: boolean
  • Current: true
  • Allowed: true / false
  • Impact: Enables slash command access to the referral panel.
Config.Command.command
  • Type: string
  • Current: 'referral'
  • Allowed: valid command name
  • Impact: Command players use to open panel (e.g. /referral).
Config.KeyBind.enabled
  • Type: boolean
  • Current: true
  • Allowed: true / false
  • Impact: Enables keyboard key mapping for panel opening.
Config.KeyBind.key
  • Type: string
  • Current: 'F7'
  • Allowed: valid FiveM keyboard mapping key
  • Impact: Default bound key for referral panel command.
Config.VipsList
  • Type: table[]
  • Current: Silver/Gold/Platinum/Diamond pairs (name + value)
  • Allowed: list of label/value pairs
  • Impact: Populates VIP type options displayed in UI.
Config.Logs.enabled
  • Type: boolean
  • Current: true
  • Allowed: true / false
  • Impact: Enables webhook logging for admin/claims/items/purchases/codes/categories.
Config.Logs.webhooks.*
  • Type: string
  • Current: Discord webhook URLs in sample config
  • Allowed: valid https://discord.com/api/webhooks/... URL per channel
  • Impact: Defines destination webhook for each log category.
Previous
Installation
Next
Commands