> For the complete documentation index, see [llms.txt](https://docs.cdev.shop/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.cdev.shop/fivem/cdev-axethrowing/installation-guide.md). # Installation Guide Step by step instructions to install this resource {% stepper %} {% step %} ### Install (or update) dependencies and optional {% hint style="danger" %} **Verify all dependencies below are started**** *****before***** ****this script in your** **`server.cfg`****.** {% endhint %} #### Required | Resource | Purpose | | ------------- | --------------------------------------------------------------------------------------------------------------------------------------- | | **oxmysql** | Database driver for player data, ranking, and match history. [Download oxmysql](https://github.com/CommunityOx/oxmysql/releases/latest) | | **Framework** | One of: qb-core, qbx\_core (QBox), es\_extended (ESX Legacy) | | **Inventory** | One of: ox\_inventory, qb-inventory, qs-inventory | #### Optional | Resource | Purpose | | ------------------------------- | ------------------------------------------------------------------------------------------------- | | **ox\_lib** | Enhanced notifications. [Download ox\_lib](https://github.com/CommunityOx/ox_lib/releases/latest) | | **ox\_target** or **qb-target** | Target-based board interaction (alternative to DrawText) | | {% endstep %} | | {% step %} ### Install cDev\_Axethrowing and create a new subfolder or extract folder to server's root ### Install resource from [Portal](https://portal.cfx.re/assets/granted-assets) **After installing, you should get a zip file with the name shown below.** * cdev\_axethrowing.pack.zip {% hint style="info" %} Create a new subfolder optional step, but is *highly recommended*. {% endhint %} **If you haven’t already, create a new subfolder named `[cdev]` in your server’s root resources directory. Unzip (*****extract*****) this script into the newly created `[cdev]` subfolder.**

{% endstep %} {% step %} ### Add ACE permission Open your `server.cfg` and add the following ACE permission: ``` add_ace group.admin cdev_axethrowing.admin allow ``` **or** ``` add_ace identifier.license:xxxxxxxxxxxx cdev_axethrowing.admin allow ``` {% hint style="danger" %} **Important:**** If you are on the Qbox framework, the recommended place to paste the above permission is inside the `permissions.cfg` file instead of `server.cfg`.** {% endhint %} {% endstep %} {% step %} ### Update server.cfg & perform a full restart Once all other steps are completed, open your `server.cfg` & add `ensure cdev_axethrowing` to the very **bottom** of your resource start list (after oxmysql, your framework, inventory, and target if used). Finally, perform a full server restart. Failure to perform a full restart after installation will cause errors.

{% hint style="success" %} **Note: Once completed, use the command `/axethrowing place` in-game to place the target, or use the axethrowing target item to place a target and play!** {% endhint %} {% endstep %} {% step %} ### Add the inventory items (target + hatchet) {% hint style="danger" %} Item **names** must match `AxeThrowingConfig.Item.Target.name` and `AxeThrowingConfig.Item.Hatchet.name` in `public/shared/config.lua` (defaults: `axe_throwing_target` and `axe_throwing_hatchet`). If you rename them in config, rename the items here too. {% endhint %} {% tabs %} {% tab title="Ox Inventory" %} **Location:** `ox_inventory` → `data` → `items.lua` 1. Open `resources/[ox]/ox_inventory/data/items.lua` 2. Add **both** items inside the return table: ```lua ['axe_throwing_target'] = { label = 'Axe Throwing Target', weight = 5000, stack = false, close = true, consume = 0, description = 'Place on a wall to open an axe throwing lane. Pick up with your pickup key when allowed.', server = { export = 'cdev_axethrowing.useAxeThrowingTarget', }, }, ['axe_throwing_hatchet'] = { label = 'Throwing Hatchet', weight = 1200, stack = false, close = true, consume = 0, description = 'Required to throw when the server configures hatchet checks.', server = { export = 'cdev_axethrowing.useAxeThrowingHatchet', }, }, ``` 3. Add images `axe_throwing_target.png` and `axe_throwing_hatchet.png` to your inventory images folder (e.g. `ox_inventory/web/images/`). 4. Save and **full restart** the server. {% hint style="warning" %} Ox uses **server exports** `cdev_axethrowing.useAxeThrowingTarget` and `cdev_axethrowing.useAxeThrowingHatchet` — these are registered by this resource (`server/classes/itemuse.lua`). {% endhint %} {% endtab %} {% tab title="QBCore / QBox (qb-inventory)" %} **Location (typical):** `qb-core` → `shared` → `items.lua` (or your inventory’s item list if your fork moved it) * Open `qb-core/shared/items.lua` (or the file where `QBCore.Shared.Items` is defined). * Add **both** items in the same format as your other useable items: ```lua ['axe_throwing_target'] = { name = 'axe_throwing_target', label = 'Axe Throwing Target', weight = 5000, type = 'item', image = 'axe_throwing_target.png', unique = false, useable = true, shouldClose = true, description = 'Place on a wall to open an axe throwing lane.', }, ['axe_throwing_hatchet'] = { name = 'axe_throwing_hatchet', label = 'Throwing Hatchet', weight = 1200, type = 'item', image = 'axe_throwing_hatchet.png', unique = false, useable = true, shouldClose = true, description = 'Required to throw when the server configures hatchet checks.', }, ``` 3. Copy the PNGs into your inventory UI images folder (e.g. `qb-inventory/html/images/` depending on your inventory build). 4. **Do not** add `server.export` lines for QB — **cdev\_axethrowing** registers useable items at runtime via `QBCore.Functions.CreateUseableItem` when **qb-core** or **qbx\_core** is running (`server/classes/itemuse.lua`). 5. Save and **full restart** the server. {% endtab %} {% tab title="QS Inventory" %} QS setups differ by framework: * **QBCore + QS:** item definitions are usually still in **`qb-core/shared/items.lua`** (same block as the QBCore tab above). The resource registers useables through **qb-core** the same way — **no** `server.export` in the item row. * **ESX + QS:** items are often under **`qs-inventory/shared/items.lua`** (or your pack’s documented path). Use the same **name / label / image / useable** fields your file expects. **cdev\_axethrowing** registers **`ESX.RegisterUsableItem`** for both names when **es\_extended** is started. Example shape (adjust field names to match your `items.lua`): ```lua ['axe_throwing_target'] = { name = 'axe_throwing_target', label = 'Axe Throwing Target', weight = 5000, type = 'item', image = 'axe_throwing_target.png', unique = false, useable = true, shouldClose = true, description = 'Place on a wall to open an axe throwing lane.', }, ['axe_throwing_hatchet'] = { name = 'axe_throwing_hatchet', label = 'Throwing Hatchet', weight = 1200, type = 'item', image = 'axe_throwing_hatchet.png', unique = false, useable = true, shouldClose = true, description = 'Required to throw when the server configures hatchet checks.', }, ``` Add both PNGs to your QS images folder, save, and **full restart**. {% hint style="danger" %} If items do nothing on use: confirm names match config, **`AxeThrowingConfig.Item.enabled = true`**, framework/inventory start **before** `cdev_axethrowing`, and check **F8** with **`AxeThrowingConfig.Debug = true`**. {% endhint %} {% endtab %} {% endtabs %} {% hint style="danger" %} If you run a **custom framework, inventory, notify, or target**, read Configurations and Integrations to align `Bridge` settings and optional bridge files under `public/bridge/`. {% endhint %} {% endstep %} {% step %} ### ⭐ In-Game Preview {% tabs %} {% tab title="Player One (Owner of Target)" %} #### Using the Axe Target from Inventory