> For the complete documentation index, see [llms.txt](https://docs.rainmad.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.rainmad.com/resources/pvp-utils-killfeed-effects-and-more/configuration.md).

# Configuration

```lua
Config = {}

Config.framework = {
    name = 'auto',                       -- Only esx or qb or auto. If auto, it will detect the framework automatically.
    debug = false,                       -- Debug mode (only developers)
    menuCommand = "utilsmenu",           -- Command to open the menu
}

Config.enabledMenus = {
    settings = false,
    killEffects = true,
    vehicleEffects = true,
    peds = true,
    kits = true,
    dailyRewards = true
}

Config.hitmarker = {
    enabled = true,
    hitmarkerSound = true,
    hitmarkerVolume = 50,
    hitmarkerScale = 20,
    bodySound = 1,
    armorSound = 1,
    bodyColor = {r = 255, g = 51, b = 51},
    armorColor = {r = 51, g = 153, b = 255},
    sounds = { -- List of available sounds for dropdown selection
        body = {
            "Body Sound 1",
            "Body Sound 2",
            "Body Sound 3",
            "Body Sound 4",
            "Body Sound 5"
        },
        armor = {
            "Armor Sound 1",
            "Armor Sound 2",
            "Armor Sound 3",
            "Armor Sound 4"
        }
    }
}

Config.killFeed = {
    enabled = true
}

Config.lootbag = {
    enabled = true,
    bagModel = "prop_big_bag_01",
    removeBagTime = 180, -- 3 min
    blacklistItems = {
        ["money"] = true
    }
}

Config.hud = {
    enabled = true
}

Config.weaponEffect = {
    enabled = false,
}

Config.detector = {
    itemName = "detector",
    shouldRemove = true,
    duration = 3, -- minutes
    weapons = {
        ["WEAPON_PISTOL"] = "Pistol",
        ["WEAPON_COMBATPISTOL"] = "Combat Pistol",
        ["WEAPON_APPISTOL"] = "AP Pistol",
        ["WEAPON_PISTOL50"] = "Pistol .50",
        ["WEAPON_SNSPISTOL"] = "SNS Pistol",
        ["WEAPON_HEAVYPISTOL"] = "Heavy Pistol",
        ["WEAPON_VINTAGEPISTOL"] = "Vintage Pistol",
        ["WEAPON_MICROSMG"] = "Micro SMG",
        ["WEAPON_SMG"] = "SMG",
        ["WEAPON_ASSAULTSMG"] = "Assault SMG",
        ["WEAPON_COMBATPDW"] = "Combat PDW",
        ["WEAPON_MG"] = "MG",
        ["WEAPON_COMBATMG"] = "Combat MG",
        ["WEAPON_ASSAULTRIFLE"] = "Assault Rifle",
        ["WEAPON_CARBINERIFLE"] = "Carbine Rifle",
        ["WEAPON_ADVANCEDRIFLE"] = "Advanced Rifle",
        ["WEAPON_SPECIALCARBINE"] = "Special Carbine",
        ["WEAPON_BULLPUPRIFLE"] = "Bullpup Rifle",
        ["WEAPON_COMPACTRIFLE"] = "Compact Rifle",
        ["WEAPON_PUMPSHOTGUN"] = "Pump Shotgun",
        ["WEAPON_SAWNOFFSHOTGUN"] = "Sawed-Off Shotgun",
        ["WEAPON_ASSAULTSHOTGUN"] = "Assault Shotgun",
        ["WEAPON_BULLPUPSHOTGUN"] = "Bullpup Shotgun",
        ["WEAPON_HEAVYSHOTGUN"] = "Heavy Shotgun",
        ["WEAPON_SNIPERRIFLE"] = "Sniper Rifle",
        ["WEAPON_HEAVYSNIPER"] = "Heavy Sniper",
        ["WEAPON_MARKSMANRIFLE"] = "Marksman Rifle",
        ["WEAPON_GRENADE"] = "Grenade",
        ["WEAPON_STICKYBOMB"] = "Sticky Bomb",
        ["WEAPON_SMOKEGRENADE"] = "Smoke Grenade",
        ["WEAPON_MOLOTOV"] = "Molotov",
        ["WEAPON_FIREWORK"] = "Firework Launcher",
        ["WEAPON_FLAREGUN"] = "Flare Gun",
        ["WEAPON_RPG"] = "RPG",
        ["WEAPON_MINIGUN"] = "Minigun",
        ["WEAPON_RAILGUN"] = "Railgun",
        ["WEAPON_MUSKET"] = "Musket",
        ["WEAPON_DAGGER"] = "Dagger",
        ["WEAPON_KNIFE"] = "Knife",
        ["WEAPON_MACHETE"] = "Machete",
        ["WEAPON_SWITCHBLADE"] = "Switchblade",
        ["WEAPON_HAMMER"] = "Hammer",
        ["WEAPON_BAT"] = "Baseball Bat",
        ["WEAPON_CROWBAR"] = "Crowbar",
        ["WEAPON_GOLFCLUB"] = "Golf Club"
    },
    vehicles = {
        ["adder"] = "Adder",
        ["t20"] = "T20",
        ["zentorno"] = "Zentorno",
        ["infernus"] = "Infernus",
        ["entityxf"] = "Entity XF",
        ["reaper"] = "Reaper",
        ["osiris"] = "Osiris",
        ["italigtb"] = "Itali GTB",
        ["pfister811"] = "Pfister 811",
        ["tempesta"] = "Tempesta",
        ["vacca"] = "Vacca",
        ["banshee2"] = "Banshee 900R",
        ["turismor"] = "Turismo R",
        ["cheetah"] = "Cheetah",
        ["deluxo"] = "Deluxo",
        ["buffalo"] = "Buffalo",
        ["buffalo2"] = "Buffalo S",
        ["dominator"] = "Dominator",
        ["gauntlet"] = "Gauntlet",
        ["dukes"] = "Dukes",
        ["ruiner"] = "Ruiner",
        ["futo"] = "Futo",
        ["sultan"] = "Sultan",
        ["sultanrs"] = "Sultan RS",
        ["elegy"] = "Elegy Retro Custom",
        ["elegy2"] = "Elegy RH8",
        ["jester"] = "Jester",
        ["jester2"] = "Jester (Racecar)",
        ["kuruma"] = "Kuruma",
        ["kuruma2"] = "Kuruma (Armored)",
        ["comet2"] = "Comet",
        ["comet5"] = "Comet SR",
        ["coquette"] = "Coquette",
        ["carbonizzare"] = "Carbonizzare",
        ["feltzer2"] = "Feltzer",
        ["massacro"] = "Massacro",
        ["rapidgt"] = "Rapid GT",
        ["rapidgt2"] = "Rapid GT Convertible",
        ["ninef"] = "9F",
        ["ninef2"] = "9F Cabrio",
        ["brawler"] = "Brawler",
        ["sandking"] = "Sandking",
        ["rebel2"] = "Rebel",
        ["insurgent"] = "Insurgent",
        ["insurgent2"] = "Insurgent Pickup",
        ["nightshark"] = "Nightshark",
        ["mesa3"] = "Mesa (Merryweather)",
        ["dubsta3"] = "Dubsta 6x6",
        ["baller3"] = "Baller LE",
        ["baller4"] = "Baller LE LWB",
        ["cavalcade"] = "Cavalcade",
        ["xls"] = "XLS",
        ["xls2"] = "XLS (Armored)",
        ["patriot"] = "Patriot",
        ["patriot2"] = "Patriot Stretch",
        ["toros"] = "Toros",
        ["urus"] = "Urus",
        ["paragon"] = "Paragon R"
    }
}

Config.vehicles = {
    storeKey = "K",
    customPlate = "RAINMAD",
    spawnCooldown = 3000,
    enableOnlyItemSpawn = true,
    models = {
        "deluxo",
        "adder",
    }
}

Config.deathScreen = {
    enabled = true,
    duration = 8000, -- Duration of the death screen in milliseconds
    showWhileDead = true, -- Show death screen while dead
    randomTexts = {
        "You Died",
        "Better Luck Next Time",
        "Don't Give Up!",
        "Stay Strong",
        "Keep Pushing Forward"
    }
}

Strings = {
    ["hits"] = "Hits: ",
    ["damage"] = "Damage: ",
    ["distance"] = "Distance: ",
    ["customization_menu"] = "Customization Menu",
    ["settings"] = "Settings",
    ["kill_effects"] = "Kill Effects",
    ["vehicle_effects"] = "Vehicle Effects",
    ["peds"] = "Peds",
    ["kits"] = "Kits",
    ["daily_rewards"] = "Daily Rewards",
    ["search"] = "Search...",
    ["claimed"] = "Claimed",
    ["missed"] = "Missed",
    ["available"] = "Available Today",
    ["locked"] = "Locked",
    ["day"] = "Day ",
    ["use"] = "Use",
    ["only_premium_members"] = "Only Premium Members",
    ["claim"] = "Claim",
    ["hitmarker_body_sound"] = "Hitmarker Body Sound",
    ["hitmarker_armor_sound"] = "Hitmarker Armor Sound",
    ["hitmarker_volume"] = "Hitmarker Volume",
    ["hitmarker_scale"] = "Hitmarker Scale",
    ["hitmarker_body_color"] = "Hitmarker Body Color",
    ["hitmarker_armor_color"] = "Hitmarker Armor Color",
    ["toggle_death_screen"] = "Toggle Death Screen",
    ["toggle_hud"] = "Toggle HUD",
    ["toggle_killfeed"] = "Toggle Killfeed",
    ["toggle_hitmarker"] = "Toggle Hitmarker",


    ["premium_kit_notification"] = "This kit is for premium members only.",
    ["role_kit_notification"] = "You do not have the required role to claim this kit.",
    ["kit_cooldown_notification"] = "You must wait %s to claim this kit again.",
    ["settings_saved_notification"] = "Settings saved successfully.",
    ["vehicle_not_found"] = "Vehicle not found.",
    ["vehicle_stored_notification"] = "Vehicle stored successfully. Model: %s",
    ["vehicles_spawned_notification"] = "Vehicle spawned successfully. Model: %s",
    ["vehicles_store_keybind"] = "Store Vehicle",
    ["vehicles_spawn_cd"] = "You must wait before spawning another vehicle.",
    ["vehicles_cant_spawn_dead"] = "You cannot spawn a vehicle while dead.",
    ["vehicles_cant_spawn_in_vehicle"] = "You cannot spawn a vehicle while inside another vehicle.",
    ["vehicles_not_in_vehicle"] = "You are not in a vehicle.",
    ["vehicles_not_in_driver_seat"] = "You must be in the driver's seat to store the vehicle.",
    ["vehicles_cant_store_dead"] = "You cannot store a vehicle while dead.",
    ["vehicles_cant_too_fast"] = "You must be going slower to store the vehicle.",
    ["lootbag_cant_open_dead"] = "You cannot open a loot bag while dead.",
    ["detector"] = "Detector",
    ["players"] = "Players",
    ["weapons"] = "Weapons",
    ["vehicles"] = "Vehicles",
}

```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.rainmad.com/resources/pvp-utils-killfeed-effects-and-more/configuration.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.