Installation Guide

Step-by-step setup for oxide-newspaperjob.

Before You Start

These resources need to be installed and working first:

What o-link handles

o-link is what lets this one script run on QBCore, Qbox, or ESX without changes. This script relies on it for:

• knowing when a player has loaded into a character
• showing notifications
• sending shift messages (texts or mail) to the player's phone
• paying out money and charging fines
• applying and removing the carrier uniform
• giving the player keys to the delivery bike
• the "press to interact" option on the depot worker
• the context menu, if you switch Config.menuStyle to 'menu'
• progress bars
• giving and removing the newspaper item

There is nothing extra to set up for most of this. If o-link is already running on your server, this script connects to it automatically. The one thing that does need setup is the newspaper item itself — see Add the newspaper item below.

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;

Add the Newspaper Item

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

Checking That It Works

Changing Settings

Once the resource has started for the first time, its settings live in your database and are edited in-game with /newspaper settings (admins only). Changes apply instantly, no restart needed. The config files under shared/ are only factory defaults, imported on the very first start — after that, editing them changes nothing unless you restart and press Reset to default on that setting.

So: tweak the files before the first start if you like, and use /newspaper settings from then on. See How Settings Work.

Optional Setup

The job settings below (phone messages, shift summary, uniforms) are changed in-game with /newspaper settings (admins only), as described in Changing Settings.

Shift messages on the phone

When Config.usePhone = true (the default), the depot sends the player messages on their phone:

• a welcome message when they clock in
• incident notices: a lost bike, running out of papers, a route cancelled after going down on the job, and a clock-out after a hospital stay
• a full pay stub when they clock out

This goes through o-link's phone module, so it works with whatever phone script o-link is set up for on your server. Supported phones: qb-phone, lb-phone, gksphone, okokPhone, qs-smartphone, qs-smartphone-pro, yseries, and Oxide Phone.

How each message arrives depends on the phone:

On any phone, a message arrives as mail if the text can't be sent, or if your server runs an o-link older than 1.11.0.

Oxide Phone's Gigs app

If you run Oxide Phone, players can follow this job in its Gigs app: the depots and whether each one has room, the route they're on (current house, progress, pay so far, and tips), and their level. While a player carries an Oxide Phone and the Gigs app is switched on (it is by default), shift updates arrive there as Gigs notifications instead of texts. The pay stub at clock-out never goes to the Gigs app; it always arrives as a text or mail.

You don't need to set anything up for this — just run Oxide Phone and this job.

Servers without a phone

If your server has no phone, turn off Use phone (Config.usePhone) under General in /newspaper settings. Nothing is sent to the phone then. Players still get on-screen notifications for a lost bike, running out of papers, a cancelled route, and a hospital clock-out, plus the clock-out summary described below.

The on-screen clock-out summary

Separate from the phone messages, Shift summary (Config.shiftSummary) controls what the player sees on screen the moment they clock out:

Config.shiftSummary = 'nui'   -- a pop-up summary window
Config.shiftSummary = 'text'  -- a simple notification

Admin permission

/newspaper settings and the /newspaperbuilder depot tool are admin only. They use the same admin check as every Oxide resource, so there's nothing extra to set up per resource.

If you're already running QBCore, Qbox, 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 Admin Tools for the settings editor and the builder.

Uniforms

A carrier uniform option can be shown in the shift menu, but it ships disabled (Config.uniformsEnabled = false).

The shipped outfit values (factory defaults in shared/config/outfits.lua) are placeholders. If you want uniforms, turn on Uniforms in /newspaper settings and fill in Male outfit and Female outfit (on the Advanced tab) with clothing values that fit your server's clothing pack.

Review the other settings

Everything about the job is adjustable — pay rates, timers, fines, levels, bike model, blips, and more. See the Configuration Reference for every setting explained.

A Note on the UI

The interface is pre-built and included (the web/dist folder). You do not need to install Node.js or build anything. Rebuilding is only needed if you edit the source files under web/src.

Next Steps