FAQ

Can I configure it for my server?

Yes. config.lua, data/ and locales/ are open, not encrypted: prices, payment, consumption per vehicle class or model, tank sizes, diesel and electric models, blips, command names, admin rights, notifications, the attendant, the delivery job, the stations and the languages. With hz_lib, prices, payment, consumption and the driver's pay also change in game from /hzpanel, live. Every setting is on the Configuration page.

Does it work with ESX, QBCore and Qbox?

Yes, and with ox_core or a standalone server. The framework is detected on its own, through hz_lib when it runs.

Which resources does it need?

Can I keep LegacyFuel or ox_fuel?

No. Remove it: two fuel scripts drain and refill the same vehicles. HZ-Fuel answers their exports and statebag, so the scripts that used them keep working. See Exports & compatibility.

My garage, HUD or job calls LegacyFuel. Do I have to edit it?

No. exports['LegacyFuel']:GetFuel and SetFuel, the qb-fuel, cdn-fuel and ps-fuel versions, ox_fuel's payment hooks and the fuel statebag are all answered by HZ-Fuel.

Does it need ox_target or qb-target?

No. Prompts come from HZ-TextUi when it runs, otherwise from ox_lib's text UI. HZ-Fuel runs fine on a server that has ox_target or qb-target.

Players have cash but the pump says PAYMENT DECLINED.

The modern pumps and the chargers take the card, so the bank account (cardOnly = true). Set cardOnly = false to charge paymentAccount first, then the other account. The country stations take cash. See Payment.

Fuel is free on my server.

With requirePayment = 'auto', payment turns itself off when no money system is found. The server console prints the payment mode at startup. Set requirePayment = true to force it.

A station has no screen, no nozzle and no prompt.

A map replaced the game's pumps with its own model. See Maps that replace the pumps.

Cruise control or my HUD lost the fuel after restarting HZ-Fuel.

Restart the whole server after an update, not HZ-Fuel alone. It is a FiveM limit: players already connected see the names HZ-Fuel replaces as not running until they reconnect.

How do I make an add-on vehicle diesel or electric?

Add its spawn name to dieselVehicles, or to electric.electricVehicles. Every other vehicle, add-ons included, runs on petrol.

Which languages are included?

19 languages for every message, prompt and screen, following ox_lib's language. The NPC voices are English or French, with their lines shown in each player's language. See Language.

Can I turn off the delivery job or the attendant?

Yes. delivery.enabled = false turns off the job, and stations then never run out. oldPumps.attendant.enabled = false turns the country stations into self-service.

How much does a delivery driver earn?

With the defaults, about $1,350 to $1,940 for a full tanker delivered 6 km from the refinery, and up to about $6,200 an hour when there is enough demand. Everything is set in config.delivery.pay. See Pay.

Do I need a database?

No. Station stocks and jerry can levels are saved by the server itself. Only an old ESX needs one SQL query for the delivery job, see Installation.