Installation

How to install Vehicle Keys. Start this after ox_lib, oxmysql, your inventory, and Newb_Bridge.

In-development version. These docs cover the testing build of VehicleKeys. The official release is still documented on the GitBook linked in its README.

Start this after ox_lib, oxmysql, your inventory, and Newb_Bridge. If ox_inventory starts later, the keyring falls back to the old style.

Dependencies

Newb_Bridge, ox_lib, oxmysql, and Server artifact and OneSync. You do not edit the framework for this.

Check the provide 'qbx_vehiclekeys' line before the first start. Details: Requirements.

Add the items and images

Paste from Item setup. The same text ships as [INSTALL]/ox_inventory_items.txt and [INSTALL]/qb-core_items.txt.

Copy every PNG from [INSTALL]/images/ into your inventory images folder.

  • ox_inventory: ox_inventory/web/images/
  • qb-inventory: qb-inventory/html/images/

hotwire_kit is optional until you turn on “require an item to hotwire”. Leave the item in anyway. The script sets the slot count.

Add to server.cfg

Skip the ox_inventory line if you are not using it.

ensure ox_lib
ensure oxmysql
ensure Newb_Bridge
ensure ox_inventory
ensure MrNewbVehicleKeys

First start

Start the server once. SQL tables are created on their own, including MrNewb__Settings. There is no SQL file to import.

Join as an admin and run /vehiclekeyssetup. What to change first: Configuration.

Restart and check

Restart the inventory, then this resource, after you paste items. Give yourself a key, lock a car with L, and open the fob.

Commands: Commands. Locker models: Anticheat models.

Keys players press

Players can rebind these under MrNewbVehicleKeys in FiveM’s settings.

KeyWhat it does
LLock or unlock the closest car you have a key for, about 15 meters. The on-screen fob reaches further
YToggle the engine. Stays off if jg-hud, ps-hud, qb-hud, or qbx_hud already handles the engine
F2Open the key list. On ox_inventory you open the keyring item instead
EHotwire, driver seat only, when you do not have a key
HSearch the car for keys, driver seat only
I / OPut the key in the ignition, or take it back out, when insert mode is on
F11Change the auto-pilot mode while it is running

Walking up to your own car locks and unlocks it. Players can turn that off from the fob or with /newb_proximitylocks.

Common setup mistakes

SymptomCheck
Keyring is the old menuox_inventory started after this resource, or container keyring is off in the setup menu
Two /car commandsAdminCommands is on and qbx_core still registers its own /car and /dv. Turn one of them off
provide conflict on startAnother resource also provides qbx_vehiclekeys
Shop will not sell a renamed itemThe locksmith price entry key has to be the real item name
Seed file edits do nothingThe database copy wins after the first boot. Use /vehiclekeyssetup
Locker props deletedAllow the models on Anticheat models

On this page