Installation Guide

Prerequisites

Required Resources

Resource	Purpose
oxmysql	Async MySQL database driver
ox_lib	Utility library, callbacks, UI components, timers
community_bridge	Framework abstraction (available from the Oxide Studios Discord)

community_bridge handles all framework abstraction, including target interactions, vehicle keys, phone, and notifications. It supports QBCore, QBx (Qbox), ESX, and standalone servers.

Supported Systems

System	Supported Via
Framework	community_bridge (ESX, QBCore, QBx, Standalone)
Target	community_bridge target bridge (ox_target, qb-target, etc.)
Vehicle Keys	community_bridge vehicle key bridge
Phone	community_bridge phone bridge (optional)
Notifications	community_bridge notification bridge
Progress Bar	ox_lib progress bar

Supported Frameworks

Framework	Support
QBCore	Full
QBx (Qbox)	Full
ESX	Full
Standalone	Via community_bridge
Custom	Via community_bridge

---

Installation Steps

1. Download and Place Resource

Place the oxide-roadsideassistancejob folder in your server's resources directory:

resources/
└── [oxide]/
    └── oxide-roadsideassistancejob/

2. Add to Server Config

Add the following to your server.cfg, ensuring dependencies start first:

ensure ox_lib
ensure oxmysql
ensure community_bridge
ensure oxide-roadsideassistancejob

3. Database Setup

Execute the SQL file located at sql/install.sql against your database. This creates the progression tracking table.

Table Created:

Column	Type	Default	Description
char_id	VARCHAR(60)	—	Character identifier (primary key)
level	TINYINT	1	Current progression level (1–5)
total_jobs	INT	0	Lifetime completed jobs
daily_streak	INT	0	Consecutive days with completed jobs
last_job_date	DATE	NULL	Date of most recent job
complaints	TINYINT UNSIGNED	0	Current complaint count
timeout_until	DATETIME	NULL	Suspension expiry timestamp

CREATE TABLE IF NOT EXISTS `roadsideassistancejob_progression` (
    `char_id` VARCHAR(60) NOT NULL,
    `level` TINYINT NOT NULL DEFAULT 1,
    `total_jobs` INT NOT NULL DEFAULT 0,
    `daily_streak` INT NOT NULL DEFAULT 0,
    `last_job_date` DATE NULL,
    `complaints` TINYINT UNSIGNED NOT NULL DEFAULT 0,
    `timeout_until` DATETIME NULL,
    PRIMARY KEY (`char_id`)
);

4. Configure

Review and adjust configuration files in shared/config.lua and shared/config/*.lua to match your server's needs. See Configuration for all available settings.

---

Verification

After installation, verify the following:

• Resource starts without errors in server console
• Database table is created
• Tow Yard blip appears on the map
• Dispatcher NPC is present at the tow yard
• Third-eye interaction opens the shift menu
• Clocking in spawns a tow truck and starts the dispatch loop
• A dispatch call arrives and can be accepted

---

Optional Setup

Phone Integration

If your server uses a phone resource supported by community_bridge, players automatically receive email notifications for shift events, dispatch calls, and crew invites. No additional configuration is needed beyond having community_bridge phone support enabled.

ACE Permissions

The /roadsidebuilder admin tool requires ACE permissions:

add_ace group.admin admin.roadsidejob allow

This grants access to the roadside builder menu for creating and exporting tow yard locations and job events. See Admin Tools for details.

---

Troubleshooting

If you encounter issues during installation, see Troubleshooting.