General

This section explains how to properly configure the script to get the most out of all features, including reload types, ammo boxes, notifications, and inventory management. Follow each step carefully to ensure full functionality.

1. Language & Framework Settings

  • LANGUAGE: Set to your preferred language code (e.g., "en" for English). Controls all messages, prompts, and notifications.

  • AUTOMATIC_ITEM_CREATION:

    • Enable (true) to automatically create required ammo items.

    • Compatible only with qb-core and esx.

    • Set to false if using another framework.

2. Automatic Reload

  • CONSTANT_RELOAD:

    • Enable (true) to reload weapons automatically when their magazine is empty.

    • Disable (false) if you want reloads to be manual only.

3. Reload Command & Keybind

  • RELOAD_WEAPON allows you to assign a command and hotkey for reloading:

    • COMMAND_NAME: Name of the command, e.g., "reload_weapon".

    • KEY_MAPPING:

      • VALUE: Enable or disable the keybind.

      • DESCRIPTION: Tooltip in-game describing the hotkey.

      • DEFAULT_MAPPER: Default input device (e.g., "KEYBOARD").

      • DEFAULT_PARAMETER: Default key for the action (e.g., "R").

4. Unload Ammo from Current Magazine

  • UNLOAD_AMMO_FROM_CLIP:

    • Enable (true) to allow players to unload bullets from the current weapon back into the inventory.

    • COMMAND_NAME: Command to trigger this action (e.g., "unload_ammo").

    • KEY_MAPPING (optional): Assign a hotkey for unloading ammo:

      • VALUE: Enable or disable the hotkey.

      • DESCRIPTION: Tooltip in-game.

      • DEFAULT_MAPPER: Input device (usually "KEYBOARD").

      • DEFAULT_PARAMETER: Default key (e.g., "L").

5. Ammo Crates / Ammo Boxes

  • AMMO_CRATES: Enables players to receive a configured amount of bullets instantly using ammo boxes.

    • VALUE: Enable or disable this feature.

    • LIST: Define each ammo box item:

      • QUANTITY: Number of bullets granted when used.

      • REWARD_ITEM: The inventory item to be added (e.g., "pistol_ammo").

      • MODEL: 3D model representing the crate.

  • Progress & Animations:

    • Knife Requirement (Optional): Players may need a knife equipped to use ammo boxes. Configurable under KNIFE.

      • WEAPON_MODELS: List of valid knives.

      • BONE_ID, POSITION, ROTATION: Attach knife properly during the animation.

    • Crate Props: Position and rotation of the crate during use.

    • Animation: Set animation dictionary, name, flags, and duration (TIME_MS).

6. Notifications

  • INVENTORY_BOX: Enable (true) to show visual notifications whenever an item is added or removed from inventory.

  • TOGGLE_ALERTS: Control different notification types:

    • SUCCESS: Display success messages.

    • ERROR: Display error messages (recommended to keep for new players).

    • PRIMARY: Display primary/warning messages (recommended to keep).

7. General Tips for Configuration

  • Always use backticks and square brackets when assigning weapon hashes or item keys in tables.

  • Hotkeys and commands are fully configurable and can be enabled or disabled as needed.

  • Ammo boxes, knives, and props are optional features; they can be activated or deactivated independently.

  • Partial reloads, manual bullet loading, and magazine types can all be customized to match your server’s desired realism.

  • Check your inventory setup to ensure bullets, magazines, and ammo boxes are properly registered for the scripts to function correctly.

✅ Summary: This configuration allows full control over:

  • Reload types (automatic, manual, adjustable magazines).

  • Inventory-aware reloads and unloading ammo.

  • Ammo boxes with optional knife requirements and custom animations.

  • Hotkeys, commands, and notifications.

  • Multilingual support and framework compatibility.

With this setup, your server will have realistic ammo handling, full customization, and an immersive experience for players.

PreviousConfigurationNextAn Item For All Weapons

Last updated