GFX Crew

A full-featured crew/gang management system with an interactive NUI menu, allowing players to create, join, and manage crews with member tracking, kill/death statistics, leaderboards, role-based permissions, crew chat, announcements, and map blips.

Info

Dependencies

Installation

1. Import the SQL file

Import crew.sql into your database. This creates two tables:

• crews -- stores crew data (name, members, stats, roles, announcements, chat)
• crew_users -- stores per-player previous crew history

2. Copy resource files

Place the gfx-crew folder into your server's resources directory.

3. Configure server.cfg

ensure gfx-lib
ensure gfx-crew

4. Configure the script

Edit cl_config.lua, sv_config.lua, and shared_config.lua to match your server preferences (see Configuration section below).

Configuration

Client Config (cl_config.lua)

Server Config (sv_config.lua)

Badges Configuration

Badges = {
    {
        id = 1,
        image = 'badges/kill10.png',
        label = '10 Kills',
        killCount = 10
    },
    {
        id = 2,
        image = 'badges/kill100.png',
        label = '100 Kills',
        killCount = 100
    },
    -- ...
}

Shared Config (shared_config.lua)

Defines weapon hash-to-label/image mappings used for displaying weapon info on member cards:

Shared = {
    Weapons = {
        [-1569615261] = {
            label = "Fist",
            image = "weapons/fist.webp",
        },
        [`weapon_assaultrifle`] = {
            label = "Pistol",
            image = "weapons/weapon_pistol.webp",
        },
    }
}

Locale (locale.lua)

All UI text strings are defined in locale.lua and can be fully customized or translated.

Exports

Client Exports

IsMenuVisible

Returns whether the crew NUI menu is currently open.

local isOpen = exports['gfx-crew']:IsMenuVisible()
-- Returns: boolean

GetPlayerCrewData

Returns the local player's cached crew profile data (populated after opening the menu).

local data = exports['gfx-crew']:GetPlayerCrewData()
-- Returns: table { id, name, image, rank, rankId, permissions, crewId, stats }

Server Exports

GetPlayerCrewName

Returns the crew name for a given player source.

local crewName = exports['gfx-crew']:GetPlayerCrewName(source)
-- @param source: number (player server ID)
-- Returns: string|nil (crew name or nil if not in a crew)

GetPlayerCrewData

Returns the full crew data table for a given player source.

local crewData = exports['gfx-crew']:GetPlayerCrewData(source)
-- @param source: number (player server ID)
-- Returns: table|nil { name, description, shortName, bannerImage, crewImage, maxMember, isPrivate, members, stats, roles, announcements, chat }

GetPlayerCrewMembers

Returns the members table of the crew the given player belongs to.

local members = exports['gfx-crew']:GetPlayerCrewMembers(source)
-- @param source: number (player server ID)
-- Returns: table|nil (array of member objects)

GetPlayerCrewMembersForMarker

Returns an array of server source IDs for all online members in the player's crew. Useful for marker/blip systems.

local sources = exports['gfx-crew']:GetPlayerCrewMembersForMarker(source)
-- @param source: number (player server ID)
-- Returns: table (array of server source IDs of online crew members)

AddBadgeToMember

Manually awards a badge to a player by badge ID.

exports['gfx-crew']:AddBadgeToMember(source, badgeId)
-- @param source: number (player server ID)
-- @param badgeId: number (badge ID from Config.Badges)
-- Returns: boolean|nil (true if successful)

Events

There are no public API events intended for external script use. All events in this resource are internal (NUI callbacks, member sync, stat updates) and should not be relied upon by other scripts. Use the exports above for integration.

Commands

The command name is configurable via Config.OpenMenu.command.command and can be disabled by setting Config.OpenMenu.command.enable to false.

Features

• Crew Creation & Management -- Create crews with a name, short name/tag, description, banner image, crew image, and configurable max member count
• Public & Private Crews -- Set crew visibility; public crews appear in a browse list, private crews require an invite
• Role-Based Permissions -- Customizable roles (Leader, Member, and custom ranks) with granular permissions: kick, invite, edit, delete, announce
• Member Management -- Invite players, kick members, set roles, view member profiles with stats
• Kill/Death Tracking -- Automatic PvP kill and death tracking for crew members with crew-wide stat aggregation
• Achievement Badges -- Configurable badge milestones awarded automatically when a member reaches kill count thresholds
• Leaderboard -- Server-wide leaderboard ranking both crews and individual members by kills and deaths
• Crew Chat -- In-game real-time text chat between crew members via the NUI interface
• Announcements -- Leaders can broadcast announcements to all crew members
• Gamer Tags -- GTA Online-style overhead name tags with color-coded health bars for nearby crew members
• Friendly Fire Protection -- Optional relationship group system that prevents crew members from damaging each other
• Map Blips -- Crew member positions displayed on the minimap with name labels
• Previous Crew History -- Tracks the last crew a player was in, visible on member profiles
• OneSync Support -- Enhanced member data (health, armor, weapon, coordinates) when OneSync is enabled
• NUI Interface -- Full React-based web UI for all crew management operations
• Multi-Database Support -- Works with oxmysql, ghmattimysql, or mysql-async
• Fully Localizable -- All UI strings defined in locale.lua

Troubleshooting