> For the complete documentation index, see [llms.txt](https://5code.gitbook.io/5code-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://5code.gitbook.io/5code-docs/5code-loadouts/getting-started/installation.md).

# installation

Follow these steps in order.

### 1. Place the resource

Drop the `5code-loadouts` folder into your server's resources directory.

{% hint style="danger" %}
Do **not** rename the folder. It must stay exactly `5code-loadouts` — the in-game menu loads its images from that path. Renaming the folder will break images and some UI assets.
{% endhint %}

### 2. Edit `config.lua`

Open `config.lua` and set the basics for your server.

```lua
Config.Framework       = 'auto'          -- 'auto' | 'qb-core' | 'qbx_core' | 'esx'
Config.InventorySystem = 'ox_inventory'  -- 'qb-inventory' | 'ox_inventory' | 'codem-inventory'
Config.InteractionMode = 'target'        -- 'target' | 'textui'
Config.NotifySystem    = 'ox_lib'        -- 'qb' | 'ox_lib' | 'codem-notification' | 'esx'

Config.Job = 'police'
Config.NPC = {
    model    = 'mp_m_armoured_01',
    coords   = vector4(452.6, -993.1, 30.7, 90.0),
    scenario = 'WORLD_HUMAN_GUARD_STAND',
    label    = 'Armory Officer'
}

Config.BossGrades = { 3, 4 }
```

### 3. Grant admin access via ACE

Add the admin ACE line for each admin's license identifier in `server.cfg`.

```cfg
add_ace identifier.license:YOUR_LICENSE_HERE loadouts.admin allow
```

### 4. Add to `server.cfg`

Make sure 5Code Loadouts starts **after** its dependencies.

```cfg
ensure oxmysql
ensure qb-core            # or qbx_core / es_extended
ensure ox_inventory       # or your chosen inventory
ensure 5code-loadouts
```

### 5. Start the server

On first start, the script auto-creates its database tables. Watch the console for any errors.

### 6. Test in-game

Go to the armory NPC coordinates, interact, and confirm you can open the armory UI. If you are in a boss grade or have `loadouts.admin`, you will also see the management UI.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://5code.gitbook.io/5code-docs/5code-loadouts/getting-started/installation.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.