For the complete documentation index, see llms.txt. This page is also available as Markdown.

Configuration File

Main Files

SS-Weapons is configured from:

  • config.lua: Main settings, stores, gunsmith benches, cleaning, repair, wear, HUD, preview sync, poison/tranquilizer, and prices.

  • cfg/weapons.lua: Weapon catalog.

  • cfg/ammo.lua: Ammo catalog.

  • l/l.lua: Lua translations.

  • config.js: NUI / interface translations and book UI settings.

  • c/c.lua: Client logic.

  • s/s.lua: Server logic.

  • UI/UI.html: Weapon store and gunsmith UI.


config.lua

Config = {
    Dev = false,
    Language = "EN",
    PressKey = 0xD9D0E1C0,
    WaitingAnime = true,

    MinLabel = 2,
    MaxLabel = 10,
    PriceForCustomSerial = 1000,
    PriceForCustomLabel = 25,

    CleanWeaponItem = "leather",
    RemoveAfterClean = true,
    CleanWeaponTime = 10000,
    MinCleanWeaponTime = 2500,
    InspectWeaponCommand = "w_inspect",
    DirtyWeaponCommand = "dirtyweapon",

    WeaponHud = {
        Enabled = false,
        Position = "top-right",
        UpdateInterval = 150,
        HideWhenUiOpen = true,
        ImagePath = "img/weapons/%s.png",
        AmmoIconPath = "img/ammo_types/%s.png",
    },

    PreviewSync = {
        Enabled = true,
        Radius = 8.0,
        MaxSpectators = 6,
        CheckInterval = 2000,
    },

    WeaponRepair = {
        Enabled = true,
        Item = "weapon_repair_kit",
        RemoveItem = true,
        RepairAmount = 0.10,
        MinRustRequired = 0.01,
    },

    UseDegradation = true,
}

General Settings

  • Dev: Enables test/debug commands when true. Use false on live servers.

  • Language: Translation table used by the script.

  • PressKey: Key used to open store and gunsmith prompts.

  • WaitingAnime: Plays idle animation while the UI is open.


Custom Weapon Label & Serial

  • MinLabel: Minimum custom weapon label length.

  • MaxLabel: Maximum custom weapon label length.

  • PriceForCustomSerial: Extra price for custom serial number.

  • PriceForCustomLabel: Extra price for custom weapon label.


Weapon HUD

Position options:

  • top-left

  • top-center

  • top-right

  • middle-left

  • center

  • middle-right

  • bottom-left

  • bottom-center

  • bottom-right


Weapon Repair

  • Enabled: Enables weapon repair.

  • Item: Required repair item.

  • RemoveItem: Removes one item after successful repair.

  • RepairAmount: Amount of permanent rust/damage removed.

  • MinRustRequired: Minimum rust required before repair is allowed.


Weapon Wear

Weapon condition values are stored from 0.0 to 1.0.

Example:


Gunsmith Payment

Payment type can be:

  • gold

  • money


Stores & Gunsmith Benches

Stores are configured in:

Important fields:

  • EnableStore: Enables the buy catalog.

  • EnableGunsmith: Enables the gunsmith bench.

  • WichWeapons: false for all weapons, {} for none, or a list of weapon keys.

  • WichAmmo: false for all ammo, {} for none, or a list of ammo item keys.

  • Jobs: Jobs allowed to use the gunsmith bench.


Weapon Catalog

Weapons are configured in:

Example:


Ammo Catalog

Ammo is configured in:

Example:

  • Type: Ammo type added to the player belt.

  • MaxAmmo: Maximum ammo allowed in the belt.

  • Amount: Bullets added by one ammo box.

Last updated