> For the complete documentation index, see [llms.txt](https://mrcscripts.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://mrcscripts.gitbook.io/docs/scripts/metermaid/install-instructions.md).

# Install Instructions

Install instructions for mrc-metermaid

### What this is

This guide installs the `mrc-metermaid` resource on your FiveM server.

{% hint style="info" %}
Coming soon. Some filenames and config keys may change before release.
{% endhint %}

### Requirements

* A FiveM server
* [community\_bridge](https://github.com/TheOrderFivem/community_bridge) (must start **before** `mrc-metermaid`)

### Add the resource

* Put `mrc-metermaid` into your server’s `resources` folder.
* Start it in `server.cfg`.

```cfg
# Example server.cfg
ensure community_bridge
ensure mrc-metermaid
```

### Framework setup

Pick your framework:

* [Frameworks](/docs/scripts/metermaid/install-instructions/frameworks.md)
  * [ESX](/docs/scripts/metermaid/install-instructions/frameworks/esx.md)
  * [QBCore](/docs/scripts/metermaid/install-instructions/frameworks/qbcore.md)
  * [Qbox](/docs/scripts/metermaid/install-instructions/frameworks/qbox.md)

### Inventory setup (items + images)

Pick your inventory:

* [Inventories](/docs/scripts/metermaid/install-instructions/inventories.md)
  * [qb-inventory](/docs/scripts/metermaid/install-instructions/inventories/qb-inventory.md)
  * [ox\_inventory](/docs/scripts/metermaid/install-instructions/inventories/ox_inventory.md)

### Configure

Open `mrc-metermaid/config.lua`.

Tune settings for:

* allowed jobs / job grades
* player-only infractions
* ticket expiry, auto-clamping, and ticket retention
* UI / menu options

### Restart and test

* Restart the server (or `restart mrc-metermaid`).
* Go on duty with an allowed job.
* Confirm:
  * PDA opens
  * tickets can be issued
  * wheel clamp applies correctly
  * disputes show in the department menu

### Profit

You’re set.


---

# 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 following URL with the `ask` and `goal` query parameters:

```
GET https://mrcscripts.gitbook.io/docs/scripts/metermaid/install-instructions.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `build a script that syncs our docs to a CMS` lets GitBook tailor the answer to that use case.

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.