Configuration

Everything is in config.lua, which stays open and editable. The stations are listed in data/stations.lua, the delivery sites in data/delivery.lua. The delivery job has its own page: Fuel delivery job.

In /hzpanel

With hz_lib running, /hzpanel has a Fuel tab. A change applies at once on the server and for every player, no restart. config.lua stays the default: a setting never saved in the panel keeps its config.lua value, and a server without hz_lib simply uses config.lua. A value saved in the panel wins over the file. With hz_lib 1.2.1 or newer, the panel's reset button drops that value and the setting follows config.lua again. With hz_lib 1.2.0, the reset button saves the panel's own default instead.

• General: card only at modern pumps and chargers (cardOnly), account charged first (paymentAccount), price per litre of each fuel, fast and normal charging prices, jerry can and refill prices, burn rate of every vehicle (globalFuelConsumptionRate).
• Delivery job: pay per litre delivered for each fuel, pay per km, most a driver earns per hour, truck deposit.

General

Blips, commands & admins

commands = {
    fuelType = 'fueltype',      -- what the current vehicle drinks
    tanker = 'tanker',          -- delivery job: what the trailer carries
    orders = 'hzfuelorders',    -- delivery job: the tours board
    stock = 'hzfuelstock',      -- admin: station stocks
    sites = 'hzfuelsites',      -- admin: stations and delivery points
    place = 'hzfuelplace',      -- admin: move a delivery point to where you stand
},

-- called on the client with ox_lib's notify table { title, description, type, duration }
notify = function(data)
    exports['my_notify']:Alert(data.title or 'Fuel', data.description, data.type, 5000)
end,

Payment

Fuel types & prices

fuelTypes = {
    regular = { label = 'Regular', price = 2.50, consumption = 1.0 },
    plus    = { label = 'Plus',    price = 3.00, consumption = 0.9 },
    premium = { label = 'Premium', price = 3.50, consumption = 0.8 },
    diesel  = { label = 'Diesel',  price = 2.80, consumption = 0.85 },
},
defaultFuelType = 'regular',
fuelAmounts = { 20, 40, 'full' },

Vehicles

Consumption

consumption = {
    -- tick, replicateEvery, replicateDelta, damageLeak as above
    classes = { [18] = 0.0, [8] = 0.6 },
    models = { adder = 1.5 },
},

The class and model multipliers come on top of globalFuelConsumptionRate and of the fuel grade's consumption.

Pumps & hoses

Jerry can

Another inventory? Fill in the three server-side functions, used before anything else:

petrolCan = {
    has = function(source) return exports['my_inventory']:HasItem(source, 'weapon_petrolcan', 1) end,
    give = function(source) return exports['my_inventory']:AddItem(source, 'weapon_petrolcan', 1) end,
    canCarry = function(source) return exports['my_inventory']:CanCarryItem(source, 'weapon_petrolcan', 1) end,
},

Old stations & attendant

Electric charging

Drop-in replacement

Stations

data/stations.lua lists the 27 stations: 17 modern ones and 10 country stations with an attendant.

{
    id = 'ls_ltd_grove',
    brand = 'ltd',
    label = 'LTD Grove Street',
    coords = vec3(-71.28, -1761.16, 29.48),
    radius = 60.0,
    pumps = {
        vec3(-63.61, -1767.93, 28.26),
        -- one line per pump
    },
},

Language

HZ-Fuel follows ox_lib's language. Set it in your server.cfg:

setr ox:locale "fr"

19 languages ship in locales/: cs, de, en, es, et, fr, hr, hu, it, lt, nl, pl, pr, pt-br, ro, ru, tr, zh-cn and zh-tw. Missing lines fall back to English. For another language, copy locales/en.json to a new file named after its code and translate it.

The NPC voices are English or French (voice.language). The text of their lines in the dialogue box follows each player's language, like subtitles.