> ## Documentation Index
> Fetch the complete documentation index at: https://axeldevelopment.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

#  installation & config         

<img className="w-full rounded-xl shadow-lg border border-white/10" src="https://r2.fivemanage.com/pKlTXBH8m7kKAHXFsMDpA/Untitleddesign-2026-07-16T001003.008.png" alt="Axel items on back banner" />

# Config File

```lua expandable theme={null}
Config = {}

Config.Locale = 'en'              -- 'en', 'bg', 'de','es', 'fr', 'it', 'el', 'pt', it'
Config.Framework = 'esx'          -- 'esx', 'qb', 'qbox'
Config.Inventory = 'ox_inventory' -- ox_inventory, qb-inventory, Jaksam Inventory, qs-inventory

-- Command to open in-game admin editor menu
Config.EditorCommand = 'axeleditor' 

-- =========================================================================
-- NOTIFICATION
-- =========================================================================
Config.NotificationType = 'axel'

-- ==========================================
-- LUXE SKINS
-- ==========================================
Config.LuxeComponents = {
    ['WEAPON_ASSAULTRIFLE'] = `COMPONENT_ASSAULTRIFLE_VARMOD_LUXE`,
    ['WEAPON_ASSAULTSMG'] = `COMPONENT_ASSAULTSMG_VARMOD_LOWRIDER`,
    ['WEAPON_CARBINERIFLE'] = `COMPONENT_CARBINERIFLE_VARMOD_LUXE`,
    ['WEAPON_COMBATPISTOL'] = `COMPONENT_COMBATPISTOL_VARMOD_LOWRIDER`,
    ['WEAPON_MARKSMANRIFLE'] = `COMPONENT_MARKSMANRIFLE_VARMOD_LUXE`,
    ['WEAPON_MG'] = `COMPONENT_MG_VARMOD_LOWRIDER`,
    ['WEAPON_MICROSMG'] = `COMPONENT_MICROSMG_VARMOD_LUXE`,
    ['WEAPON_PISTOL'] = `COMPONENT_PISTOL_VARMOD_LUXE`,
    ['WEAPON_PUMPSHOTGUN'] = `COMPONENT_PUMPSHOTGUN_VARMOD_LOWRIDER`,
    ['WEAPON_SMG'] = `COMPONENT_SMG_VARMOD_LUXE`
}

Config.GlobalAttachments = {
    ['flsh']  = { model = `w_at_ar_flsh`,      bone_name = "WAPFlshLasr" },
    ['supp']  = { model = `w_at_ar_supp`,      bone_name = "WAPSupp" },
    ['scope'] = { model = `w_at_scope_medium`, bone_name = "WAPScop" },
    ['grip']  = { model = `w_at_ar_afgrip`,    bone_name = "WAPGrip" }
}

Config.WeaponSpecificAttachments = {
    -- ==========================================
    -- PISTOLS
    -- ==========================================
    ['WEAPON_PISTOL'] = {
        ['default_mag'] = { model = `w_pi_pistol_mag1`,       bone_name = "WAPClip" },
        ['mag']         = { model = `w_pi_pistol_mag2`,       bone_name = "WAPClip" },
        ['flsh']        = { model = `w_at_pi_flsh`,           bone_name = "WAPFlshLasr" },
        ['supp']        = { model = `w_at_pi_supp_2`,         bone_name = "WAPSupp" }
    },
    ['WEAPON_COMBATPISTOL'] = {
        ['default_mag'] = { model = `w_pi_combatpistol_mag1`, bone_name = "WAPClip" },
        ['mag']         = { model = `w_pi_combatpistol_mag2`, bone_name = "WAPClip" },
        ['flsh']        = { model = `w_at_pi_flsh`,           bone_name = "WAPFlshLasr" },
        ['supp']        = { model = `w_at_pi_supp`,           bone_name = "WAPSupp" }
    },
    ['WEAPON_APPISTOL'] = {
        ['default_mag'] = { model = `w_pi_appistol_mag1`,     bone_name = "WAPClip" },
        ['mag']         = { model = `w_pi_appistol_mag2`,     bone_name = "WAPClip" },
        ['flsh']        = { model = `w_at_pi_flsh`,           bone_name = "WAPFlshLasr" },
        ['supp']        = { model = `w_at_pi_supp`,           bone_name = "WAPSupp" }
    },
    ['WEAPON_PISTOL50'] = {
        ['default_mag'] = { model = `w_pi_pistol50_mag1`,     bone_name = "WAPClip" },
        ['mag']         = { model = `w_pi_pistol50_mag2`,     bone_name = "WAPClip" },
        ['flsh']        = { model = `w_at_pi_flsh`,           bone_name = "WAPFlshLasr" },
        ['supp']        = { model = `w_at_ar_supp_02`,        bone_name = "WAPSupp" }
    },
    ['WEAPON_HEAVYPISTOL'] = {
        ['default_mag'] = { model = `w_pi_heavypistol_mag1`,  bone_name = "WAPClip" },
        ['mag']         = { model = `w_pi_heavypistol_mag2`,  bone_name = "WAPClip" },
        ['flsh']        = { model = `w_at_pi_flsh`,           bone_name = "WAPFlshLasr" },
        ['supp']        = { model = `w_at_pi_supp`,           bone_name = "WAPSupp" }
    },
    ['WEAPON_VINTAGEPISTOL'] = {
        ['default_mag'] = { model = `w_pi_vintage_pistol_mag1`, bone_name = "WAPClip" },
        ['mag']         = { model = `w_pi_vintage_pistol_mag2`, bone_name = "WAPClip" },
        ['supp']        = { model = `w_at_pi_supp`,           bone_name = "WAPSupp" }
    },
    ['WEAPON_SNSPISTOL'] = {
        ['default_mag'] = { model = `w_pi_sns_pistol_mag1`,   bone_name = "WAPClip" },
        ['mag']         = { model = `w_pi_sns_pistol_mag2`,   bone_name = "WAPClip" }
    },

    -- ==========================================
    -- SMG 
    -- ==========================================
    ['WEAPON_MICROSMG'] = {
        ['default_mag'] = { model = `w_sb_microsmg_mag1`,     bone_name = "WAPClip" },
        ['mag']         = { model = `w_sb_microsmg_mag2`,     bone_name = "WAPClip" },
        ['flsh']        = { model = `w_at_pi_flsh`,           bone_name = "WAPFlshLasr" },
        ['supp']        = { model = `w_at_ar_supp_02`,        bone_name = "WAPSupp" },
        ['scope']       = { model = `w_at_scope_macro`,       bone_name = "WAPScop" }
    },
    ['WEAPON_SMG'] = {
        ['default_mag'] = { model = `w_sb_smg_mag1`,          bone_name = "WAPClip" },
        ['mag']         = { model = `w_sb_smg_mag2`,          bone_name = "WAPClip" },
        ['drum']        = { model = `w_sb_smg_boxmag`,        bone_name = "WAPClip" },
        ['flsh']        = { model = `w_at_ar_flsh`,           bone_name = "WAPFlshLasr" },
        ['supp']        = { model = `w_at_pi_supp`,           bone_name = "WAPSupp" },
        ['scope']       = { model = `w_at_scope_macro_2`,     bone_name = "WAPScop" }
    },
    ['WEAPON_ASSAULTSMG'] = {
        ['default_mag'] = { model = `w_sb_assaultsmg_mag1`,   bone_name = "WAPClip" },
        ['mag']         = { model = `w_sb_assaultsmg_mag2`,   bone_name = "WAPClip" },
        ['flsh']        = { model = `w_at_ar_flsh`,           bone_name = "WAPFlshLasr" },
        ['supp']        = { model = `w_at_ar_supp_02`,        bone_name = "WAPSupp" },
        ['scope']       = { model = `w_at_scope_macro`,       bone_name = "WAPScop" }
    },
    ['WEAPON_COMBATPDW'] = {
        ['default_mag'] = { model = `w_sb_pdw_mag1`,          bone_name = "WAPClip" },
        ['mag']         = { model = `w_sb_pdw_mag2`,          bone_name = "WAPClip" },
        ['drum']        = { model = `w_sb_pdw_boxmag`,        bone_name = "WAPClip" },
        ['flsh']        = { model = `w_at_ar_flsh`,           bone_name = "WAPFlshLasr" },
        ['scope']       = { model = `w_at_scope_small`,       bone_name = "WAPScop" },
        ['grip']        = { model = `w_at_ar_afgrip`,         bone_name = "WAPGrip" }
    },
    ['WEAPON_MACHINEPISTOL'] = {
        ['default_mag'] = { model = `w_sb_compactsmg_mag1`,   bone_name = "WAPClip" },
        ['mag']         = { model = `w_sb_compactsmg_mag2`,   bone_name = "WAPClip" },
        ['drum']        = { model = `w_sb_compactsmg_boxmag`, bone_name = "WAPClip" },
        ['supp']        = { model = `w_at_pi_supp`,           bone_name = "WAPSupp" }
    },
    ['WEAPON_MINISMG'] = {
        ['default_mag'] = { model = `w_sb_minismg_mag1`,      bone_name = "WAPClip" },
        ['mag']         = { model = `w_sb_minismg_mag2`,      bone_name = "WAPClip" }
    },

    -- ==========================================
    -- ASSAULT RIFLES
    -- ==========================================
    ['WEAPON_ASSAULTRIFLE'] = {
        ['default_mag']  = { model = `w_ar_assaultrifle_mag1`, bone_name = "WAPClip" },
        ['mag']          = { model = `w_ar_assaultrifle_mag2`, bone_name = "WAPClip" },
        ['drum']         = { model = `w_ar_assaultrifle_boxmag`, bone_name = "WAPClip" },
        ['flsh']         = { model = `w_at_ar_flsh`,           bone_name = "WAPFlshLasr" },
        ['supp']         = { model = `w_at_ar_supp_02`,        bone_name = "WAPSupp" },
        ['scope']        = { model = `w_at_scope_macro`,       bone_name = "WAPScop" },
        ['grip']         = { model = `w_at_ar_afgrip`,         bone_name = "WAPGrip" }
    },
    ['WEAPON_CARBINERIFLE'] = {
        ['default_mag'] = { model = `w_ar_carbinerifle_mag1`, bone_name = "WAPClip" },
        ['mag']         = { model = `w_ar_carbinerifle_mag2`, bone_name = "WAPClip" },
        ['drum']        = { model = `w_ar_carbinerifle_boxmag`, bone_name = "WAPClip" },
        ['flsh']        = { model = `w_at_ar_flsh`,           bone_name = "WAPFlshLasr" },
        ['supp']        = { model = `w_at_ar_supp`,           bone_name = "WAPSupp" },
        ['scope']       = { model = `w_at_scope_medium`,      bone_name = "WAPScop" },
        ['grip']        = { model = `w_at_ar_afgrip`,         bone_name = "WAPGrip" }
    },
    ['WEAPON_ADVANCEDRIFLE'] = {
        ['default_mag'] = { model = `w_ar_advancedrifle_mag1`,bone_name = "WAPClip" },
        ['mag']         = { model = `w_ar_advancedrifle_mag2`,bone_name = "WAPClip" },
        ['flsh']        = { model = `w_at_ar_flsh`,           bone_name = "WAPFlshLasr" },
        ['supp']        = { model = `w_at_ar_supp`,           bone_name = "WAPSupp" },
        ['scope']       = { model = `w_at_scope_small`,       bone_name = "WAPScop" }
    },
    ['WEAPON_SPECIALCARBINE'] = {
        ['default_mag'] = { model = `w_ar_specialcarbine_mag1`, bone_name = "WAPClip" },
        ['mag']         = { model = `w_ar_specialcarbine_mag2`, bone_name = "WAPClip" },
        ['drum']        = { model = `w_ar_specialcarbine_boxmag`, bone_name = "WAPClip" },
        ['flsh']        = { model = `w_at_ar_flsh`,           bone_name = "WAPFlshLasr" },
        ['supp']        = { model = `w_at_ar_supp_02`,        bone_name = "WAPSupp" },
        ['scope']       = { model = `w_at_scope_medium`,      bone_name = "WAPScop" },
        ['grip']         = { model = `w_at_ar_afgrip`,         bone_name = "WAPGrip" }
    },
    ['WEAPON_BULLPUPRIFLE'] = {
        ['default_mag'] = { model = `w_ar_bullpuprifle_mag1`, bone_name = "WAPClip" },
        ['mag']         = { model = `w_ar_bullpuprifle_mag2`, bone_name = "WAPClip" },
        ['flsh']        = { model = `w_at_ar_flsh`,           bone_name = "WAPFlshLasr" },
        ['supp']        = { model = `w_at_ar_supp`,           bone_name = "WAPSupp" },
        ['scope']       = { model = `w_at_scope_small`,       bone_name = "WAPScop" },
        ['grip']        = { model = `w_at_ar_afgrip`,         bone_name = "WAPGrip" }
    },
    ['WEAPON_COMPACTRIFLE'] = {
        ['default_mag'] = { model = `w_ar_assaultrifle_smg_mag1`, bone_name = "WAPClip" },
        ['mag']         = { model = `w_ar_assaultrifle_smg_mag2`, bone_name = "WAPClip" },
        ['drum']        = { model = `w_ar_assaultrifle_boxmag`,   bone_name = "WAPClip" }
    },

    -- ==========================================
    -- MG
    -- ==========================================
    ['WEAPON_MG'] = {
        ['default_mag'] = { model = `w_mg_mg_mag1`,           bone_name = "WAPClip" },
        ['mag']         = { model = `w_mg_mg_mag2`,           bone_name = "WAPClip" },
        ['scope']       = { model = `w_at_scope_small_2`,     bone_name = "WAPScop" }
    },
    ['WEAPON_COMBATMG'] = {
        ['default_mag'] = { model = `w_mg_combatmg_mag1`,     bone_name = "WAPClip" },
        ['mag']         = { model = `w_mg_combatmg_mag2`,     bone_name = "WAPClip" },
        ['scope']       = { model = `w_at_scope_medium`,      bone_name = "WAPScop" }
    },
    ['WEAPON_GUSENBERG'] = {
        ['default_mag'] = { model = `w_sb_gusenberg_mag1`,    bone_name = "WAPClip" },
        ['mag']         = { model = `w_sb_gusenberg_mag2`,    bone_name = "WAPClip" }
    },

    -- ==========================================
    -- SHOTGUNS
    -- ==========================================
    ['WEAPON_PUMPSHOTGUN'] = {
        ['flsh']        = { model = `w_at_ar_flsh`,           bone_name = "WAPFlshLasr" }
    },
    ['WEAPON_ASSAULTSHOTGUN'] = {
        ['default_mag'] = { model = `w_sg_assaultshotgun_mag1`, bone_name = "WAPClip" },
        ['mag']         = { model = `w_sg_assaultshotgun_mag2`, bone_name = "WAPClip" },
        ['flsh']        = { model = `w_at_ar_flsh`,           bone_name = "WAPFlshLasr" },
        ['supp']        = { model = `w_at_ar_supp`,           bone_name = "WAPSupp" },
        ['grip']        = { model = `w_at_ar_afgrip`,         bone_name = "WAPGrip" }
    },
    ['WEAPON_HEAVYSHOTGUN'] = {
        ['default_mag'] = { model = `w_sg_heavyshotgun_mag1`, bone_name = "WAPClip" },
        ['mag']         = { model = `w_sg_heavyshotgun_mag2`, bone_name = "WAPClip" },
        ['drum']        = { model = `w_sg_heavyshotgun_boxmag`, bone_name = "WAPClip" },
        ['flsh']        = { model = `w_at_ar_flsh`,           bone_name = "WAPFlshLasr" },
        ['supp']        = { model = `w_at_ar_supp_02`,        bone_name = "WAPSupp" },
        ['grip']        = { model = `w_at_ar_afgrip`,         bone_name = "WAPGrip" }
    },

    -- ==========================================
    -- SNIPERS
    -- ==========================================
    ['WEAPON_SNIPERRIFLE'] = {
        ['default_mag'] = { model = `w_sr_sniperrifle_mag1`,  bone_name = "WAPClip" },
        ['supp']        = { model = `w_at_ar_supp_02`,        bone_name = "WAPSupp" }
    },
    ['WEAPON_HEAVYSNIPER'] = {
        ['default_mag'] = { model = `w_sr_heavysniper_mag1`,  bone_name = "WAPClip" }
    },
    ['WEAPON_MARKSMANRIFLE'] = {
        ['default_mag'] = { model = `w_sr_marksmanrifle_mag1`,bone_name = "WAPClip" },
        ['mag']         = { model = `w_sr_marksmanrifle_mag2`,bone_name = "WAPClip" },
        ['flsh']        = { model = `w_at_ar_flsh`,           bone_name = "WAPFlshLasr" },
        ['supp']        = { model = `w_at_ar_supp`,           bone_name = "WAPSupp" },
        ['grip']        = { model = `w_at_ar_afgrip`,         bone_name = "WAPGrip" }
    },

    -- ==========================================
    -- Kyros Pack v5
    -- ==========================================
    ['WEAPON_LBTARP'] = {
        ['mag']  = { model = `w_ar_kyroslbtarp_mag2`, bone_name = "WAPClip" },
        ['drum'] = { model = `w_ar_kyroslbtarp_mag3`, bone_name = "WAPClip" },
        ['clear']= { model = `w_ar_kyroslbtarp_mag4`, bone_name = "WAPClip" },
    },
    ['WEAPON_BLACKTOMMY'] = {
        ['drum'] = { model = `w_sb_kyrosblacktommy_mag2`, bone_name = "WAPClip" }
    },
    ['WEAPON_DMK18'] = {
        ['flsh']  = { model = `w_at_ar_kyrosdmk18_flsh`,      bone_name = "WAPFlshLasr" },
        ['supp']  = { model = `w_at_ar_kyrosdmk18_supp`,      bone_name = "WAPSupp" },
        ['grip']  = { model = `w_at_ar_kyrosdmk18_afgrip`,    bone_name = "WAPGrip" },
        ['scope'] = { model = `w_at_kyrosdmk18_scope_medium`, bone_name = "WAPScop" },
    },
    ['WEAPON_REDM4A1'] = {
        ['mag']  = { model = `w_ar_kyrosredm4a1_mag1`,   bone_name = "WAPClip" },
        ['supp'] = { model = `w_at_ar_kyrosredm4a1_supp`, bone_name = "WAPSupp" },
    },
    ['WEAPON_WOARP'] = {
        ['mag']   = { model = `w_ar_kyroswoarp_mag2`, bone_name = "WAPClip" },
        ['drum']  = { model = `w_ar_kyroswoarp_mag3`, bone_name = "WAPClip" },
        ['clear'] = { model = `w_ar_kyroswoarp_mag4`, bone_name = "WAPClip" },
    },
    ['WEAPON_BAR15'] = {
        ['flsh']  = { model = `w_at_ar_kyrosb15_flsh`,      bone_name = "WAPFlshLasr" },
        ['grip']  = { model = `w_at_ar_kyrosb15_afgrip`,    bone_name = "WAPGrip" },
        ['scope'] = { model = `w_at_kyrosb15_scope_medium`, bone_name = "WAPScop" },
    },
    ['WEAPON_TARP'] = {
        ['mag']   = { model = `w_ar_kyrostarp_mag2`, bone_name = "AAPClip" },
        ['drum']  = { model = `w_ar_kyrostarp_mag3`, bone_name = "AAPClip" },
        ['clear'] = { model = `w_ar_kyrostarp_mag4`, bone_name = "AAPClip" },
    },
    ['WEAPON_REDARP'] = {
        ['mag']   = { model = `w_ar_kyrosredarp_mag2`, bone_name = "WAPClip" },
        ['drum']  = { model = `w_ar_kyrosredarp_mag3`, bone_name = "WAPClip" },
        ['clear'] = { model = `w_ar_kyrosredarp_mag4`, bone_name = "WAPClip" },
    },
    ['WEAPON_RAV7'] = {
        ['mag']  = { model = `w_ar_kyrosraven7_mag2`, bone_name = "WAPClip" },
    },
    ['WEAPON_BLACKSTORM'] = {
        ['mag']  = { model = `w_ar_kyrosblackstorm_mag2`, bone_name = "WAPClip" },
    },
    ['WEAPON_TAC9S'] = {
        ['mag']  = { model = `w_sb_kyrostac9s_mag1`, bone_name = "WAPClip" },
        ['drum'] = { model = `w_sb_kyrostac9s_mag2`, bone_name = "WAPClip" },
    }
}

-- Dont Touch
function _U(str, ...)
    if Locales and Locales[Config.Locale] and Locales[Config.Locale][str] then
        return string.format(Locales[Config.Locale][str], ...)
    else
        return 'Translation [' .. str .. '] doesn\'t exist'
    end
end
```

# Installation guide

```text theme={null}
download the script from cfx, put it in the server and restart it
```

**In-game admin menu command /axeleditor**
