> For the complete documentation index, see [llms.txt](https://devmosaic.gitbook.io/devmosaic/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://devmosaic.gitbook.io/devmosaic/resources/devmosaic-ox-fuel-rework.md).

# Ox Fuel Rework

This is a rework of `ox_fuel` that replaces the menu-and-progress-bar refuelling loop with a physical one. Players walk to a pump, take the nozzle off it, carry it to the vehicle, attach it to the actual fuel cap, and operate a screen rendered on the pump itself.

Everything upstream `ox_fuel` did still works. Your existing prices, consumption rate, petrol can settings and exports are untouched, so an existing install keeps behaving the way your players already expect.

***

### Key Features

* **A nozzle you carry**: The nozzle is a real object that leaves its holder, sits in the player's hand with a carry animation, and is visible to everybody else on the server.
* **A hose with real slack**: The hose is the pump's own mesh, skinned along a gravity curve. It sags, drags on the ground, straightens as you walk, and pulls loose if you go too far.
* **Automatic fuel inlet detection**: The nozzle finds the real filler opening on any vehicle - cars, bikes, trucks - with no per-model setup, plus a small override file for anything you want placed exactly.
* **A working pump screen**: Rendered on the pump in world space, not a fullscreen menu. Keypad, grade selection, live sale and gallon counters, and a progress bar.
* **Seven pump faces**: Every gas pump model in the game is supported, including the mechanical ones with rolling counters and the vintage pump.
* **Built for a live server**: Sessions are held server-side, one player per nozzle, routing-bucket aware, and payment is settled against a session token rather than a client request.
* **Works with your stack**: Inventory and targeting go through a bridge - ox\_inventory, qs, origen, codem, ps and qb inventories, with ox\_target, qb-target or qtarget.
* **Target and keybinds**: Works with either, and both are available at the same time.
* **Open source script**: Every file in `ox_fuel` ships readable and editable. The streamed models in `Dm_fuel_assets` are escrow protected.

### Resource Names

Two resources. Both are required.

```
ox_fuel
Dm_fuel_assets
```

`ox_fuel` is fully open source - every file is readable and editable.

`Dm_fuel_assets` holds the streamed pump, nozzle and hose models. It is escrow protected and kept separate, so the script stays open while the models stay protected.

### In This Section

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><i class="fa-download">:download:</i></td><td><strong>Installation</strong></td><td>Requirements, both resources, and server.cfg.</td><td><a href="/devmosaic/resources/devmosaic-ox-fuel-rework/installation.md">Installation</a></td></tr><tr><td><i class="fa-gear">:gear:</i></td><td><strong>Configuration</strong></td><td>Every option in config.lua, with what it does and what it costs.</td><td><a href="/devmosaic/resources/devmosaic-ox-fuel-rework/configuration.md">Configuration</a></td></tr><tr><td><i class="fa-hand-pointer">:hand-pointer:</i></td><td><strong>Refuelling</strong></td><td>How a player picks up, attaches, fills and returns the nozzle.</td><td><a href="/devmosaic/resources/devmosaic-ox-fuel-rework/refuelling.md">Refuelling</a></td></tr><tr><td><i class="fa-display">:display:</i></td><td><strong>Pump Screens</strong></td><td>The seven pump faces and how the in-world screen works.</td><td><a href="/devmosaic/resources/devmosaic-ox-fuel-rework/pump-screens.md">Pump Screens</a></td></tr><tr><td><i class="fa-car">:car:</i></td><td><strong>Vehicle Fuel Inlets</strong></td><td>How placement is worked out, and how to override a model.</td><td><a href="/devmosaic/resources/devmosaic-ox-fuel-rework/vehicle-inlets.md">Vehicle Fuel Inlets</a></td></tr><tr><td><i class="fa-map-location-dot">:map-location-dot:</i></td><td><strong>Stations And Pumps</strong></td><td>Adding stations, custom maps, and blips.</td><td><a href="/devmosaic/resources/devmosaic-ox-fuel-rework/stations-and-pumps.md">Stations And Pumps</a></td></tr><tr><td><i class="fa-plug">:plug:</i></td><td><strong>Frameworks And Bridges</strong></td><td>Supported inventories and target resources, and how one is picked.</td><td><a href="/devmosaic/resources/devmosaic-ox-fuel-rework/bridges.md">Frameworks And Bridges</a></td></tr><tr><td><i class="fa-gauge-high">:gauge-high:</i></td><td><strong>Performance</strong></td><td>What to lower first if players report frame drops at stations.</td><td><a href="/devmosaic/resources/devmosaic-ox-fuel-rework/performance.md">Performance</a></td></tr><tr><td><i class="fa-code">:code:</i></td><td><strong>Exports And Events</strong></td><td>Payment and money hooks, and the events the resource fires.</td><td><a href="/devmosaic/resources/devmosaic-ox-fuel-rework/exports-and-events.md">Exports And Events</a></td></tr><tr><td><i class="fa-wrench">:wrench:</i></td><td><strong>Troubleshooting</strong></td><td>The handful of things that actually go wrong, and the fix.</td><td><a href="/devmosaic/resources/devmosaic-ox-fuel-rework/troubleshooting.md">Troubleshooting</a></td></tr></tbody></table>
