> For the complete documentation index, see [llms.txt](https://docs.fivemcustoms.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.fivemcustoms.com/fc-lspdbadge/installation.md).

# Installation

Get the resource running in a few minutes.

## 1. Add the resource

Put the `FC-LspdBadge` folder inside your resources folder.

{% hint style="warning" %}
Don't rename the folder. The item export points to `FC-LspdBadge`, with any other name you'll get the error `No such export useBadge`.
{% endhint %}

## 2. Add the item

Open `install/items.lua` and paste the item inside `ox_inventory/data/items.lua`:

{% code title="ox\_inventory/data/items.lua" %}

```lua
['lspd_badge'] = {
    label = 'LSPD Badge',
    weight = 60,
    stack = false,
    close = true,
    description = 'Leather badge wallet with a Los Santos Police Department id card',
    client = {
        export = 'FC-LspdBadge.useBadge',
    },
},
```

{% endcode %}

You can change `label`, `description` and `weight` as you like. The `export` line has to stay exactly like this.

## 3. Add the image

Copy `install/lspd_badge.png` into `ox_inventory/web/images/`.

## 4. server.cfg

Start the resource after all its dependencies:

{% code title="server.cfg" %}

```properties
ensure oxmysql
ensure ox_lib
ensure es_extended  # or qb-core / qbx_core
ensure ox_target
ensure ox_inventory
ensure screenshot-basic
ensure FC-LspdBadge
```

{% endcode %}

## 5. Database

Nothing to do here. The `fc_lspdbadge` table is created automatically the first time the resource starts. If you'd rather create it yourself, import `install/fc_lspdbadge.sql`.

## 6. Place the ped

The default ped stands inside Mission Row. If you use a custom MLO, change `ped.coords` in `config.lua` (see [Configuration](/fc-lspdbadge/configuration.md)).

Restart the server and you're done.


---

# 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://docs.fivemcustoms.com/fc-lspdbadge/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.
