Skip to content
New here? 10% off your first order
Jump to a section

Documentation

Everything you need to get OOS Scripts running on your server.

Installation

All OOS Scripts follow the same installation process.

1

Download from the CFX Portal

After purchasing, head to portal.cfx.re → My Assets, find the script and download the latest version.

2

Extract into your resources folder

Unzip the file and place the folder in your server's resources/ directory.

3

Add to server.cfg

Add only the scripts that you use to your server.cfg.

server.cfg
ensure oos-notify
ensure oos-chat
4

Open config.lua and configure

Each script has its own config.lua. Refer to the sections below for all available options.

5

(Optional) Customization

Many OOS scripts feature open-source files that you can modify. These allow you to fully customize the logic or UI to match your server's unique needs.


oos-ride

OOS Ride

Version 1.0.1 OneSync Qbox · QBCore · ESX · Standalone Add-on: OOS Auto Cab Product page

OOS Ride is a rideshare job for FiveM. Players drive for a company, pick up voice-interactive passengers or other players, and build a driver profile with reviews, progression and a premium tier.

Almost everything is configured in the in-game admin panel, /rideadmin, so this documentation only covers what the panel cannot do: installing, keys, permissions, integrations and developer hooks.

How a ride works

A ride is server-authoritative and follows one path:

  1. OnlineThe driver opens the app (F7 or /ride) and goes online. Requests start arriving.
  2. RequestA passenger, or a group (up to 3 in a Ride, up to 5 in an XL), is offered with the fare, the pickup and the route. The driver has a limited time to accept.
  3. PickupThe driver drives to the pickup. A spot is found on the real road network at runtime, so there is nothing to place.
  4. Identity checkThe driver confirms who they are picking up by talking to them.
  5. BoardingLuggage goes in the boot, passengers get in.
  6. TripThe passenger talks, reacts to the driving and can make requests such as the radio or a quieter ride.
  7. Drop-offThe passenger gets out. The fare is paid, the passenger rates the ride and a review is written from what really happened.

Players can also order rides from other players. One account has two profiles, Driver and Rider, and the app switches between them. A player request jumps in front of a generated one. The fare is taken when the driver accepts, not at the kerb.

Requirements

RequirementNotes
FXServer with OneSyncPassengers are created by the server.
oxmysqlStarted before OOS Ride. Tables are created on first start.
Frameworkqbx_core, qb-core or es_extended. Standalone also works, but money is only recorded in a ledger, not paid through a framework account.
xAI API keyPassenger voices and speech to text. Without it passengers have no voice.
One reply keyOpenAI, Anthropic or DeepSeek. Writes what passengers say. Without any, passengers use scripted lines.
Voice resourcepma-voice is recommended. mumble-voip, SaltyChat, TokoVoIP and the built-in voice also work.
PhoneOptional. The bundled phone needs nothing.

Installation

1

Add the resource

Copy the oos-ride folder into your resources directory. Do not rename it.

2

Update your server.cfg

Start OOS Ride after oxmysql, your framework, your voice resource and your phone.

server.cfg
ensure oxmysql
ensure qbx_core            # or qb-core / es_extended
ensure pma-voice
ensure lb-phone            # only when Config.PhoneMode names a phone resource
ensure oos-ride
3

Set your API keys

Keys are server convars. Use set, never setr, because setr sends the value to every client.

server.cfg
set oos_ride_xai_key "xai-..."
set oos_ride_openai_key "sk-..."            # or oos_ride_anthropic_key / oos_ride_deepseek_key

One reply key is enough. With two, you choose a main model and a fallback in /rideadmin. You can also write keys in server/credentials.lua, but convars win when both are set.

4

Give yourself admin access

server.cfg
add_ace group.admin oos.ride.admin allow

See Permissions for framework groups.

5

Check the setup

Start the server, then run this in the server console:

server console
oos_ride selftest

It checks the database, the keys, asks each model for a test reply, speaks a test line and mints a transcription secret. Fix anything it reports before you test a ride.

Keep Config.Debug = false on a live server. It enables /ridedebug and extra console output.

Where settings live

WhatWhereEdit it when
Everything about rides, fares, passengers, AI and the app/rideadminAlways. This is the source of truth after first start.
Framework, phone, notifications, commands, keybinds, voiceconfig.luaYou need to change how OOS Ride connects to your server. Restart the resource afterwards.
Who may apply, go online or order a rideserver/permissions.luaYou want your own rules, such as a licence item.
Discord and Fivemanage loggingserver/logging_config.luaYou want to change what is logged and where.
Passenger text, languagesprompts/ and locales/You want to change wording or add a language.
Pickup pointsNowhereSpots are found at runtime.

The files in config/ are only first-start defaults. They are copied into the database once. Editing them later changes nothing, so use /rideadmin.

The admin panel

Open it with /rideadmin. Every setting has a short description. Settings that do not apply to your setup are hidden. Save changes writes every page you touched in one go, and Reset this page to defaults restores a page.

PageWhat you set there
DashboardThe last 24 hours, whether the add-on and the voice service are reachable.
Brand & appName, colours, artwork and wording. White-labelling needs only this page.
Driver signupAccount rules, application steps and the evaluation ride.
Services & vehiclesRide categories, which vehicles qualify, and the premium Black tier.
Ride typesGroup size, seating and luggage.
Fares & payoutsPricing, driver share, tips, fees and bonuses.
Requests & routingHow often requests come, how far they reach, how distances are measured, how varied spots are.
Player ridesRides ordered by players and what a player rating may count for.
Auto CabOnly visible while the add-on is running. See OOS Auto Cab.
Trip rulesPatience, lateness, and what passengers do when driving or the driver is the problem.
PassengersPersonalities, how they speak, models and voices.
AI & voiceReply models, conversation, cost mode and spending limits.
Ratings & reviewsHow a ride becomes stars, and which reviews drivers read.
Phone & widgetThe phone, the trip widget and its sounds.
DriversEvery driver, with actions below.
RidesEvery ride with route, payment and a full timeline.
SpotsEvery place the finder has used. Ban one, or Add where I stand.
DiagnosticsServer state, the world and the voice service.

Driver actions

  • Approve
  • Reject
  • Suspend
  • Lift suspension
  • Let them retake the evaluation
  • Remove their photo
  • Reset their PIN
  • Force offline
  • Approve or reject Black

Under Categories you can grant a service to one driver regardless of their record.

Services & fares

Default services

Ride

1.0x
Passengers
Up to 3
To unlock
Open

Open to everyone with an eligible car.

XL

1.35x
Passengers
Up to 5
To unlock
25 rides

And a 4.5 average rating.

Black

1.6x
Passengers
Up to 3
To unlock
250 rides

A 4.7 average rating, plus a separate application and evaluation.

How a fare is built

Fare = (base + distance + time + pickup) × category × hourly surge
→ then the minimum and maximum, then rounded

With the defaults, a midday Ride of 5 km and 8 minutes, with the driver starting 1.5 km from the pickup:

Ride · 5 km · 8 min · midday
Base9.00
Distance5 km × 4.221.00
Time8 min × 0.665.28
Pickup(1.5 km − 0.5 km free) × 1.81.80
TotalRounded to whole units37

The driver keeps 80 percent by default. The same trip in an XL is 37.08 × 1.35, so 50. Fares are quoted upfront from the game's own GPS route and do not rise if the driver takes a longer way.

The default amounts suit a server where a ride pays about 40. On a poorer or richer economy, scale base, per kilometre, per minute, the minimum fare, fees and bonuses together.

AI passengers and voice

A passenger needs words and a voice.

PieceProviderKey
Transcribing the driverxAIoos_ride_xai_key
Speaking the passengerxAIoos_ride_xai_key
What the passenger saysOpenAI gpt-6-luna (recommended), Anthropic claude-haiku-5-5 or DeepSeek deepseek-flashoos_ride_openai_key, oos_ride_anthropic_key or oos_ride_deepseek_key

Models are fixed. Choose the main model and the fallback model in /rideadmin, on AI & voice. The API key never reaches a player. The driver app gets a short-lived secret for the transcription socket instead.

If you pick the Anthropic model, also set a fallback. It sometimes declines to write a line, and without a fallback the passenger says nothing that turn.

What it costs

A normal ten minute ride lands around two cents at the October 2026 list prices. Choose a cost mode in /rideadmin, AI & voice:

ModeWhat changesPer ride
Balanced defaultOne sentence answers, a fifteen second ceiling on speechAbout 1.9 cents
SaverPassengers start fewer conversationsAbout 1.5 cents
MinimalNo small talk, only what matters is spokenAbout 0.8 cents
CustomAll five settings are yoursVaries

A cost mode never changes what happens in a ride. Passengers still react to crashes and still rate the same way. Spending limits per ride, player and day are a hard stop: the passenger falls back to authored lines instead of breaking the ride.

How drivers talk

Drivers use your normal voice chat. There is no OOS Ride talk key. The driver's microphone is streamed to the passenger only while they transmit in proximity voice. Radio and phone calls are never sent (Config.VoiceExcludeRadio, Config.VoiceExcludeCalls).

Passengers are heard by everyone nearby, from where the passenger is, using the same falloff your voice settings give a real player. No change to pma-voice or mumble-voip is needed or supported.

FiveM asks each player once for microphone permission. The browser layer uses the Windows default microphone. If it is denied, the trip screen says so, and the passenger still talks and still rates the ride.

To bridge another voice resource, add an entry in bridge/voice.lua with detect, isTalking and isElsewhere, then set Config.Voice = 'custom'.

Phones

Set Config.PhoneMode in config.lua.

PhoneConfig.PhoneModeResource
Bundled phonestandaloneNone. Opens with F7 or /ride.
LB Phonelbphonelb-phone
SD Phonesdphonesd-phone
GKSPhone v2gksphonegksphone
YSeriesyseriesyseries
okokPhoneokokphoneokokPhone

Start the phone before oos-ride. The app appears as a custom app named oos_ride, with nothing to edit in the phone. If the phone runs under another folder name, put it in Config.PhoneResource.

Permissions

/rideadmin opens for a player who has the ACE, or who is in one of the framework groups, or both when requireBoth is on.

config.lua
Config.AdminPermissions = {
    acePermission   = 'oos.ride.admin',
    frameworkGroups = { 'admin', 'superadmin', 'god' },
    requireBoth     = false
}

To restrict who can apply, go online or order a ride, edit server/permissions.lua. Each function returns true, or false and a reason code.

server/permissions.lua
function Permissions.CanApply(source)
    -- Example: require a driver licence item
    if not HasLicence(source) then return false, 'need_licence' end
    return true, nil
end

Add a sentence for every code you return, in locales/en/main.lua as T.reason_need_licence = 'You need a driving licence.', and in the other language folders you use. CanGoOnline and CanRide work the same way. Ordering a ride is separate from applying on purpose, so gating the job does not gate the service.

Framework, notifications and prompts

All of these are chosen in config.lua. Leave them on auto unless you have a reason.

SettingOptions
Config.Frameworkauto ESX QBCore Qbox standalone custom
Config.Notificationsauto oos-ride oos-notify ox_lib wasabi_notify okoknotify ps-ui qbx_core qbcore esx custom
Config.DrawTextauto oos-ride oos-textui ox_lib okoktextui ps-ui qb-core custom
Config.Voiceauto pma-voice mumble-voip saltychat tokovoip builtin custom

oos-ride is the built-in notification and prompt, drawn in the app's style and following each player's light or dark choice. auto uses the first supported resource it finds running, otherwise the built-in one. To support another framework, fill in the branches marked [CUSTOM] in bridge/framework.lua.

Languages

Set Config.Locale in config.lua. This switches the app, the admin panel, notifications, scripted lines, reviews and the language passengers speak and are transcribed in.

Shipped:

  • ar
  • cs
  • da
  • de
  • en
  • es
  • fr
  • hu
  • it
  • ja
  • lt
  • nl
  • pl
  • pt
  • pt_pt
  • ro
  • sv
  • th
  • tr
  • zh

Adding a language

  1. Copy locales/en to locales/<code>.
  2. Change 'en' to the new code in the first lines of each file.
  3. Translate, keeping every {placeholder}.
  4. Set Config.Locale.

Write the lists in phrases.lua as words people really say, because they are matched as whole words.

Logging

Every ride, payout, review, sign-up, staff change, security flag and Auto Cab booking can go to Discord, Fivemanage or both. It is off until you give it a destination.

server.cfg
set oos_ride_log_webhook "https://discord.com/api/webhooks/..."
set oos_ride_log_webhook_suspicious "https://discord.com/api/webhooks/..."   # optional, one category
set oos_ride_log_fivemanage_key "..."                                         # optional

Restart the resource and run oos_ride logtest in the console. It sends one sample of every message and pings nobody.

Everything else is in server/logging_config.lua:

OptionWhat it does
EventsEach of about 55 events is true, false, or a table that changes title, colour, fields, channel or role ping.
Categoriesrides autocab conduct payouts reviews drivers onboarding admin suspicious system. Each can be switched off, get its own webhook or ping a role.
minLevel'warn' sends only problems.
Hooksfilter, embed and sink functions, for example to forward every message to your own logger.

Text typed by a player is escaped, so it cannot format a message or ping anyone.

Commands and keybinds

CommandDescriptionPermission
/rideOpen the appEveryone
/ridehelpShort in-game helpEveryone
/rideadminAdmin panelAdmin
/ridedebug <name>Debug toolsAdmin, and Config.Debug = true
oos_ride selftestCheck keys, models and databaseServer console
oos_ride reloadReload settings from the databaseServer console
oos_ride aiCost mode, last rides' real cost, active conversationsServer console
oos_ride logtest [category or event]Send sample log messagesServer console

Command names are set in Config.AdminCommand, Config.PhoneCommand, Config.HelpCommand and Config.DebugCommand.

/ridedebug subcommands

/ridedebug on its own lists everything. The ones you will use most:

SubcommandUse it when
traceA passenger stopped answering. Prints the app, client and server side of every turn for ten minutes.
sttSpeech to text does not work. Opens the transcription socket from your game.
spotsPassengers stand in odd places. Reports how well the spot finder does around you.
pedsChecks every passenger model against the game and names the ones it lacks.
voiceYou want to hear where a passenger's voice comes from.
luggage, luggage tuneChecks luggage props, or tunes where a prop sits in the hand.
animPlays every passenger animation on you.
perf [seconds]The resource reads high in resmon. Prints the cost loop by loop.

Keybinds

Keybinds use RegisterKeyMapping, so players can rebind them in Settings → Key Bindings → FiveM. Set defaults in Config.Keybinds. Leave a value empty for no default key.

ActionDefault
Open the appF7
Accept offer, decline offer, toggle trip widgetUnbound
Auto Cab start, pull over, emergency stopUnbound
Auto Cab accept a guest invitationY

Developer reference

Server exports

All exports are server side and are called like this:

Lua — server side
local online = exports['oos-ride']:IsDriverOnline(source)

IsDriverOnline

Lua — server only
local online = exports['oos-ride']:IsDriverOnline(source)
ReturnsTypeDescription
onlinebooleantrue when the driver has a session that is not offline.

GetDriverProfile

Lua — server only
local profile = exports['oos-ride']:GetDriverProfile(source)
ReturnsTypeDescription
profiletablehasAccount, hasDriver, hasRider, mode, account, character, and driver / rider when they exist. driver holds id, name, status, blackStatus, stats, tier, vehicles, activeVehicle, categories and online.

GetDriverStats

Lua — server only
local stats = exports['oos-ride']:GetDriverStats(source)
ReturnsTypeDescription
statstable or nilRaw counters: rides_completed, five_star_rides, rating_sum, rating_count, earnings_total, tips_total, online_seconds, streak, best_streak, offers_accepted, offers_declined, and more. nil when the player has no driver profile.

GetActiveTrip

Lua — server only
local trip = exports['oos-ride']:GetActiveTrip(source)
ReturnsTypeDescription
triptable or nilid, category, bookings, stops and nextStop for the driver's current trip. nil when there is none.

ForceOffline

Lua — server only
exports['oos-ride']:ForceOffline(source)

Takes the driver offline. Use it when another job takes over. Returns true.

GetSetting

Lua — server only
local fare = exports['oos-ride']:GetSetting('pricing', 'base')
local pricing = exports['oos-ride']:GetSetting('pricing')
ParameterTypeDescription
sectionstringA settings section such as pricing, dispatch, ai or autocab.
keystring, optionalOne value. Leave it out to get the whole section.

IsRideAdmin

Lua — server only
local isAdmin = exports['oos-ride']:IsRideAdmin(source)

Returns true when the player passes the admin check from Permissions.

Events

EventSideWhenPayload
oos-ride:autocab:revenueServer, localOnce per settled Auto Cab ride, when Fares go to is set to an event{ bookingId, amount, currency, riderId }
your_resource/server.lua
AddEventHandler('oos-ride:autocab:revenue', function(data)
    -- data.amount is in whole currency units
end)

Hooks you can edit

HookFilePurpose
Permissions.IsAdmin, CanApply, CanGoOnline, CanRideserver/permissions.luaYour own access rules.
filter, embed, sinkserver/logging_config.luaReact to or reshape every log message. This is the closest thing to a ride event stream.
[CUSTOM] branchesbridge/*.luaSupport another framework, notification system, text UI or voice resource.

OOS Auto Cab uses a few exports of its own to talk to OOS Ride (PlayerDown, ResolveStop, ViewerTheme). They are internal and not part of the public API.

Updating

  1. Stop the resource or the server.
  2. Delete the old oos-ride folder and put the complete new folder in its place.
  3. Reapply your edits to config.lua, server/permissions.lua, server/logging_config.lua, server/credentials.lua and anything else you changed.
  4. Run refresh, then ensure oos-ride.

Do not copy new files over the old folder. Mixed old and new files cause errors that are hard to trace. Your settings are stored in the database, so they survive a replacement.

FiveM only re-reads a resource's file list on refresh. A plain restart after an update that added a file keeps the old list.

Troubleshooting

/rideadmin does nothing or says you have no permission

CauseThe ACE or framework group is missing.

FixAdd add_ace group.admin oos.ride.admin allow and make sure your player is in that group, or add your framework group to Config.AdminPermissions.frameworkGroups.

Passengers have no voice, or say nothing

CauseA key is missing, empty or out of credit.

FixRun oos_ride selftest and read the AI lines. With no xAI key there is no voice. With no reply key passengers use scripted lines. If one key stops working, set a fallback model.

The passenger does not hear the driver

CauseThe driver is not transmitting in proximity voice, is on the radio or a call, or the microphone is blocked.

FixCheck the driver is speaking with their normal push to talk or voice activation. Check FiveM's microphone permission and the Windows default device. Run /ridedebug stt with Config.Debug = true.

The passenger stopped answering mid ride

FixWith Config.Debug = true, run /ridedebug trace and repeat the turn. The list names where the turn went missing, such as rate limited, empty transcript or model failed.

The app is missing from my phone

CauseThe phone started after OOS Ride, or Config.PhoneMode does not match.

FixStart the phone first, set Config.PhoneMode to its value from the Phones table, and restart oos-ride.

SQL errors on start

Causeoxmysql is not started, or you use mysql-async.

Fixensure oxmysql before oos-ride. For mysql-async, change the line marked in fxmanifest.lua.

Drivers are not paid

CauseNo framework was detected, so the server is running standalone.

FixRead the ready | framework: ... line in the console at start-up, and set Config.Framework if it guessed wrong. Your framework must start before oos-ride. Standalone records a ledger but does not move money.

NOT LOADED or a missing file after an update

FixRun refresh, then ensure oos-ride. See Updating.

Passengers stand somewhere odd on a new server

CauseThe spot finder has nothing cached yet and gets better as drivers work.

FixGive it a session. Use /ridedebug spots to see how it does, and ban a bad corner on the Spots page.

The Auto Cab page is missing

CauseThe add-on is not running or is a version OOS Ride cannot talk to.

FixRead the add-on status on the Dashboard. See OOS Auto Cab installation.

Known limitations

  • Spots are named after their street and district. GTA V gives scripts no way to know what a building is, so a passenger's reason for travelling fits a district, not a venue.
  • The first rides on a fresh server appear a little slower while the spot finder fills its cache.
  • Luggage needs a vehicle with a boot. A car without one carries small items on the passenger's lap.
  • Accents cannot be generated. A background shows in a passenger's words, not in the sound of the voice.
  • Leg two of a quote uses learned routes and a pathfind estimate. The GPS multi-route option is experimental and not recommended.

Need help with OOS Ride?

When you report a problem, include the resource version, your framework, Config.PhoneMode, and the output of oos_ride selftest.


oos-autocab

OOS Auto Cab

Version 1.0.1 · API 1 Add-on for OOS Ride OneSync Product page

OOS Auto Cab adds driverless robotaxis to OOS Ride. A rider books a cab from the rider side of the OOS Ride app, watches it drive to a safe stop, gets in, and is driven to the destination with nobody at the wheel.

Almost everything is set in OOS Ride's /rideadmin, on the Auto Cab page. This documentation covers installing, compatibility with other scripts, the few load-time options in config.lua, and developer reference.

Auto Cab is an add-on. It needs OOS Ride, and OOS Ride runs exactly as before without it.

How it works

  1. BookThe rider picks a destination and sees the price and arrival time before booking. The fare is charged at booking.
  2. Cab on its wayThe cab is on the rider's map and minimap from the first second, moving along a real road route. A few hundred metres out it becomes a real car, somewhere nobody is looking.
  3. PickupThe cab pulls over at a safe kerb. The door on the rider's side opens as they walk up.
  4. StartThe rider presses E (or their own key) while seated, or uses the app. The ride also starts by itself when boarding time runs out.
  5. RideThe cab drives to the destination. A screen in the cab shows a welcome, the live map and which side to get out on.
  6. Drop-offThe cab pulls over, the door opens, the rider gets out and rates the service.

Rider controls

A rider controls the ride from the app. Each button can be switched off in /rideadmin.

  • Find my cab
  • Start ride
  • Pull over safely
  • Resume
  • End ride here
  • Emergency stop (press and hold)
  • Change destination
  • Report a problem
  • Invite a guest

Change destination shows the price difference first. Pressing the exit key while the cab drives asks it to pull over, and the door opens at the kerb. Pressing it twice within a second while moving is the game's own exit, so nobody is ever kept inside.

The cabin has two passenger seats. The second one is for a guest the rider invites and who accepts. There is no driver's seat to take: an invisible AI controller drives from a hidden seat, and a player who reaches that seat only stops the car.

Requirements

RequirementNotes
OOS RideA version with Auto Cab support. It finds the add-on by itself.
FXServer with OneSyncThe cab and its controller are created by the server. The add-on will not start without it.
The autocab vehicleStreamed by this resource. Nothing else to install.

Installation

1

Add the resource

Copy the oos-autocab folder into your resources directory. Do not rename it, because OOS Ride looks for a resource called oos-autocab. If you must rename it, set Config.AutoCab.resource in OOS Ride's config.lua to the new name.

2

Update your server.cfg

server.cfg
ensure oos-ride
ensure oos-autocab

The order is not important and there is no dependency line between them, so restarting one never restarts the other. OOS Ride checks for the add-on whenever either resource starts or stops, and whenever the Auto Cab settings are saved.

3

Check the status

Open /rideadmin. The dashboard shows what OOS Ride found:

StatusMeaning
availableWorking. The Auto Cab page and the rider service appear.
absentThe add-on is not started.
incompatibleA version OOS Ride cannot talk to. The console says which.
disabledSwitched off with Config.AutoCab.resource = '' in OOS Ride's config.lua.

The Auto Cab page and the service in the app only exist while the status is available.

Keep Config.Debug = false on a live server. The release package ships it that way.

Setting up the service

Open /rideadmin, then Auto Cab. The page covers the service and its pricing, and shows a live view of the fleet.

You setExamples
The serviceName, short description, icon, accent colour, vehicle name, whether to offer it only when no human driver is nearby.
LookPaint (one colour, the model's six factory colours, or your own palette), plain or lettered livery, clean at pickup or always clean.
PlatesFormat (# digit, @ letter, ? either, other characters as typed, up to 8), numbering in order or random, the plate designs to draw from.
Area and hoursAllowed zones, blocked zones, opening hours, how far a cab is sent from, the shortest and longest wait.
FleetCabs on the road at once, where a cab becomes real, whether a cab driving off may take the next booking.
BoardingTime at the kerb, one extension, start when everyone is in, guest rules.
DoorsWhether doors open by themselves, and from how far.
DrivingLawful, assertive or swift, and avoiding highways.
Rider controlsWhich buttons riders get.
StopsHow close counts as arrived, and how far a replacement drop-off may be from the destination.
PolicyWhat a service failure costs, wanted players, drive-bys.
Cabin screenOn or off, colours, whether to show the traffic around the car.
RevenueWhere the fares go.
PricingFare, fees and cancellation rules.

Driving styles

All three styles use the game's own driver and its pull-over, the way Rockstar's taxis do.

Lawful

Default
In town
60 km/h
Big roads
80 km/h
Highway
120 km/h

Follows every rule, stops at every red light.

Assertive

In town
66 km/h
Big roads
90 km/h
Highway
132 km/h

A little quicker. Carries on through an amber light it could only stop for by braking hard.

Swift

In town
About 96 km/h
Big roads
112 km/h
Highway
150 km/h

Rockstar's hurry style. Swerves round slower traffic and does not stop at red lights.

Every style slows near a stop and always stops for a car or person in its way. The speeds are in this resource's config.lua (Config.SpeedLimitsKmh and Config.Profiles), not in /rideadmin.

Where cabs appear

Nobody should see a cab appear or vanish. A cab becomes a real car 160 to 280 m from its rider, at a spot that every player who could receive it says they cannot see. After a ride it drives away from the players around it and is removed only once the same check says nobody can see it go.

You do not set this up. Two things are worth knowing: a crowded area can delay a cab (see Known limitations), and a cab that is driving off may take the next booking nearby instead of a new car appearing (Chain bookings).

Money

Fares are quoted before booking and charged once, in whole currency units. Every charge and refund is idempotent. A refund owed to someone who left the server is kept and paid when the same character returns.

Fare

With the defaults, a 6 km ride at the quoted pace of 40 km/h (about 9 minutes) for one rider:

Auto Cab · 6 km · about 9 min · 1 rider
Base12.00
Distance6 km × 4.828.80
Time9 min × 0.65.40
SubtotalRounded to whole units46
Booking fee3
Total49

A second seat adds 6. The result is never below the minimum fare (24) or above the maximum (400). The route that is priced is the route the cab drives.

How a ride can end

EndingWhat the rider pays
Completed at the drop-offThe full fare.
Cancelled before the cab is on the street, or within the free window (60 s)Nothing.
Cancelled laterThe cancellation fee (15).
Cab runs badly late, or has not come closer for 45 secondsNothing. Cancelling is free.
No-show at the kerbThe no-show fee (18), never more than the minimum fare.
End ride hereThe distance covered, never below the minimum fare.
The service fails before boardingNothing.
The service fails after boardingThe distance covered, or nothing when When the service fails a rider is set to a full refund.
The rider goes down before the cab has left with themNothing.

A detour, a missed turn or a recovery manoeuvre never makes an early exit cost more.

Where the fares go

Set Fares go to on the Auto Cab page:

OptionResult
Nowhere defaultThe money leaves the economy.
A society accountPaid into a job or society account through qb-banking, qb-management, Renewed-Banking or esx_addonaccount. Detected automatically or chosen.
An event of your ownOOS Ride fires oos-ride:autocab:revenue once per settled ride. See Events.

A payment whose outcome is unknown after a restart is flagged for an admin and never paid twice.

Configuration files

OOS Ride's config.lua

These options sit in OOS Ride, under Config.AutoCab:

SettingDefaultWhat it does
resource'oos-autocab'The add-on's resource name. '' switches the integration off.
bookingsPerWindow3Rides one rider may book in the window. Stops a book and cancel loop from tying up the fleet.
bookingWindowSeconds600The length of that window.
routeSampleMode'none'How the route is read from the game's GPS. none reads nothing and prices on the pathfinding distance, so the quote says it is an estimate. blip reads the ordinary GPS route and needs the rider within 60 m of the pickup. Leave it on none unless you have tested blip.
cabBlipsprite 198, colour 2The rider's cab on the minimap until they get in.
mapRevealSeconds5Seconds after the cab appears before it shows on the rider's map.
startControl38The control that starts a ride from the back seat. 38 is E.

Keybinds are in Config.Keybinds: autocabStart, autocabPullOver and autocabEmergency are unbound by default (the emergency stop must be held for a second and a half), and autocabAcceptInvite is Y.

This resource's config.lua

Change a value, then restart the resource. The file and locales/ stay editable on an escrowed build.

SettingWhat it does
Config.HostThe OOS Ride resource name. Every export refuses any other caller.
Config.LocaleLanguage of the add-on's own words: locales/<code>.lua. English and Dutch ship.
Config.ModelThe vehicle this resource streams. It must match the stream/ file names.
Config.ControllerModelPed model of the invisible controller. Any base-game model works.
Config.Debug, Config.DebugAceEnables the /acspike commands for admins with the ACE. Keep it false on a live server.
Config.VersionCheckA plain GET to oos-scripts.com at start-up. false switches it off.
Config.Profiles, Config.SpeedLimitsKmhThe three driving styles and the base speed of each road class.
Config.Seatbelttrue: riders are never thrown through the windscreen. false: leave it to your seatbelt script.
Config.SignalsTurn signals at junctions and kerbs. Set enabled = false if the game already signals by itself.
Config.DoorsHow close a rider must be for the door to open, how fast it moves, and the door sounds.
Config.ScreenThe cabin screen surface, distances and crowd rule.
Config.FleetAdvanced. Includes departingMax (16) and downedMaxSeconds (900).
Config.VisibilityWho is asked before a cab appears or leaves. Raise cullMeters (424) only if your server raised OneSync's culling radius.
Config.Paint, Config.Look, Config.PlatesLooks used until OOS Ride sends its own. They only matter without OOS Ride.

Leave Config.Taxi, Config.Safety, Config.Recovery, Config.Ownership and Config.Deviation alone unless support asks you to change them. They hold driving numbers that interact, and each value has a comment.

Set Config.Fleet.downedMaxSeconds to your medical script's longest bleed-out time or more. A cab whose ride has ended stands with the door open for someone who is down in a seat, and treats them as anyone who will not get out only after that time.

Other scripts on your server

The cab is an unusual vehicle. These are the scripts that notice, each with at most one line of setup.

Script typeWhat happensWhat to do
Vehicle keysSome scripts lock any car with an AI driver and would lock riders out.The cab carries the ignoreLocks state bag, which qbx_vehiclekeys and recent qb-vehiclekeys honour. If yours does not, add autocab to its list of vehicles it must never lock (in qb-vehiclekeys: Config.NoLockVehicles and Config.ImmuneVehicles).
Vehicle cleanupA cab deleted before anyone got in is quietly replaced. During a ride it ends as a service failure.Exclude the autocab model from any script that deletes vehicles.
AnticheatIt sees an invisible, invincible AI ped in every cab's driver seat.Whitelist the s_m_m_gentransport model while it sits in an autocab, or any entity with the oosAutoCabCtrl state bag.
sv_entityLockdownThe server creates the cab, so strict lockdown is fine.Nothing.
sv_filterRequestControlWhen a car must be handed to a rider's client, the add-on exempts its own two entities for three seconds.Leave it as it is.
FuelFuel scripts drain player cars. A cab's controller keeps the tank full.Nothing.
SeatbeltThe add-on stops riders being thrown through the windscreen and restores their own setting on exit.If it fights your script, set Config.Seatbelt = false.
Exit keyIn a cab the exit key belongs to the add-on.A script that also acts on the exit key sees the same press.
Another resource streaming autocabEvery client checks that the model has three seats.If another layout overrides it, the service switches itself off on that client and says why.

Commands

The /acspike diagnostics exist only while Config.Debug = true and only for players with the ACE:

server.cfg
add_ace group.admin oosautocab.debug allow

Type /acspike alone for the full list. All of these need the debug ACE.

CommandDescription
/acspike screenScreen state, test pattern, which texture is replaced
/acspike doorsWatch or test the doors
/acspike taxiWhat the driving client is doing and the point it aims for
/acspike safetyImpacts and contacts of the cab
/acspike park
/acspike kerb
The game's pull-over at your waypoint, and the kerb gap of the cab you sit in
/acspike departThe last departure, phase by phase
/acspike materializeRun the visibility vote around you and place a test cab
/acspike camThe camera direction the server reads for you
/acspike perf [seconds]Cost of this resource on your client and the server

OOS Ride has a related check: /ridedebug autocab route (admin, Config.Debug) tries every way of reading the cab's route from the GPS where you stand.

Developer reference

Auto Cab has no public API for other scripts. Its exports answer only OOS Ride, and everything else is an event or a state bag you can read.

Exports

Server side, callable only from the resource named in Config.Host. Any other caller gets nil. None of them ever yields. Positions are plain { x, y, z } tables.

ExportPurpose
Handshake()Version, API number, model, seats, vehicle size, liveries, paint sets and feature flags.
Configure(cfg)Receives the settings, texts, accent colour and cabin screen config. Called after every handshake and every save.
Availability(q){ ok = true, etaSeconds } or { ok = false, reason }. Reasons: no_cab_available, outside_service_area, service_closed, party_too_large, service_disabled.
Dispatch(order)Reserves a cab for a booking. Idempotent per booking key.
Command(cabId, cmd, args)Start, pull over, resume, end here, emergency stop, change destination, guest, find my cab and the report commands.
Status(cabId)The cab's state, position, speed, riders and doors.
Release(cabId, reason)Lets go of a cab. It leaves in one calm sequence and is removed where nobody can see it.

OOS Ride answers the add-on with one export of its own, PlayerDown(source), so a cab can stand by for a rider who is dead or in last stand.

Events

EventSideFired byPayload
oos-autocab:readyServer, localThis resource, one second after it startsThe API number (1).
oos-autocab:eventServer, localThis resource, to OOS RidecabId, bookingVersion, kind, data. Accepted only from the configured resource.
oos-ride:autocab:revenueServer, localOOS Ride, once per settled ride when Fares go to is an event{ bookingId, amount, currency, riderId }
oos-autocab:exitRequestClient, localThis resource, when the exit key is pressed while the cab drivesnetId
oos-autocab:notifyClient, localThis resourcekey, text. Shown through OOS Ride's notifications.
oos-autocab:viewerChangedClient, localOOS Ride, when the player changes the app's light or dark choiceNone.
your_resource/server.lua
AddEventHandler('oos-ride:autocab:revenue', function(data)
    -- data.amount is in whole currency units
    -- data.riderId is the rider profile id
end)

State bags

BagOnHolds
oosAutoCabThe cab vehicle{ id, ctrl }, the opaque cab id and the controller's net id.
oosAutoCabCtrlThe controller pedThe cab id.
ignoreLocksThe cab vehicleSet so key scripts do not lock riders out.

Nothing private about a rider ever goes into a state bag or a broadcast.

Updating

  1. Stop the resource.
  2. Delete the old oos-autocab folder and put the complete new folder in its place.
  3. Reapply your edits to config.lua and locales/.
  4. Run refresh, then ensure oos-autocab.

FiveM only re-reads a resource's file list on refresh. A plain restart after an update that added a file keeps the old list. The client console then names the missing file (NOT LOADED: ...) instead of failing quietly.

An update that changes data/vehiclelayouts.meta needs a server restart, or every player must reconnect, because the game reads a vehicle's layout when it loads the model.

Troubleshooting

The Auto Cab page or the rider service is missing

CauseThe status is not available.

FixRead the add-on status on the /rideadmin dashboard. Start oos-autocab, update OOS Ride if the status is incompatible, or clear Config.AutoCab.resource = '' if it says disabled.

Riders say no cab is available

CauseThe fleet is full, the hours or zones exclude the pickup, or more than 16 released cabs are still driving away.

FixRaise Cabs on the road at once, check Area and hours, and check the party size against the seats. A cab that is still visible to players is never removed in front of them, so the count falls only as they drive out of sight.

A rider is locked out of their cab

CauseA vehicle key script locks the AI-driven car.

FixSee Other scripts on your server.

The booking ended as a service failure and nothing was charged

CauseIn a crowded area every possible spot was refused because a player could see it, and after three minutes the booking ends.

FixNothing is wrong with the add-on. The cab is never placed in someone's view to save time. Ask the rider to book from a quieter spot.

A cab disappears during a ride, or riders are ended mid trip

CauseA cleanup script deletes the cab, or an anticheat removes the invisible controller.

FixExclude the autocab model from cleanup and whitelist the controller ped. See Other scripts on your server.

The screen shows only the brand

CauseThis is the crowd rule. The game replaces a vehicle texture for every car of that model at once, so a rider's trip is shown only while theirs is the only Auto Cab nearby (none within 15 m, none in view within 60 m).

FixNothing. This stops one rider's trip appearing on another rider's glass.

A door does not open

FixWith Config.Debug = true, run /acspike doors watch to see what the server wants of each door and why. A rider can also use Report a problem, then the door topic, in the app.

The cab parks oddly or too far from the kerb

FixRun /acspike park and /acspike kerb and check the gap. The pull-over is the game's own, and the car measures the kerb itself in the last metres. Where the road data and the visible kerb disagree, it stops where it can, double parked with hazards on.

Riders are thrown or restrained wrongly

FixSet Config.Seatbelt = false if your seatbelt script handles it.

NOT LOADED in the console after an update

FixRun refresh, then ensure oos-autocab. See Updating.

Known limitations

  • Driving runs on a player's machine. FiveM has no server-side driving tasks. The client that owns the car drives it, usually the rider. The server watches every cab and hands it over when the owner is too far away.
  • A cab is a real car only a few hundred metres out. OneSync simulates a car only on a player's machine, so the cab moves along the real route on the map first. This is why the wait is rarely under 45 to 60 seconds.
  • Appearing and leaving unseen can take time in a crowd. In a busy area every spot can be refused for a while. A cab that cannot drive away stays where it is until nobody looks.
  • Plate designs depend on your game build. The first six designs are in every build. eCola, Las Venturas, Liberty City, LS Car Meet, LS Panic, LS Pounders and Sprunk need build 3095 or later (sv_enforceGameBuild). A client without a design shows the standard plate.
  • The cabin screen is shared by every Auto Cab. See The screen shows only the brand.
  • Kerb precision depends on the street.
  • Two seats. The second is for one invited guest. There is no luggage, radio or climate control.
  • Driving numbers are starting points. Speeds, braking distances and kerb gaps come from the design and tests. Each has a comment and a diagnostic to tune it with.

Need help with OOS Auto Cab?

When you report a problem, include the add-on version and the OOS Ride version, the add-on status shown on the /rideadmin dashboard, and anything printed to the server or client console.


oos-notify

OOS Notify

Notification Types

success
error
info
warning
money

Configuration

Open config.lua in the oos-notify folder and adjust to your server.

config.lua — oos-notify
--[[
                                        OOS Notify - Configuration
                                        https://oos-scripts.com/
                                    ]]

                                    Config = {}

                                    -- ============================================================
                                    --  SOUNDS
                                    -- ============================================================

                                    -- Volume for notifications (0.0 - 1.0)
                                    Config.SoundVolume         = 0.5

                                    -- Volume for announcements (0.0 - 1.0)
                                    Config.AnnouncementVolume  = 0.9

                                    -- ============================================================
                                    --  NOTIFICATIONS
                                    -- ============================================================

                                    -- Default display time in ms (5000 = 5 seconds)
                                    Config.DefaultDuration    = 5000

                                    -- Max notifications visible at once
                                    Config.MaxNotifications  = 5

                                    -- Slide animation speed in ms
                                    Config.AnimationDuration = 800

                                    -- ============================================================
                                    --  POSITION
                                    -- ============================================================

                                    -- Options: 'top-right', 'top-left', 'bottom-right', 'bottom-left'
                                    Config.Position = 'top-right'

                                    -- Offset from the vertical edge in pixels
                                    Config.OffsetY = 40

                                    -- Offset from the horizontal edge in pixels
                                    Config.OffsetX = 19

                                    -- ============================================================
                                    --  ANNOUNCEMENTS
                                    -- ============================================================

                                    -- Display time for announcements in ms
                                    Config.AnnouncementDuration       = 10000

                                    -- Enable/disable individual txAdmin event integrations
                                    Config.EnableTxAdminAnnouncements  = true
                                    Config.EnableTxAdminShutdown       = true
                                    Config.EnableTxAdminRestart        = true
                                    Config.EnableTxAdminRestartSkipped = true

                                    -- ============================================================
                                    --  LABELS
                                    --  Title text shown in announcement banners
                                    -- ============================================================

                                    Config.Labels = {
                                        ServerAnnouncement = 'SERVER ANNOUNCEMENT',
                                        ServerOffline      = 'SERVER OFFLINE',
                                        Restart            = 'RESTART',
                                        RestartCancelled   = 'RESTART CANCELLED',
                                        SaveProgress       = 'Save your progress!',
                                        By                 = 'By',
                                    }

                                    -- ============================================================
                                    --  COLORS
                                    --  Accent colors per notification type (valid CSS color values)
                                    -- ============================================================

                                    Config.Colors = {
                                        success = {
                                            from = '#10b981',
                                            to   = '#059669',
                                        },
                                        error = {
                                            from = '#ef4444',
                                            to   = '#dc2626',
                                        },
                                        info = {
                                            from = '#3b82f6',
                                            to   = '#2563eb',
                                        },
                                        warning = {
                                            from = '#fbbf24',
                                            to   = '#f59e0b',
                                        },
                                        money = {
                                            from     = '#ffd700',
                                            mid      = '#ffb700',
                                            to       = '#ff8c00',
                                            glow     = 'rgba(255, 215, 0, 0.5)',
                                            iconGlow = 'rgba(255, 215, 0, 0.6)',
                                        },
                                        announcement = {
                                            from = '#fbbf24',
                                            to   = '#fcd34d',
                                        },
                                    }

                                    -- ============================================================
                                    --  BACKGROUNDS
                                    --  Use rgba() to control transparency (4th value = opacity)
                                    -- ============================================================

                                    -- Background of notification cards
                                    Config.NotificationBackground = 'rgba(35, 35, 40, 0.85)'

                                    -- Background of the announcement banner
                                    Config.AnnouncementBackground = 'rgba(35, 35, 40, 0.85)'

Usage & Exports

Trigger notifications from any resource on your server using exports or client events.

# Displaying a notification

Client side

Lua — client side
exports['oos-notify']:Alert('Title', 'Message', 5000, 'type')

Server side

Lua — server side
TriggerClientEvent('oos-notify:alert', source, 'Title', 'Message', 5000, 'type')

Client Examples

Lua — client side
-- Alert(title, message, duration, type)
                                    exports['oos-notify']:Alert('Success', 'Item purchased!', 5000, 'success')
                                    exports['oos-notify']:Alert('Error', 'Not enough money.', 5000, 'error')
                                    exports['oos-notify']:Alert('Info', 'Server restarts in 10 minutes.', 8000, 'info')
                                    exports['oos-notify']:Alert('Warning', 'You are in a restricted area.', 5000, 'warning')
                                    exports['oos-notify']:Alert('Salary', 'You received $500.', 5000, 'money')

                                    -- Announcement(title, message, duration)
                                    exports['oos-notify']:Announcement('EVENT', 'A new race has started!', 10000)

                                    -- Update the visible announcement
                                    exports['oos-notify']:UpdateAnnouncement('EVENT', 'Race ends in 2 minutes!', 8000)

                                    -- Hide the current announcement
                                    exports['oos-notify']:HideAnnouncement()

Server Examples

Lua — server side
-- Send a notification to a single player (use -1 for all)
                                    TriggerClientEvent('oos-notify:alert', source, 'Info', 'Your shift has started.', 5000, 'info')

                                    -- Broadcast a notification to all players
                                    TriggerClientEvent('oos-notify:alert', -1, 'Event', 'A heist is now active!', 8000, 'warning')

                                    -- Show a server announcement to all players
                                    TriggerClientEvent('oos-notify:announcement', -1, 'ANNOUNCEMENT', 'Welcome to the server!', 10000)

                                    -- Hide the announcement for all players
                                    TriggerClientEvent('oos-notify:hideAnnouncement', -1)

Available Events & Exports

Name Side Parameters
exports['oos-notify']:Alert Client title, message, duration, type
exports['oos-notify']:Announcement Client title, message, duration
exports['oos-notify']:UpdateAnnouncement Client title, message, duration
exports['oos-notify']:HideAnnouncement Client —
oos-notify:alert Client event title, message, duration, type
oos-notify:announcement Client event title, message, duration
oos-notify:updateAnnouncement Client event title, message, duration
oos-notify:hideAnnouncement Client event —

txAdmin Integration

OOS Notify hooks into txAdmin events automatically. It handles restarts, shutdowns and announcements — so you get a consistent UI instead of overlapping native alerts.

To ensure OOS Notify handles these correctly, navigate to your txAdmin panel and go to:

Settings > Game > Notifications Settings

And Disable the following:

  • Hide Announcement Notifications
  • Hide Scheduled Restart Warnings

oos-chat

OOS Chat

Admin Command

In-game chat
/chatmanager

Opens the chat manager admin panel. Requires an ace permission or a qualifying framework group (see config below).

Configuration

Open config.lua in the oos-chat folder and adjust to your server.

config.lua — oos-chat
Config = {}

                                    --[[ FRAMEWORK SETTINGS ]]
                                    -- Options: "auto", "ESX", "QBCore", "Qbox"
                                    Config.Framework = "auto"

                                    --[[ GENERAL SETTINGS ]]
                                    Config.ServerName = 'My Server'
                                    Config.Locale = 'en'
                                    Config.DateFormat = '%H:%M'

                                    --[[ STAFF PERMISSIONS ]]
                                    -- These require a server restart when changed
                                    Config.StaffPermissions = {
                                        acePermission = 'oos.chat.staff',
                                        frameworkGroups = { 'admin', 'superadmin', 'god' },
                                        requireBoth = false
                                    }

Admin Panel

Navigate to the in-game chat manager to fully configure and moderate the real-time chat experience.

1

Open the manager

Type /chatmanager in the chat (requires ace permission oos.chat.staff or an admin group).

2

Live Moderation

Instantly clear the entire chat, clear an individual player's chat history, or monitor active messages effectively from the sleek UI.

3

Custom Commands

Easily create, customize, or delete custom commands natively via the web panel. Define jobs, permissions, colors, and specific functionality—all with dynamic command suggestions automatically showing in chat.

4

Dynamic Settings

Toggle features like Out Of Character (OOC) chat, automatic command suggestions, or visual themes dynamically, without needing to touch a single line of code.

Ace Permissions & Groups: To grant a player access to the chat manager, you can use Ace permissions or framework groups. The script can check for specific groups in ESX, QBCore, etc.

server console / server.cfg
add_ace identifier.steam:110000112345678 oos.chat.staff allow
                                    -- or for a group:
                                    add_ace group.admin oos.chat.staff allow