# Config file

{% tabs %}
{% tab title="CONFIG" %}

```lua
Config = {}

--[[ Language ]]--
Config.Locale = 'en'   -- en, de, es, cs.

--[[ Framework ]]--
Config.Framework = {
    autoDetect = true,                  -- Automatically finds and sets supported framework on your server.
    type = 'esx',                       -- ESX = 'esx' / QBCore = 'qbcore'.
    export = 'es_extended',             -- ESX = 'es_extended' / QBCore = 'qb-core'.
}

--[[ Inventory ]]--
Config.Inventory = 'auto_detect'        -- auto_detect   - Automatically finds and sets supported inventory on your server.
                                        -- ox            - https://github.com/overextended/ox_inventory.
                                        -- qb            - https://github.com/qbcore-framework/qb-inventory.
                                        -- qs            - https://buy.quasar-store.com/package/4770732.
                                        -- ps            - https://github.com/Project-Sloth/ps-inventory.
                                        -- codem         - https://codem.tebex.io/package/5900973.
                                        -- core          - https://core.tebex.io/package/5123274.
                                        -- origen        - https://www.origennetwork.store/package/5881161.
                                        -- tgiann        - https://tgiann.tebex.io/package/6273000.
                                        -- jaksam        - https://fivem.jaksam-scripts.com/package/7091785.
                                        -- ak47         - https://menanak47.tebex.io/package/6436604.

--[[ ProgressBar ]]--
Config.ProgressBarDuration = 1          -- Duration of the progressbar [in seconds].
Config.ProgressBar = 'auto_detect'      -- auto_detect    - Automatically finds and sets supported progressbar on your server.
                                        -- none           - No ProgressBar.
                                        -- ox             - https://overextended.github.io/docs.
                                        -- qb             - https://github.com/qbcore-framework/progressbar.
                                        -- qs             - https://github.com/quasar-scripts/progressbar.
                                        -- progressBars   - https://forum.cfx.re/t/release-progress-bars-1-0-standalone/526287/4.

--[[ Notifications ]]--
Config.Notify = 'auto_detect'   -- auto_detect, ox, esx, qb.
Config.NotifyType = {success = 'success', info = 'info', error = 'error'}
Config.Sounds = true

--[[ Main ]]--
Config.VestControlTime = 5                       -- Check player vest status [In seconds].
Config.RepeatVestDestroyedNotification = false   -- If true, a notification will be sent every 5 seconds; if false, it will only be sent once when the vest is destroyed.
Config.DestroyBrokenVest = false                 -- Should the player's vest be permanently removed when it is destroyed?
Config.TakeOffBrokenVest = false                 -- Should the player's vest be automatically unequipped when it is destroyed?
Config.KeyBind = {enable = false, keyCode = 9}   -- Keybind to remove player's vest (works only if enable is true). Examples 9, 'a', 'b'...
Config.RemoveVest = {
    enable = true,            -- Disable this setting if you're using our clothing script.
    command = 'removevest',   -- Command for removing your vest.
}
Config.Anim = {
    takeOn = {dist = 'clothingtie', anim = 'try_tie_negative_a'},
    takeOff = {dist = 'clothingtie', anim = 'try_tie_negative_a'},
}

--[[ Vests ]]--
Config.Plates = {
    ['vestplate_police'] = {
        strength = 10,                                 -- The amount of armor this plate will add to the player's vest.
        jobWhitelist = {'police', 'sheriff', 'fbi'},   -- Jobs allowed to use this plate (Only these jobs are able to use the plate).
        jobBlacklist = {},                             -- Jobs restricted from using this plate. (Only these jobs are not able to use the plate).
    },
    ['vestplate_normal'] = {
        strength = 5,
        jobWhitelist = {},
        jobBlacklist = {},
    },
}

Config.Vests = {
    ['vest_police'] = {
        label = 'Police Vest',                         -- The name of the vest displayed in the game.
        maxArmor = 100,                                -- The maximum amount of armor provided by this vest.
        startArmor = false,                            -- If set to a number between 0 and 100, this will be the initial armor when the vest is equipped. If false, the vest armor will start with maxArmor.
        clothing = {
            use = true,                                -- Whether this vest applies clothing to the player.
            male = {                                   -- Clothing options for male characters (number represents the model, color is the variant).
                number = 4, 
                color = 1, 
                clothType = 'vest',                    -- Two types -> 'vest', 'decals'.
            },
            female = {                                 -- Clothing options for female characters.
                number = 3, 
                color = 1, 
                clothType = 'vest',
            },
        },
        jobWhitelist = {'police', 'sheriff', 'fbi'},   -- Jobs allowed to use this vest (Only these jobs are able to use the vest).
        jobBlacklist = {},                             -- Jobs restricted from using this vest. (Only these jobs are not able to use the vest).
    },
    ['vest_normal'] = {
        label = 'Normal Vest',
        maxArmor = 80,
        startArmor = false,
        clothing = {
            use = true,
            male = {number = 4, color = 2, clothType = 'vest'},
            female = {number = 1, color = 2, clothType = 'vest'},
        },
        jobWhitelist = {},
        jobBlacklist = {},
    },
}
```

{% endtab %}

{% tab title="LOCALES" %}

<details>

<summary>en</summary>

```lua
Locales['en'] = {
    ['equiped'] = 'You are already wearing a vest!',
    ['bulletproof_vest'] = 'Armor: %s/%s',
    ['take_on_vest'] = 'Taking on vest',
    ['take_off_vest'] = 'Removing vest',
    ['no_vests'] = 'You dont\'t have any vests in your inventory!',
    ['broken_vest'] = 'Your vest is broken!',
    ['no_vest_equiped'] = 'You are not wearing any vest right now!',
    ['repaired'] = 'Your vest is repaired to %s%%',
    ['not_enough_plates'] = 'You dont\'t have enough plates',
    ['bad_item'] = 'Item doesn\'t exist',
    ['bad_type'] = 'This vest name doesn\'t exist',
    ['cannot_use_destroyed'] = 'You are unable to use this vest because it\'s destroyed',
    ['remove_vest'] = 'Undress vest',
    ['job_specific_vest'] = 'You can only wear this vest if you have a specific job!',
    ['job_blacklisted_vest'] = 'You can\'t use this vest because your job is blacklisted!',
    ['job_specific_plate'] = 'You can only use this plate if you have a specific job!',
    ['job_blacklisted_plate'] = 'You can\'t use this plate because your job is blacklisted!',
    ['busy'] = 'You cannot do this right now!',
}
```

</details>

<details>

<summary>de</summary>

```lua
Locales['de'] = {
    ['equiped'] = 'Du hast bereits eine Weste angelegt.',
    ['bulletproof_vest'] = 'Rüstung: %s/%s',
    ['take_on_vest'] = 'Anlegen der Weste',
    ['take_off_vest'] = 'Ablegen der Weste',
    ['no_vests'] = 'Du hast keine Weste in deinem Inventar.',
    ['broken_vest'] = 'Deine Weste ist kaputt.',
    ['no_vest_equiped'] = 'Du hast keine Weste angelegt.',
    ['repaired'] = 'Deine Weste wurde auf %s%% repariert.',
    ['not_enough_plates'] = 'Du hast nicht genug Platten.',
    ['bad_item'] = 'Gegenstand existiert nicht.',
    ['bad_type'] = 'Dieser Westenname existiert nicht.',
    ['cannot_use_destroyed'] = 'Du kannst diese Weste nicht benutzen, da sie zerstört ist',
    ['remove_vest'] = 'Weste ausziehen',
    ['job_specific_vest'] = 'Du kannst diese Weste nur tragen, wenn du einen bestimmten Job hast!',
    ['job_blacklisted_vest'] = 'Du kannst diese Weste nicht benutzen, weil dein Job auf der schwarzen Liste steht!',
    ['job_specific_plate'] = 'Dieses Nummernschild kannst du nur verwenden, wenn du einen bestimmten Job hast!',
    ['job_blacklisted_plate'] = 'Du kannst dieses Nummernschild nicht verwenden, da dein Job auf der schwarzen Liste steht!',
    ['busy'] = 'Das können Sie im Moment nicht tun!',
}
```

</details>

<details>

<summary>es</summary>

```lua
Locales['es'] = {
    ['equiped'] = 'Ya tienes equipado un chaleco.',
    ['bulletproof_vest'] = 'Armadura: %s/%s',
    ['take_on_vest'] = 'Poniéndote el chaleco',
    ['take_off_vest'] = 'Quitándote el chaleco',
    ['no_vests'] = 'No tienes ningún chaleco en tu inventario.',
    ['broken_vest'] = 'Tu chaleco está roto.',
    ['no_vest_equiped'] = 'No tienes ningún chaleco equipado.',
    ['repaired'] = 'Tu chaleco ha sido reparado al %s%%.',
    ['not_enough_plates'] = 'No tienes suficientes placas.',
    ['bad_item'] = 'El objeto no existe.',
    ['bad_type'] = 'Este nombre de chaleco no existe.',
    ['cannot_use_destroyed'] = 'No puedes usar este chaleco porque está destruido',
    ['remove_vest'] = 'Quitar chaleco',
    ['job_specific_vest'] = '¡Solo puedes usar este chaleco si tienes un trabajo específico!',
    ['job_blacklisted_vest'] = '¡No puedes usar este chaleco porque tu trabajo está en la lista negra!',
    ['job_specific_plate'] = '¡Solo puedes usar esta matrícula si tienes un trabajo específico!',
    ['job_blacklisted_plate'] = '¡No puedes usar esta matrícula porque tu trabajo está en la lista negra!',
    ['busy'] = 'No puedes hacer esto ahora mismo!',
}
```

</details>

<details>

<summary>cs</summary>

```lua
Locales['cs'] = {
    ['equiped'] = 'Již máš na sobě vestu',
    ['bulletproof_vest'] = 'Vesta: %s/%s',
    ['take_on_vest'] = 'Oblékáš si vestu...',
    ['take_off_vest'] = 'Vyslékáš si vestu...',
    ['no_vests'] = 'Nemáš u sebe žádnou vestu.',
    ['broken_vest'] = 'Tvá vesta je rozbitá, již tě neochrání',
    ['no_vest_equiped'] = 'Nemáš na sobě vestu',
    ['repaired'] = 'Síla vesty se zvýšila na %s%%',
    ['not_enough_plates'] = 'Nemáš dost plátů',
    ['bad_item'] = 'Požadovaný item neexistuje',
    ['bad_type'] = 'Jméno vesty neexistuje',
    ['cannot_use_destroyed'] = 'Tuto vestu nemůžete použít, protože je zničená',
    ['remove_vest'] = 'Vysléct vestu',
    ['job_specific_vest'] = 'Tuto vestu můžete nosit pouze, pokud máte specifickou práci!',
    ['job_blacklisted_vest'] = 'Tuto vestu nemůžete použít, protože vaše práce je na černé listině!',
    ['job_specific_plate'] = 'Tuto poznávací značku můžete použít pouze, pokud máte specifickou práci!',
    ['job_blacklisted_plate'] = 'Nemůžete použít tuto poznávací značku, protože vaše práce je na černé listině!',
    ['busy'] = 'Tohle teď nemůžete udělat!',
}
```

</details>

<details>

<summary>ar</summary>

```lua
Locales['ar'] = {
    ['equiped'] = 'انت ترتدي درع بلفعل',
    ['bulletproof_vest'] = '%s/%s :درع',
    ['take_on_vest'] = 'ارتداء الدرع',
    ['take_off_vest'] = 'خلع الدرع',
    ['no_vests'] = '.ليس لديك أي سترة في مخزونك',
    ['broken_vest'] = 'درعك مكسورة',
    ['no_vest_equiped'] = 'أنت لم ترتدي ايا درع',
    ['repaired'] = '%s%% تم إصلاح درع الخاص بك الى',
    ['not_enough_plates'] = 'ليس لديك ما يكفي من اللوحات',
    ['bad_item'] = 'العنصر غير موجود',
    ['bad_type'] = 'اسم الدرع هذا غير موجود',
    ['cannot_use_destroyed'] = 'لا يمكنك استخدام هذه السترة لأنها تالفة',
    ['remove_vest'] = 'خلع السترة',
    ['job_specific_vest'] = 'يمكنك ارتداء هذه السترة فقط إذا كان لديك وظيفة محددة!',
    ['job_blacklisted_vest'] = 'لا يمكنك استخدام هذه السترة لأن وظيفتك موجودة في القائمة السوداء!',
    ['job_specific_plate'] = 'يمكنك استخدام هذه اللوحة فقط إذا كان لديك وظيفة محددة!',
    ['job_blacklisted_plate'] = 'لا يمكنك استخدام هذه اللوحة لأن وظيفتك في القائمة السوداء!',
    ['busy'] = 'لا يمكنك القيام بهذا الآن!',
}
```

</details>

<details>

<summary>pl</summary>

```lua
Locales['pl'] = {
    ['equiped'] = 'Masz już na sobie kamizelkę!',
    ['bulletproof_vest'] = 'Pancerz: %s/%s',
    ['take_on_vest'] = 'Zakładanie kamizelki',
    ['take_off_vest'] = 'Zdejmowanie kamizelki',
    ['no_vests'] = 'Nie masz żadnej kamizelki w ekwipunku!',
    ['broken_vest'] = 'Twoja kamizelka jest zepsuta!',
    ['no_vest_equiped'] = 'Nie masz teraz żadnej kamizelki!',
    ['repaired'] = 'Twoja kamizelka została naprawiona do %s%%',
    ['not_enough_plates'] = 'Nie masz wystarczającej liczby płyt',
    ['bad_item'] = 'Przedmiot nie istnieje',
    ['bad_type'] = 'Ta nazwa kamizelki nie istnieje',
    ['cannot_use_destroyed'] = 'Nie możesz użyć tej kamizelki, ponieważ jest zniszczona',
    ['remove_vest'] = 'Zdejmij kamizelkę',
    ['job_specific'] = 'Możesz nosić tę kamizelkę tylko wtedy, gdy masz określoną pracę!',
    ['job_blacklisted'] = 'Nie możesz używać tej kamizelki, ponieważ Twoja praca jest na czarnej liście!',
    ['job_specific_plate'] = 'Możesz użyć tej tablicy tylko, jeśli masz określoną pracę!',
    ['job_blacklisted_plate'] = 'Nie możesz użyć tej tablicy, ponieważ twoja praca jest na czarnej liście!',
    ['busy'] = 'Nie możesz tego zrobić teraz!',
}
```

</details>
{% endtab %}
{% endtabs %}

> If you need help with anything, do not hesitate and open a support ticket in our [discord](https://discord.gg/Yf7GrHDuUr).


---

# Agent Instructions: 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:

```
GET https://fivecode.gitbook.io/docs/scripts/fivecode-armor/config-file.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.
