Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(README): re-write with more features #152

Merged
merged 1 commit into from
Oct 26, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 41 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,49 @@
![image](https://github.com/user-attachments/assets/02fd0189-afc9-45d0-8377-0d1ae929f0ff)


# qbx_vehiclekeys
An advanced customizable vehicle key system for the Qbox framework

An advanced, customizable, and detailed open-source vehicle system for the Qbox framework. Unlike other vehicle key systems, qbx_vehiclekeys is open-source, maintained by an active community, and built off the feedback and testing of actual FiveM communities and servers!
# Features

## Backwards Compatibility with qb-vehiclekeys
All exports and events from qb-vehiclekeys will continue to work with qbx_vehiclekeys. However, we still recommend using the qbx_vehiclekey exports as they use less resources.

# Features
## General
- Players can obtain keys when entering a running vehicle (configurable)
- Vehicles can keep their engine running after exiting (configurable)
- World spawn vehicles have a random initial lock state (configurable)
- Exports to give/remove keys
- Vehicle lock status synced between clients
- Animations for all activities to increase immersion, including a special animation to play when toggling the engine!
- Players reconnecting will have the same keys that they had when they disconnected/crashed. The timeout for how long they can be disconnected and still get the same keys is configurable.

## Players Transfering Keys
- Players can give keys to the closest player or passengers in their vehicle via command
- Admins can also give keys
- Owners of vehicles always have keys to their own vehicles

## Shared Job Vehicles
- Jobs can share vehicles, letting emergency workers all have keys to emergency vehicles for example
- Autolock supported so that players don't need to remember to lock their vehicles when exiting (configurable)

## Highly Customizable
Apply config to all vehicles, or choose a specific vehicle type, class, category, or model to apply settings to. This allows for different minigame difficulties dependent on the vehicle, or exempt certain vehicles from hotwiring, etc.

## Criminal Actions

### Carjacking
Point a weapon at an NPC driver to force them to stop, put their hands up, exit the vehicle, and run away, giving you keys. Only weapons on the configurable allow list work for carjacking.

### Lockpicking
Use lockpicks with ox_lib skill minigames to unlock vehicle doors.

### Hotwiring
Use lockpicks when in the driver seat to get keys to the vehicle.

- Keys for your car, motorcycle, plane, whatever moves and has an engine!
- Extremely customizable for all types of servers, including serious roleplay, economy, zombie, and more!
- Shareable keys
- Customizable world spawn vehicle door lock chance
- Highly customizable, with the ability to set lock difficulty, chances, and requirements
- Police alert chance
- Job-specific vehicle keys
- efficient and clean code
### Searching For Keys
Search for the keys when in the driver seat to get keys to the vehicle.

🦆
### Police Alerts
Alerts police when a vehicle is being broken into, or stolen.
- Lower chance to alert at night (configurable)
- cooldown to prevent spam (configurable)