gfx-effects

Kill effects script that plays particle effects (PTFX) on the victim's body when a player gets a kill. Players can browse, preview, and select their preferred effect through a modern NUI interface. Supports VIP restrictions and job-based access control.

Info

Dependencies

Installation

1. Copy Files

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

2. Add to server.cfg

ensure oxmysql
ensure gfx-effects

3. Configure

Edit config.lua to set VIP mode, identifier type, allowed jobs, and UI settings.

Configuration

All configuration is in config.lua.

Main Config

Config = {  false,
    -- Set to a function like: function(source) return IsPlayerAceAllowed(source, "vip") end
    -- or keep false to allow all players

    IdentifierType = "license",
    -- Player identifier type used for database lookups: "license", "steam", etc.

    AllowedJobs = {
        ["police"] = true
        -- Add job names that are allowed to use effects
    }
}

UI Config

Config.UI = {
    PrimaryColor = "#00ffea"
    -- The primary accent color used throughout the NUI interface
}

Locales

All UI text strings are configurable via the Locales table in config.lua:

Locales = {
    ["for_vip"]                = "This feature is only for diamond users!",
    ["ui_effects"]             = "EFFECTS",
    ["ui_menu"]                = "MENU",
    ["ui_subtitle"]            = "Select an effect from the menu.",
    ["ui_kill_effects"]        = "Kill Effects",
    ["ui_favourite_list"]      = "Favourite List",
    ["ui_show_favourites_title"] = "Show favourites",
    ["ui_search_placeholder"]  = "Enter the text...",
    ["ui_empty_title"]         = "No effects found",
    ["ui_empty_desc"]          = "Try adjusting filters or search query.",
    ["ui_in_use"]              = "In use",
    ["ui_apply"]               = "Apply",
    ["ui_close_aria"]          = "Close",
    ["ui_favorite"]            = "Add to favourites",
    ["ui_unfavorite"]          = "Remove from favourites"
}

Exports

No exports found. This script does not create any callable exports.

Events

Public API events that other resources can interact with:

Client Events

gfx-effect:client:effect

Plays a kill effect particle on a specific player. Triggered by the server when a kill occurs.

-- Trigger from server
TriggerClientEvent("gfx-effect:client:effect", targetSource, victimServerId, effectId)

The effect only plays if the local player is within 50 units of the victim.

gfx-effects:client:SetVip

Sets the VIP state for the local player. Sent by the server on join and on request.

-- Trigger from server
TriggerClientEvent("gfx-effects:client:SetVip", targetSource, state)

Server Events

gfx-effects:playerKilled

Triggered by the client when a player kills another player with an active effect selected. The server then broadcasts the effect to relevant clients.

-- Triggered automatically by the client on kill
TriggerServerEvent("gfx-effects:playerKilled", killerId, victimId, effectValue)

gfx-effects:server:RequestVip

Client requests their VIP status from the server. The server responds with gfx-effects:client:SetVip.

TriggerServerEvent("gfx-effects:server:RequestVip")

No parameters.

Commands

Features

• 90+ Particle Effects -- Large library of built-in GTA V particle effects including explosions, fireworks, confetti, smoke, fire, lightning, and more.
• Modern NUI Interface -- React-based UI with search, filtering, favourites list, and effect preview.
• Kill Effect System -- Automatically plays the selected particle effect at the victim's location when a player gets a kill.
• Effect Preview -- Players can preview any effect on themselves before applying it.
• Favourites -- Players can favourite effects for quick access.
• VIP Restriction -- Optionally restrict the effects menu to VIP players only via ACE permissions.
• Proximity-Based Rendering -- Effects only render for players within 50 units of the victim for performance.
• Configurable UI Theme -- Customizable primary accent color and all UI text strings via config.
• Localization Support -- All UI strings are configurable through the Locales table.
• Escrow Ready -- config.lua, client_shared.lua, and server_shared.lua are excluded from escrow for easy customization.

VIP Setup

The VIP check is defined in server/server_shared.lua. By default it uses ACE permissions:

function IsVIP(source)
    if source == nil then return false end
    local ok = IsPlayerAceAllowed(source, "vip")
    return ok == true
end

To use a custom VIP system, modify this function to use your own logic (e.g., check a database field, use a framework export, etc.).

To grant VIP via ACE permissions in server.cfg:

add_ace identifier.license:xxxxxx vip allow

Troubleshooting

Source

• GitHub: gfx-fivem/gfx-effects
• Organization: GFX-Fivem