Configuration Reference

Every setting in oxide-newspaperjob, explained. Start with How Settings Work — the job keeps its settings in your database, so editing the config files does not always do what you expect.

How Settings Work

Settings are edited in-game with the /newspaper settings command (admins only). Changes save to your database and apply instantly — no restart needed.

The config files in the shared/ folder are factory defaults. The first time the resource starts, every value is imported from the files into the database; from then on, the database is the source of truth and editing the files has no effect on settings that are already stored, even after a restart. Only brand-new settings added by a future update are imported from the files.

The files are still read at every start as the factory defaults behind the Reset to default button next to each setting in /newspaper settings. Pressing it replaces the stored value with the file's value and applies right away. So a file edit only takes effect after you restart the resource and then press Reset to default on that setting.

This includes the depots and delivery houses — they are stored in the database like every other setting, so you change them through /newspaper settings too, not by editing the file on a running server. The /newspaperbuilder tool (see Admin Tools) only captures coordinates into an export file: enter those values through /newspaper settings, or paste the export into shared/config/locations.lua, restart, and press Reset to default on Depots (see Adding another depot).

Two settings are never copied into the database, so they are always read from the files: Config.UseHudAccent in shared/config.lua, and Config.SettingsCommand in shared/config/models.lua, which only sets the command named in missing-model warnings.

So there are two ways to work:

1. First-time setup: edit the files in shared/ before the resource's first start. Your values are imported automatically.
2. Changing a setting later: run /newspaper settings in game as an admin. See The Settings Editor for how the menu works.

The tables below document every setting and its factory default.

Which File Has What

Main Settings

File: shared/config.lua

Pay

File: shared/config/job.lua, Config.Payment

Complaints

File: shared/config/job.lua, Config.Complaints

Route Timer

File: shared/config/job.lua, Config.Timer

Cancelling a Route

File: shared/config/job.lua, Config.Cancel

Players can drop the route they're on without clocking out, using the Cancel Current Task option in the shift menu or on the delivery bike. Cancelling costs them nothing except a short wait before the next route.

Config.Cancel = {
    cooldownSeconds = 60,   -- Wait before a new route can be requested after cancelling (0 = no cooldown)
}

The wait is stored against the character, not the player's connection, so relogging does not reset it. While it's running, asking for a route tells the player how many seconds are left.

Throwing

File: shared/config/job.lua, Config.Throw

Paper Supply

File: shared/config/job.lua, Config.Supply

Pickup Animation

File: shared/config/job.lua, Config.Animations.pickup — the short packing animation played at the depot before a route starts.

Newspaper Bag

File: shared/config/job.lua, Config.NewspaperBag — the bag prop shown on the player's back during a route.

Levels

File: shared/config/levels.lua

Five levels ship by default, from Paper Carrier through Route Legend. Each entry in Config.Levels sets:

You can add, remove, or re-tune levels freely — just keep requiredDeliveries increasing from one level to the next.

Depots and Houses

File: shared/config/locations.lua

Config.Locations is a list of depots. The script ships with 2 depots and 80 delivery houses between them, and you can have as many depots as you like. Each depot entry contains:

menuCamera is only used when Config.menuStyle = 'nui'. It's the shot the player sees behind the shift menu:

Each house in deliveryZones has:

Tip: you don't need to type coordinates by hand. In /newspaper settings → Locations (the Depots list), Place in world lets you pick a spot in the game world, with a live preview of the worker, the bike, or the house spot. The in-game builder (/newspaperbuilder) captures depots and houses where you're standing and exports a ready-to-paste list for this file, which takes effect after a restart and Reset to default on Depots. See Admin Tools.

Adding another depot

Every entry in Config.Locations is a complete, self-contained depot. Add another table entry — a new block wrapped in { } inside the list — and you get a second newspaper depot with its own worker, its own map blip, its own bike spawn, and its own set of houses. Nothing else needs to be turned on.

Two things to know before you build one:

• Houses belong to the depot they're listed under. The deliveryZones list inside a depot entry is the only set of houses that depot hands out. A player who clocks in at depot 2 is never sent to depot 1's houses, so give each depot enough houses of its own (at minimum, more than the biggest route your top level can hand out — 16 houses at level 5 in the shipped config).
• A shift belongs to the depot the player clocked in at. Slots (Config.MaxSlotsPerLocation, 3 by default) are counted per depot, so three depots means three carriers each, nine in total. Players clock out at the depot where they started.

The worker, the map blip, and the interaction prompt are all created automatically for every entry in the list — you never have to register anything by hand.

The easiest way to build one is in-game with /newspaperbuilder (see Admin Tools): stand where you want the worker, place the bike spawn and the houses by walking to them, and the builder exports a finished Config.Locations list to paste into shared/config/locations.lua (see below for making it take effect).

If you'd rather write it by hand, copy an existing entry and change the values. The shape looks like this:

Config.Locations = {
    -- ... the depots that already ship with the resource ...

    {
        name = 'Vespucci Beach Press',            -- shown on the map and in the menu
        coords = vector3(-1300.00, -1200.00, 4.5), -- where the depot worker stands
        heading = 90.0,                            -- which way the worker faces
        vehicleSpawn = vector4(-1296.00, -1204.00, 4.5, 180.0), -- where the bike appears
        menuCamera = {
            coords = vector3(-1303.00, -1203.00, 6.0),
            heading = 270.0,
            fov = 50.0,
        },
        deliveryZones = {
            { coords = vector3(-1250.00, -1150.00, 4.6), minLevel = 1, label = 'Bay City Ave' },
            { coords = vector3(-1244.00, -1142.00, 4.6), minLevel = 1, label = 'Bay City Ave' },
            -- ... add as many houses as you want ...
        },
    },
}

Once the job has started, the depots live in the database, and editing this file changes nothing on its own, even after a restart. There are two ways to change them:

• In-game: run /newspaper settings (admins only) and open Depots under Locations. Add, edit, reorder or remove depots there, and edit each depot's Houses list. Place in world lets you pick the clerk spot, the bike spawn or a doorstep in the game world instead of typing coordinates. Save, and the change applies live: the new depot's blip appears on the map right away, no restart. The menu camera (menuCamera) is not in this editor, so a depot added here opens its shift menu without a camera shot. Depots that already had one keep it.
• From the file: edit shared/config/locations.lua (or paste a /newspaperbuilder export into it, see Making the export take effect), restart the resource, then press Reset to default on Depots.

You can edit, reorder or delete depots while carriers are on shift. A shift keeps its depot as long as the depot keeps either its name or its worker spot, and the depot worker's Get Delivery Route option moves with it. If you delete a depot (or change its name and its worker spot in the same save), the shifts there end straight away and are paid as a clock-out would pay them, the usual pay stub goes to the phone, and the players are told "Your depot was removed, so your shift has ended." Slot counts stay correct either way.

The Bike

File: shared/config/vehicles.lua, Config.Vehicle

Map Icons and the Depot Worker

File: shared/config/visuals.lua

Config.DeliveryMarker controls the marker drawn around the active house target — it only appears when Config.Debug is on, as a tuning aid:

Config.Waypoints tunes the floating house indicator (the one shown by holding H): how high it floats, how it scales with distance, and how often it refreshes.

Uniforms

File: shared/config/outfits.lua

Config.NewspaperOutfitMale and Config.NewspaperOutfitFemale define the outfits as lists of clothing component and prop values. The shipped values are placeholders — set your own before enabling uniforms.

Tutorials

File: shared/config/tutorials.lua

Nine first-time tips ship by default, keyed by moment (first_clockin, first_throw_hit, first_bike_lost, and so on). Each defines an icon and the title/body text keys. Entries can optionally set a screen position and a duration in seconds — when omitted, tips show top-right for 10 seconds.

With Oxide HUD, every tutorial card left at the default position (top right) appears where each player puts the tutorial cards in the /hud editor. A card you give another position keeps that position.

The tip text itself lives in locales/en.json, so it can be translated.

Model Replacements

File: shared/config/models.lua — the Compatibility section of /newspaper settings.

Every model the job spawns (the bike, the depot worker, the newspaper bag, and the throwable weapon) is checked before it loads. If a model doesn't exist on a player's game build — older builds lack newer DLC props — it is skipped instantly with a warning naming the model, instead of freezing the load. Nothing is swapped automatically; you choose the replacement.

Config.ModelSwaps = {
    { from = 'xm3_p_xm3_m_bag_var22_arm_s', to = 'your_bag_prop' },
}

When a model is missing, online admins get a notification naming it, and the server log records it. Each missing model is reported once, and the warnings are capped per player and in total, so one misbehaving client can't flood admins or the log. Saving a swap lets that model report again if the replacement is also missing.

Rate Limits

The server enforces short cooldowns on player actions to block spam. These are fixed in server/main.lua (not in a config file):

Next Steps

• Features
• Installation
• Admin Tools
• API Reference
• Troubleshooting