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

# Commands & permissions

Commands, keys and interactions of Cuxial Fuel, and who can use each one.

Cuxial Fuel has a handful of commands. The screen positioner is reserved for staff; the rest are open to players.

## Commands

| Command        | Who                                                         | What it does                                                                                                                                                          |
| -------------- | ----------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `/fuel_type`   | Anyone inside a vehicle, in any seat                        | Shows the fuel of the vehicle in a notification. The name is set in `fuelTypeCommand`.                                                                                |
| `/fuel_chart`  | The driver of a vehicle that consumes fuel                  | Opens or closes the consumption chart: fuel, speed and litres per second. The name is set in `chart.command`. It closes by itself when the player leaves the vehicle. |
| `/fuel_screen` | Staff (`admin.permission`), within 6 m of a pump or charger | Opens the screen positioner for that model. Run it again to close without saving.                                                                                     |
| `/fuelaudio`   | Anyone, only with `debug` on                                | Plays every sound of the script, to test them. The name is set in `audio.debugCommand`.                                                                               |

{% hint style="info" %}
`/fuel_chart` and its key only exist with `chart.enabled = true`. `/fuel_screen` only works with `screen.enabled = true`.
{% endhint %}

## Keys

| Key                                    | Action                                                                                                                                                               |
| -------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <kbd>F3</kbd>                          | Gives the cursor to the consumption chart while it is open. The default comes from `chart.focusKey`; each player can rebind it in the GTA key settings, under FiveM. |
| <kbd>Esc</kbd> or <kbd>Backspace</kbd> | Leaves the pump screen without buying.                                                                                                                               |
| Left click                             | Presses the buttons of the pump screen.                                                                                                                              |

## Interactions

Shown by `sleepless_interact` when the player looks at the object.

| Where           | Option                  | When                                                       |
| --------------- | ----------------------- | ---------------------------------------------------------- |
| Pump            | **Refuel**              | No nozzle in hand and no jerry can equipped.               |
| Charger         | **Charge**              | Same conditions.                                           |
| Pump or charger | **Return the nozzle**   | Nozzle in hand, not refuelling.                            |
| Fuel cap        | **Refuel**              | Nozzle in hand or jerry can equipped, on foot.             |
| Fuel cap        | **Stop refueling**      | While the fuel is flowing.                                 |
| Fuel cap        | **Take out the nozzle** | The nozzle stayed plugged in after the engine was started. |

## Screen positioner

`/fuel_screen` places the pump screen on a model that has no position, or adjusts an existing one. An outline shows where the screen will be drawn.

| Key                                       | Action                                 |
| ----------------------------------------- | -------------------------------------- |
| Arrow keys                                | Move the screen sideways and forwards. |
| <kbd>Page Up</kbd> / <kbd>Page Down</kbd> | Raise or lower it.                     |
| <kbd>Q</kbd> / <kbd>E</kbd>               | Rotate it.                             |
| <kbd>Shift</kbd> + arrow keys             | Change width and height.               |
| <kbd>Ctrl</kbd>                           | Bigger steps while held.               |
| <kbd>Tab</kbd>                            | Switch between one and two faces.      |
| <kbd>Enter</kbd>                          | Save.                                  |
| <kbd>Backspace</kbd>                      | Cancel.                                |

Saving keeps the position on your own game only and prints a line in the F8 console:

```lua
my_custom_pump = { offset = vec3(0.000, -0.280, 1.100), yaw = 0.0, width = 0.500, height = 0.260, sides = 2 },
```

Paste that line into `screen.models` in `shared/config.lua` and restart the resource so every player gets it. Cancelling removes the position saved on your game and goes back to the one in the config.

{% hint style="warning" %}
Do not adjust the models delivered in `cuxial_gas_assets` (the ones with `mesh = true`). Their screen is part of the model and its measurements are exact.
{% endhint %}

## Permissions

* `/fuel_screen` requires the framework permission named in `admin.permission`, `'admin'` by default, checked through Cuxial Bridge.
* `jobDiscounts` in `shared/config.lua` gives a percentage off to the listed jobs while on duty. See [Configuration](/scripts/vehicles/cuxial-fuel/configuration.md).


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.cuxial.com/scripts/vehicles/cuxial-fuel/commands.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 `automate deployments from our CI pipeline` 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.
