⚙️Full Configuration Breakdown

Framework Settings

Config.Framework = {
    autoDetect = true,          -- Auto-detect framework (set to false to manually specify)
    defaultFramework = 'esx'    -- Specify 'esx' or 'qbcore' if autoDetect is false
}

Notification Settings

Config.Notifications = {
    system = 'x_hud',          -- Notification system: 'esx', 'qbcore', or 'x_hud'
    position = 'bottom-right',  -- Position for ESX notifications
    duration = 5000,           -- Notification duration in milliseconds
    types = {
        x_hud = {
            success = 'success',
            error = 'error',
            info = 'info',
            warning = 'warning',
            default = 'default',
            police = 'police',
            ambulance = 'ambulance',
            mechanic = 'mechanic',
            teamchat = 'teamchat',
            jobchat = 'jobchat',
            directmsg = 'directmsg'
        }
    }
}

Cooldown Settings

Config.Cooldowns = {
    teamchat = 10,             -- 10 seconds cooldown for team chat
    jobchat = 10,              -- 10 seconds cooldown for job chat
    message = 5,               -- 5 seconds cooldown for direct messages
    help_requests = 30,        -- 30 seconds shared cooldown for help commands
    id = 5,                    -- 5 seconds cooldown for ID commands
    coords = 3,                -- 3 seconds cooldown for coordinate commands
    me = 10,                   -- 10 seconds cooldown for /me commands
    dothis = 10                -- 10 seconds cooldown for /do commands
}

Command Permissions

Config.Commands = {
    id = {
        name = 'id',
        enabled = true,
        requirePermission = false,
        groups = {'user', 'mod', 'admin', 'superadmin'},
        description = "Shows your own server ID"
    },
    teamchat = {
        name = 'teamchat',
        enabled = true,
        requirePermission = true,
        groups = {'mod', 'admin', 'superadmin'},
        color = {255, 100, 100},
        description = "Sends a message to all team members"
    },
    message = {
        name = 'message',
        enabled = true,
        requirePermission = false,
        groups = {'user', 'mod', 'admin', 'superadmin'},
        color = {255, 255, 100},
        description = "Sends a direct message to a specific player"
    }
}

📖 Available Commands

Player Information

  • /id: Shows your server ID.

  • /ids: Shows IDs of nearby players within a 30-meter range.

Admin Tools

  • /setbucket [player_id] [bucket_id]: Sets a player's routing bucket.

  • /getbucket [player_id]: Shows a player's routing bucket.

Server Information

  • /online: Shows the number of online players.

  • /team: Shows the number of team members online.

Help Requests

  • /help [message]: Sends a help request to online staff.

  • /calladmin [message]: Sends an admin call to online staff.

  • /callhelp [message]: Sends a help call to online staff.

  • /bug [message]: Reports a bug to online staff.

  • /report [message]: Reports a player to online staff.

Coordinate Tools

  • /coords: Toggles coordinate display on screen.

  • /vector2: Copies current position as vector2 to clipboard.

  • /vector3: Copies current position as vector3 to clipboard.

  • /vector4: Copies current position and heading as vector4 to clipboard.

Chat Commands

  • /teamchat [message]: Sends a message to all team members.

  • /jobchat [message]: Sends a message to all members of your job.

  • /message [player_id] [message]: Sends a direct message to a specific player.

Roleplay Commands

  • /me [action]: Displays an action in third person (e.g., /me waves).

  • /do [description]: Displays an event or situation (e.g., /do is looking around).


🌍 Translations

The script supports multiple languages. You can configure the language in Config.Locale and extend translations in Translation.lua.

Supported Languages

  • English: Set Config.Locale = 'en'

  • German: Set Config.Locale = 'de'

  • French: Set Config.Locale = 'fr'

  • Italian: Set Config.Locale = 'it'

  • Spanish: Set Config.Locale = 'es'

Example Translation Entry

Locales['en'] = {
    ['copied_vector2'] = "Vector2 coordinates copied to clipboard",
    ['your_id'] = "Your server ID: %s",
    ['nearby_player'] = "Player ID: %s, Distance: %s meters",
    ['no_nearby_players'] = "No players nearby within range",
    ['help_sent'] = "Your help request has been sent to the staff",
    ['admin_notify'] = "%s (ID: %s) needs assistance: %s"
}

Last updated