GCMod

Configuration

Configuration reference and runtime behavior for gcm_tattoos.

This resource uses multiple config files under config/.

Root config (config/main.lua)

Config.Language
  • Type: string
  • Current: 'en'
  • Allowed: existing locale file names in locales/*.json
  • Impact: Selects language for notifications/UI labels.
Config.PaymentMethod
  • Type: string
  • Current: 'bank'
  • Allowed: framework account names (commonly bank or cash; ESX maps cash to money)
  • Impact: Defines which account is charged on checkout.
Config.Currency
  • Type: string
  • Current: '$'
  • Allowed: any string symbol
  • Impact: Display currency symbol in UI.
Config.Debug
  • Type: boolean
  • Current: false
  • Allowed: true / false
  • Impact: Enables debug console prints through debugger(...).
Config.UseForceCheckTattoos
  • Type: boolean
  • Current: false
  • Allowed: true / false
  • Impact: If enabled, re-applies tattoos every 30 seconds as a sync safeguard.

Core adapter (config/core.lua)

useCustomCore
  • Type: boolean
  • Current: false
  • Allowed: true / false
  • Impact: Forces custom framework mode and custom event/object hooks.
events.load
  • Type: string
  • Current: 'custom:playerLoaded'
  • Allowed: valid custom client event name
  • Impact: Player-load event when useCustomCore = true.
events.unload
  • Type: string
  • Current: 'custom:playerLogout'
  • Allowed: valid custom client event name
  • Impact: Player-unload event when useCustomCore = true.
GetCustomCoreObject
  • Type: function
  • Current: returns nil
  • Allowed: any function returning your custom framework object
  • Impact: Supplies framework object in custom mode.

Custom integration flags (config/custom.lua)

customDrawText
  • Type: boolean
  • Current: false
  • Allowed: true / false
  • Impact: Uses Custom.DrawText / Custom.HideText instead of framework text UI.
customNotify
  • Type: boolean
  • Current: false
  • Allowed: true / false
  • Impact: Uses Custom.Notify instead of framework/ox_lib notifications.

Database checks (config/database.lua)

checkDatabase
  • Type: boolean
  • Current: true
  • Allowed: true / false
  • Impact: Verifies DB table structure at startup for both tattoo tables.

Blip defaults (config/blip.lua)

sprite
  • Type: number
  • Current: 75
  • Allowed: valid GTA blip sprite IDs
  • Impact: Tattoo shop map icon type.
scale
  • Type: number
  • Current: 0.7
  • Allowed: positive float values
  • Impact: Tattoo shop blip size.
colour
  • Type: number
  • Current: 1
  • Allowed: valid blip color IDs
  • Impact: Tattoo shop blip color.

Marker defaults (config/marker.lua)

type
  • Type: number
  • Current: 1
  • Allowed: valid GTA marker types
  • Impact: Marker shape at shop interaction points.
color
  • Type: table
  • Current: { r = 74, g = 96, b = 255, a = 100 }
  • Allowed: RGBA integer values 0-255
  • Impact: Marker color/alpha.
width
  • Type: number
  • Current: 0.4
  • Allowed: positive float values
  • Impact: Marker X/Y size.
height
  • Type: number
  • Current: 0.4
  • Allowed: positive float values
  • Impact: Marker Z size.

Opacity behavior (config/opacity.lua)

enabled
  • Type: boolean
  • Current: true
  • Allowed: true / false
  • Impact: Enables opacity layering logic for tattoos.
range
  • Type: number
  • Current: 3
  • Allowed: positive integer values
  • Impact: Effective opacity strength range used by the tattoo system.

Ped mapping (config/peds.lua)

peds[model]
  • Type: string
  • Current: mp_m_freemode_01 => 'Male', mp_f_freemode_01 => 'Female'
  • Allowed: 'Male', 'Female', or custom labels used by your tattoo datasets
  • Impact: Controls gender filter used for tattoo selection.
clothes[model][slot]
  • Type: table
  • Current: per-slot objects with drawable, texture, component_id
  • Allowed: valid ped component values
  • Impact: Temporary outfit applied while in tattoo preview UI.

Theme (config/theme.lua)

current
  • Type: string
  • Current: 'blue'
  • Allowed: 'blue', 'red', 'purple', 'gray', 'custom'
  • Impact: Selects NUI theme palette.
customTheme
  • Type: table
  • Current: custom color/gradient map (primary, dark, light, menuBg, menuBorder, opacity channels)
  • Allowed: valid CSS color/gradient values
  • Impact: Overrides UI colors when current = 'custom'.

Locations (config/locations.lua)

Runtime options (shopLocations)

shopLocations[].coords
  • Type: vec3
  • Current: predefined GTA tattoo shop coordinates (auto-switched for cfx-gabz-tattoo or cfx-mxc-tattoo when those resources run)
  • Allowed: any world coordinate
  • Impact: Defines where players can open tattoo shops.

Runtime options (customLocations)

customLocations[].coords
  • Type: vec3
  • Current: empty by default (example commented)
  • Allowed: any world coordinate
  • Impact: Adds additional custom tattoo shops.
customLocations[].blip
  • Type: table
  • Current: optional override (sprite, scale, colour, label)
  • Allowed: valid blip config values
  • Impact: Per-location blip override for custom shops.
Previous
Installation
Next
Commands