SMX logo

SMX Documentation

Production-grade Script Knowledge Base

Build 2026.04 Live Docs



Rusty Style Namechange

Scripts · FiveM Ready

Core Setup

Config.Framework = 'esx'      -- esx, qb, standalone
Config.Debug = false
Config.InteractKey = 38       -- E
Config.CityDefault = 'Los Santos'
Config.PriceDefault = 2500
Config.CooldownMinutes = 1440

Core settings define payment/cooldown handling and interaction behavior.

Validation and Security

Config.RequireReasonText = true
Config.MinReasonTextLength = 15

Config.NameValidation = {
    minLen = 2,
    maxLen = 16,
    allowedPattern = "^[A-Za-z'%-]+$",
    blockedNames = { admin = true, owner = true, ... },
    blockedCombinations = { ['max mustermann'] = true }
}

Names are sanitized and validated server-side before DB insert and approval processing.

Locations, Reasons and Scene

Config.Locations = {
    { id='cityhall_ls', label='City Hall Los Santos', coords=vec3(...), heading=..., ped=`...` }
}

Config.Reasons = {
    marriage = { label='Marriage', fee=1500, requiredDocuments={...} },
    personal = { label='Personal Reasons', fee=2500, requiredDocuments={...} }
}

Config.Scene = {
    freezePlayer = true,
    animDict = 'amb@world_human_clipboard@male@idle_a',
    animName = 'idle_a',
    propModel = `prop_notepad_01`
}

These blocks define world interaction points, legal reason matrix and document-writing immersion scene.

Reviewer Access and Commands

Config.ReviewerAccess = {
    useAdminGroups = true,
    useJobs = true,
    esxGroups = { ['admin']=true, ['superadmin']=true },
    qbPermissions = { ['admin']=true, ['god']=true },
    jobs = { ['cityhall']=true, ['government']=true, ['doj']=true }
}

Config.ReviewerMenu = {
    command = 'namechangereview',
    jobCommand = 'namechangeoffice',
    allowConsole = false
}

Reviewer access can be admin-group based, job-based, or both.