Installation

Installation Steps

Download the latest release from the FiveM Portal
Extract wlabs_gopostal into your resources folder
Add items to your inventory system:

Inventory Items

Add to ox_inventory/data/items.lua:

['delivery_letter'] = {
    label = 'Delivery Letter',
    weight = 200,
},
['delivery_package'] = {
    label = 'Delivery Package',
    weight = 200,
},
['postal_letter'] = {
    label = 'Postal Letter',
    weight = 200,
},

Configure the script by editing shared/config.lua
Add to your server.cfg (adjust to your setup):

ensure ox_lib
ensure qb-core         # or es_extended
ensure ox_inventory    # or qb-inventory
ensure ox_target       # optional
ensure wlabs_gopostal

Configuration

Auto-Detection

By default, the script automatically detects:

Framework (qbx_core, qb-core, es_extended)
Inventory (ox_inventory, qb-inventory)
Target System (ox_target, qb-target)

Force a Specific System

To force a specific system, edit shared/config.lua:

    integration = {
        framework = 'auto',  --- 'auto' | 'qbx' | 'qbcore' | 'esx'
        inventory = 'auto',  --- 'auto' | 'ox_inventory' | 'qb-inventory' | 'none'
        target    = 'auto',  --- 'auto' | 'ox_target' | 'qb-target' | 'none'
    },

Custom Clothing

You should configure your custom clothing for the job:

    outfit = {
        male = {
            components = {
                { component_id = 3,  drawable = 9,   texture = 0 }, -- Arms
                { component_id = 4,  drawable = 10,  texture = 1 }, -- Pants
                { component_id = 6,  drawable = 116, texture = 0 }, -- Shoes
                { component_id = 8,  drawable = 15,  texture = 0 }, -- Shirt
                { component_id = 11, drawable = 32,  texture = 8 }, -- Jacket
            },
            props = {
                { prop_id = 0, drawable = 206, texture = 0 }, -- Hat
            },
        },
        female = {
            components = {
                { component_id = 3,  drawable = 9,   texture = 0 },
                { component_id = 4,  drawable = 10,  texture = 1 },
                { component_id = 6,  drawable = 116, texture = 0 },
                { component_id = 8,  drawable = 15,  texture = 0 },
                { component_id = 11, drawable = 32,  texture = 8 },
            },
            props = {
                { prop_id = 0, drawable = 206, texture = 0 },
            },
        },
    },

MLO Compatibility

It is highly recommended to go through every delivery location to see if any custom MLOs or map mods on your server might make a location inaccessible or obstructed.

Locale

The script supports multiple languages via locales/*.json. To change the language:

setr ox:locale en   # English (default)
setr ox:locale de   # German

Support

For support, join our Discord: discord.gg/ykEhStZjau

On this page