> ## Documentation Index
> Fetch the complete documentation index at: https://axeldevelopment.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Installation Guide

> Step-by-step setup and installation instructions for axel_arena.

## Prerequisites

Ensure you have the following installed and running before starting:

* **MySQL** : [oxmysql](https://github.com/overextended/oxmysql)
* **Framework**: ESX Legacy, QBCore, or Qbox
* **Inventory**: `ox_inventory`, `qs-inventory`, `tgiann-inventory`, or `qb-inventory`
* **Optional**: `ox_lib` or custom ( recommended for notifications)

***

# 1. UI

ensure ox\_lib before axel\_arena

# 2. Framework & Inventory

ensure es\_extended     # or qb-core / qbx\_core ensure ox\_inventory    # or your inventory

<Steps>
  <Step title="Extract axel_arena">
    Extract the downloaded folder into your server's `resources` directory.

    <Warning>
      Do not rename the folder `axel_arena`.
    </Warning>
  </Step>

  <Step title="Import Database ">
    Execute the provided `.sql `file in your database.
  </Step>

  <Step title="Setup config.lua file">
    In config setup - inventory, framework, notification and ambulance job, if your script not supported open ticket or integrate custom from editable.lua file
  </Step>

  <Step title="Configure server.cfg">
    Add the resource to your `server.cfg`. It must be started **after** the database, framework, and inventory resources.

    <CodeGroup>
      ```cfg server.cfg (Startup Order) theme={null}
      # 1. Database
      ensure oxmysql
      ensure ox_lib
      ensure framework
      # 4. Arena
      ensure axel_arena
      ```

      ```cfg server.cfg (Discord Avatars - Optional) theme={null}
      # Optional Discord Bot Token for fetching player avatars in lobby&menu
      set arena_discord_token "YOUR_BOT_TOKEN_HERE"
      ```
    </CodeGroup>
  </Step>
</Steps>

***