Installation Guide

Step-by-step setup for oxide-landscapingjob.

Prerequisites

Required Resources

These must be installed and running on your server before the landscaping job will start:

What this job uses from o-link

You don't need to configure anything here — this is just so you know which parts of your server this job talks to through o-link:

• notifications and on-screen help text
• phone messages, as texts or mail (shift updates and pay summaries)
• paying players and charging fines
• player names and identity
• the interaction eye/target on the office manager
• progress bars and menus
• vehicle keys and fuel for the company van
• work uniforms (optional)

If o-link is already working with your other Oxide resources, you are good to go.

Installation

ensure ox_lib
ensure oxmysql
ensure o-link
ensure xsound
ensure oxide-landscapingjob

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;

Config.Debug = false             -- extra console logging, leave off normally
Config.usePhone = true           -- send shift messages to the player's phone
Config.shiftSummary = 'text'     -- currently has no effect in this job
Config.menuStyle = 'nui'         -- which style of shift menu to use
Config.MaxSlotsPerLocation = 3   -- how many players can work from one office at once

Verification

Startup Check

Start your server and watch the console. On a healthy startup you will see a resourceInitialized log line from oxide-landscapingjob (if you use oxide-logger with file or Discord logging, it appears there instead of the console).

If a required resource (o-link, ox_lib, or oxmysql) is missing or started in the wrong order, you will instead see a clear red error from oxide-landscapingjob telling you which one — fix that and restart.

In-Game Check

Mowing Check

If all of that works, the resource is installed correctly.

Optional Setup

Phone Shift Messages

When Config.usePhone = true, the landscaping office sends players phone messages during their shift:

• a welcome when they clock in
• a note when they join a crew or a partner joins theirs
• a reminder to head back once all yards are done
• a warning if the van is destroyed or the mower breaks down
• a message if they die on shift, and another when they respawn and are clocked out
• the pay summary when they clock out

These messages are delivered through o-link, which supports these phone resources: Oxide Phone (oxide-phone), qb-phone, lb-phone, gksphone, okokPhone, qs-smartphone, qs-smartphone-pro, and yseries. How a message arrives depends on the phone:

Mail is also the backup whenever a text can't be sent.

If your server doesn't run a supported phone, the messages simply won't arrive — turn off Use phone under General in /landscaping settings (Config.usePhone) so players aren't left waiting on messages. Important moments (pay received, van destroyed, etc.) always also show as regular on-screen notifications, with or without a phone.

Gigs App on Oxide Phone

If your server runs Oxide Phone, its Gigs app shows this job: the offices and whether each one has room, the player's current shift (the yard they're mowing, how many yards are done, their crew role, and their pay so far), and their level.

While a player carries an Oxide Phone and the Gigs app is turned on (it is by default), the shift messages above show up there as Gigs notifications instead of texts. The pay summary is the exception: it never goes to the Gigs app and always arrives as a text or mail. There's nothing to set up — just run Oxide Phone and this job.

End-of-Shift Pay Summary

When a player clocks out, they always get an on-screen notification with their net pay. With Config.usePhone = true, the full breakdown is also sent to their phone as a text or mail (see Phone Shift Messages): yards completed, the pay for each yard, any co-op bonus, gross pay, each deduction, and net pay.

Config.shiftSummary currently has no effect in this job — the summary works the same whichever value it has.

Menu Mode

Config.menuStyle controls what the shift menu looks like:

• 'nui': the full custom menu with a camera view of the office (default)
• 'menu': a simple text menu — use this if you prefer something lightweight

Uniforms

Work uniforms are off by default (Config.uniformsEnabled). To turn them on, open /landscaping settings, switch on Uniforms under Uniforms, and save. No restart is needed.

When enabled, players get a button in the shift menu to put on a landscaping uniform while clocked in. Their own clothes are restored when they take it off or clock out. The outfit pieces are in the same group (Male outfit and Female outfit, Advanced view) if you want to change the look.

Admin Permission for the Settings Editor and Yard Builder

The /landscaping settings editor and the yard builder commands (for creating your own offices and yards) require admin permission. Add this line to your server.cfg:

add_ace group.admin admin allow

This gives everyone in your admin group access to the settings editor and builder commands. Standard QBCore/Qbox/ESX admins pass the check automatically. See the Admin Commands Reference for the full command list.

Next Steps