Installation Guide

Step-by-step setup for oxide-newspaperjob.

Prerequisites

Required resources

o-link expectations

This resource depends on your server's o-link setup for:

• player identity and character lookup
• notifications
• phone messaging for shift emails
• money handling
• clothing and uniform management
• vehicle keys
• targeting for depot interactions
• menu support when Config.menuStyle = 'menu'
• progress bars
• inventory support for weapon_newspaper

The route system gives and removes weapon_newspaper through olink.inventory, so your inventory integration must support that item and ammo metadata.

Installation

ensure ox_lib
ensure oxmysql
ensure o-link
ensure oxide-newspaperjob

CREATE TABLE IF NOT EXISTS `job_progression` (
    `char_id`            VARCHAR(60)      NOT NULL,
    `job`                VARCHAR(40)      NOT NULL,
    `level`              TINYINT          NOT NULL DEFAULT 1,
    `total_count`        INT              NOT NULL DEFAULT 0,
    `daily_streak`       INT              NOT NULL DEFAULT 0,
    `last_activity_date` DATE             NULL,
    `complaints`         TINYINT UNSIGNED NOT NULL DEFAULT 0,
    `timeout_until`      DATETIME         NULL,
    PRIMARY KEY (`char_id`, `job`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;

Verification

Optional Setup

Phone messaging

When Config.usePhone = true, the resource sends service emails through o-link.phone for shift start, bike loss, out-of-ammo incidents, death or hospitalization, and the detailed clock-out summary. Make sure your o-link phone module is configured for the phone resource your server uses.

Config.shiftSummary controls the immediate on-screen clock-out summary:

Config.shiftSummary = 'nui'   -- popup summary
Config.shiftSummary = 'text'  -- notification summary

Inventory setup

Routes add and remove a weapon_newspaper item through olink.inventory, with ammo passed as item metadata:

olink.inventory.AddItem(source, 'weapon_newspaper', 1, nil, { ammo = routeData.ammoCount })

Make sure:

• your inventory integration recognizes weapon_newspaper
• the ammo metadata key is preserved on add
• the underlying throwable weapon flow works with WEAPON_ACIDPACKAGE

['WEAPON_NEWSPAPER'] = {
    label = 'Newspaper',
    weight = 50,
    throwable = true,
    model = 'WEAPON_ACIDPACKAGE',
    client = {
        image = 'WEAPON_ACIDPACKAGE.PNG',
    },
},

Whichever inventory you use, confirm o-link's inventory module is pointed at it so olink.inventory.AddItem / RemoveItem reach the correct backend.

Admin permission for the depot builder

The /newspaperbuilder command (for adding your own depots and delivery houses) is admin only. It uses the same admin check as every Oxide resource, so there's nothing extra to set up per resource.

If you're already running QBCore, QBX, or ESX admins, those admins pass automatically — you don't need to do anything.

To make someone an admin, add them to the admin group and grant that group the admin ace by adding these two lines to your server.cfg:

add_principal identifier.license:<their-license> group.admin
add_ace group.admin admin allow

Replace <their-license> with the player's license identifier. See the Admin Tools page for how the builder works.

Uniform customization

Uniform support is disabled by default:

Config.uniformsEnabled = false

If you want the uniform option in the shift menu, enable it and replace the placeholder outfit values in shared/config/outfits.lua.

Notes for UI developers

The packaged web/dist build is already included and referenced by the manifest. Rebuilding the UI is only necessary if you edit files under web/src.

Next Steps