GCMod

Configuration

Configuration reference and runtime behavior for gcm_vipsystem.



This page documents the runtime parameters in sh_config.lua plus editable adapters.

sh_config.lua

Config.Debug
  • Type: boolean
  • Current: false
  • Allowed: true / false
  • Impact: Enables server debug prints.
Config.Language
  • Type: string
  • Current: 'en'
  • Allowed: 'es' or 'en'
  • Impact: Selects language entries in lang.lua.
Config.MenuAlign
  • Type: string
  • Current: 'bottom-right'
  • Allowed: top-left, top-right, bottom-left, bottom-right
  • Impact: Aligns ox_lib menu position for VIP UI.
Config.UseIdentifier
  • Type: string
  • Current: 'license'
  • Allowed: 'license' or 'steam'
  • Impact: Defines which player identifier is used as VIP key in DB/cache.

Config.DiscordRoles

enable
  • Type: boolean
  • Current: false
  • Impact: Enables Discord role assignment/removal through API calls.
serverId
  • Type: string
  • Current: 'SERVER_ID'
  • Impact: Discord guild ID used for member role edits.

Config.Vips

Each VIP tier key (example: vip_plata) must define:

label
  • Type: string
  • Current examples: 'VIP Plata', 'VIP Oro', 'VIP Diamante'
  • Impact: Display name in menus/notifications.
priority
  • Type: number
  • Current examples: 100, 200, 400
  • Impact: Value pushed in VIP queue payload (Queue:LoadVips).
points
  • Type: number
  • Current examples: 10, 300, 20
  • Impact: Bonus amount used by paycheck system for VIP users.
roleID
  • Type: string
  • Current: '0' (disabled in sample)
  • Allowed: Discord role ID string, or '0' to disable
  • Impact: Discord role assigned/removed when VIP is granted/expired.

Config.PaycheckSystem

enable
  • Type: boolean
  • Current: false
  • Impact: Enables recurring paycheck bonus loop.
account
  • Type: string
  • Current: 'bank'
  • Impact: Money account used when paying users.
interval
  • Type: number
  • Current: 1
  • Unit: minutes
  • Impact: Delay between paycheck cycles.
paidWithoutVip
  • Type: boolean
  • Current: false
  • Impact: If enabled, non-VIP users also receive base amount.
pointWithoutVipQuantity
  • Type: number
  • Current: 5
  • Impact: Non-VIP payout amount when paidWithoutVip is enabled.

Config.GroupPermissions

Config.GroupPermissions
  • Type: string[]
  • Current: ['god', 'admin', 'superadmin']
  • Impact: Staff gate for VIP menu command (isPlayerStaff).

Config.Commands

Config.Commands['redeem_code']
  • Type: string
  • Current: 'code'
  • Impact: Command label for VIP code redemption.
Config.Commands['open_vip_menu']
  • Type: string
  • Current: 'vipmenu'
  • Impact: Command label for staff VIP management menu.

Config.DiscordLogs

enable
  • Type: boolean
  • Current: false
  • Impact: Enables webhook log posts for VIP actions.
webhook_givevips, webhook_removevips, webhook_generateCode, webhook_editVIP, webhook_Tebex, webhook_redeemCode
  • Type: string
  • Current: Example value format 'https://discord.com/api/webhooks/<id>/<token>'
  • Impact: Endpoint targets for each log category.

Editable files

server/editablesv.lua

botToken
  • Type: string
  • Current: 'YOUR_BOT_TOKEN'
  • Impact: Required when Config.DiscordRoles.enable = true.
isPlayerStaff(src)
  • Type: function
  • Impact: Permission adapter for /vipmenu access.
gcm_vips:notifyPaycheck / gcm_vips:server:OnVipAdd
  • Type: events/hooks
  • Impact: Custom behavior extension points for paycheck notify and VIP grant side effects.

client/editablecl.lua

notify(msg, type)
  • Type: function
  • Impact: Centralized client notification renderer for VIP resource.
Previous
Exports and Statebags
Next
Connectqueue Integration