Installation

RoadVR is a spatial AR interface for FiveM: world-anchored windows the player can place in the room, carry along and interact with. It runs on ESX, QBCore, Qbox and standalone.

Do not use FileZilla. It can corrupt or skip hidden files during upload. We recommend WinSCP.

There is no transaction ID to enter. Unlike our other scripts, RoadVR has no API.lua key step — in RoadVR, API.lua is the exports file for other developers. The database sets itself up on first start. If you came here looking for the license step, there isn’t one.

📋 Prerequisites

OneSync

Required. RoadVR declares /onesync as a dependency and will not start without it.

ox_lib

Required. Must be started before RoadVR.

oxmysql

Required. Every persistence path depends on it.

FTP Client

WinSCP or similar (not FileZilla)

Inventory

Optional — only if you want the headset and the drone to be real items

RoadPhone

Optional, version 2.6.0 or newer. Adds messages, music, shared notes, the photo gallery and phone notifications. Older versions are treated as no RoadPhone at all.

🚀 Setup Instructions

Extract both resources

The download contains two resources. Put both into your resources folder — we recommend a [road] folder alongside our other scripts:

resources/
└── [road]/
    ├── roadvr/
    ├── roadvr_models/
    └── other_scripts/

roadvr_models streams the headset itself: the wearable visor for the freemode bodies and the rs_visionpro prop that is carried between hands and head. Without it the headset falls back to whatever glasses a ped already has.

Two items, both with configurable names:

Item	Config	What it does
`roadvr_headset`	`Config.Item`	Usable. Puts the headset on and takes it off.
`roadvr_drone`	`Config.Drone.item`	Not usable. The Drone app only opens while the player carries one.

ox_inventory
ESX / QBCore / Qbox
No items at all

data/items.lua

['roadvr_headset'] = {
    label = 'VR Headset',
    weight = 400,
    stack = false,
    close = true,
    description = 'Put it on and the room fills with windows.',
},

['roadvr_drone'] = {
    label = 'Camera Drone',
    weight = 1500,
    stack = false,
    close = true,
},

Add roadvr_headset and roadvr_drone to your items table the same way you add any other item. RoadVR registers the headset as usable itself — you only have to make the items exist.Detected automatically: ox_inventory, one_inventory, jaksam_inventory, tgiann-inventory, qb-inventory, codem-inventory and core_inventory. Anything else uses the framework’s own inventory.

Leave both names empty:

config.lua

Config.Item = ''

Config.Drone = {
    item = '',
    -- the rest of the block stays as it is
}

Everybody can then use the headset and fly the drone without carrying anything. The way in is /roadvr_toggle or the FiveM keybind of the same name, which the player assigns themselves.Standalone servers have no usable items, so this is the setting to use there.

Configure

Everything lives in config.lua. For a first start you rarely need to touch more than the top:

config.lua

Config.Locale          = 'en'               -- 'en', 'de', 'es' or 'it'
Config.Item            = 'roadvr_headset'   -- empty string = no item needed
Config.FocusKey        = 'E'                -- E, G, X, F or H
Config.MaxPanels       = 4
Config.FirstPersonOnly = true
Config.Debug           = false              -- keep this false on a live server

Config.Locale sets the language of the Lua-side notifications and is the interface language for every player who has not picked their own in Settings. English, German, Spanish and Italian are included.

Ship with Config.Debug = false. It enables /roadvr_calib and the in-game tuning commands, which players should not have.

Configuration

Every other block in config.lua, explained

Start the resources

server.cfg

ensure ox_lib
ensure oxmysql
ensure roadvr_models
ensure roadvr

🗄️ About the database

RoadVR creates its tables on first start, and an older installation has missing columns added automatically. You do not have to prepare anything.

Table	Holds
`roadvr_profiles`	Settings, window layout and widgets per character
`roadvr_accounts`, `roadvr_friends`	RoadVR account tags and friend lists
`roadvr_spaces`	Saved Spaces
`roadvr_characters`	Character Studio looks
`roadvr_notes`	Notes, when they are not shared with RoadPhone
`roadvr_beat`, `roadvr_basketball`	Scores
`roadshop_vr_reminders`	Reminders
`roadshop_vr_shooter_loadouts`	Arena classes
`roadshop_data`	Shared with RoadPhone; RoadVR adds a `vrsetup` column

The SQL files ship for two cases only:

your database user has no CREATE permission
you want to read the schema before a script touches your database

sql/roadvr.sql contains every table. If you are updating an existing install without CREATE permission, import the newer files on their own: sql/migrations/2026-09-20-shooter-loadouts.sql and sql/2026-10-12-reminders.sql.

✅ Verification

Run this in your server console:

roadvr diag

It checks the bridge and framework, ox_lib, oxmysql, your inventory, the locale, the valet price, Config.FirstPersonOnly, the roadvr_profiles table, whether every Beat song file is in place, and the optional integrations. Then in game: use the item in first person. The first time a character puts the headset on, a short setup assistant asks for language, look and how new windows should behave, and offers the window tutorial at the end.

🏔️ Environments work out of the box

The Environments app ships with three built-in 3D landscapes — Alpine Lake, Sand Dunes and Lunar Surface. They are generated in the interface, so there is nothing to download or add.

Environments

How landscapes behave and how to switch them off

🔄 Updating

Replace everything except config.lua

Replace every file of roadvr except your config.lua, and roadvr_models with it. Mixing old and new files breaks the messages between game and interface.

Keep your config.lua and merge new blocks

Copy new blocks from the shipped config.lua into yours. Anything you do not add falls back to the shipped default, and the server console names the blocks that are missing:

missing from config.lua: ... defaults apply

Check the environments list

An older config.lua may still carry Config.Environments.list = {} from the panorama days. An empty list switches the Environments app off — replace it with the three built-in landscapes:

config.lua

list = {
    { id = 'alpine', scene = 'alpine' },
    { id = 'dunes', scene = 'dunes' },
    { id = 'moon', scene = 'moon' },
},

Restart

New tables are created on start. Restart roadvr_models and roadvr.

Players see the installed and the newest version under Settings → Updates, and the server console announces a new release. Checks only read public version metadata — nothing is downloaded or installed. See Config.Updates in Configuration.

📚 Next Steps

Controls

Keys, focus mode and how windows are moved

Apps & Widgets

What comes with the headset

Games

Minigolf, Chess, Darts, Arena, Beat and Basketball

FAQ

Any problems or questions?

Home

RoadVR

RoadPhone Pro

RoadPhone

RoadPad

RoadCarRadio

Road Minigolf

RoadPark

RoadPods

RoadBackup

Installation

Installation

📋 Prerequisites

OneSync

ox_lib

oxmysql

FTP Client

Inventory

RoadPhone

🚀 Setup Instructions

Configuration

🗄️ About the database

✅ Verification

🏔️ Environments work out of the box

Environments

🔄 Updating

📚 Next Steps

Controls

Apps & Widgets

Games

FAQ

​Installation

​📋 Prerequisites

OneSync

ox_lib

oxmysql

FTP Client

Inventory

RoadPhone

​🚀 Setup Instructions

Configuration

​🗄️ About the database

​✅ Verification

​🏔️ Environments work out of the box

Environments

​🔄 Updating

​📚 Next Steps

Controls

Apps & Widgets

Games

FAQ

Installation

📋 Prerequisites

🚀 Setup Instructions

🗄️ About the database

✅ Verification

🏔️ Environments work out of the box

🔄 Updating

📚 Next Steps