Documentation

Resource Description

A quick overview of Vehicle Keys.

#Features

  • Flexible access
    • Choose physical inventory keys with plate and frequency metadata or persistent character identifier access.
    • Grant permanent or temporary access for owned, borrowed, spawned, job, rental, or stolen vehicles.
    • Rotate a vehicle's frequency to invalidate old physical keys.
    • Preserve key access across permanent plate changes through plate aliases.
    • Retire access when a vehicle is deleted so an old key cannot unlock a later vehicle that reuses the plate.
  • Vehicle controls
    • Open a dedicated key fob for the closest or selected vehicle.
    • Hold the menu key to browse accessible live vehicles.
    • Synchronize lock and engine state through server-authorized, distance-limited actions.
    • Configure engine start, stop, exit, and locked-exit behavior.
    • Add key fob animations, flashing lights, and optional spatial sounds.
  • Vehicle theft
    • Configure lockpick tools, durability, break and failure chances, skill checks, timing, animations, and vehicle restrictions.
    • Support item-based or keybind hotwiring.
    • Search eligible NPC vehicles or rob NPC drivers for temporary access.
    • Drop a physical key bag after an NPC robbery.
    • Detect nearby pedestrian witnesses for dispatch integrations.
  • Integration
    • Works without a garage dependency and uses normalized plates as its identity.
    • Optional garage providers can add stored and persistent vehicles, GPS, summoning, and other garage-owned actions to the vehicle list.
    • Compatibility aliases translate supported calls from qb-vehiclekeys, qbx_vehiclekeys, qs-vehiclekeys, and wasabi_carlock.
    • Client and server exports cover access, plate changes, key frequencies, vehicle controls, menus, settings, and provider capabilities.
    • Unlocked hooks allow custom access rules, theft restrictions, dispatch, and logging.
  • Player experience
    • Custom key-label templates and optional player-defined labels.
    • Optional recovery command for automatic key grants that could not fit in the inventory.
    • Personal engine-start and vehicle-exit preferences.
    • 16 included translations.

Vehicle Keys does not own garage VINs, vehicle ownership, finance, impounds, storage, or persistent vehicle spawning. Those responsibilities remain with the installed garage or vehicle resource.