Skip to content

RoleplayRevisited/rr_keyfob

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

42 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

rr_keyfob

A simple keyfob script to control your car You can open your trunk/frunk, lock/unlock your car, start/stop your car, trigger your alarm and control your windows. Also have a look at the config, there are a few things you can toggle.

I hope you will enjoy this simple resource ;)

Warning

When installing the resource make sure you rename it to rr_keyfob

Usage

To open the keyfob press I this can be changed by the user in their keybindings When the button is pressed the keyfob will appear and nui focus will be on. There are a few buttons the player can click (see image below)

all the buttons

As you can see you have four buttons + the screen. The screen will be updated at a later time to have multiple pages and even more control. For now you have the following buttons:

  • Left Side -> Open trunk (or if the engine is in the rear open frunk)
  • Right Side -> Toggle Engine
  • Unlock Icon -> Unlock the car | Double press to trigger the alarm
  • Circle -> Lock the car
  • Screen -> Each window button opens a specific window (top left opens fron left window, etc etc)

Key System

To make use of the build-in key system you need to set useKeySystem = true in the config.

How this system works is that it checks if the license plate matches the database table. In the case of esx it checks owned_vehicles and in the case of qbcore it checks player_vehicles

If you have an additional need to give keys to players for vehicles they don't own personally (For example for any jobs or emergency services where you want to give people the ability to lock those vehicles aswell.) You need to do some manual work. In the resource that spawns a vehicle where you want to give a player the key for you can trigger this event.

From the client:

TriggerServerEvent("rr_keyfob:giveKey", vehicle) -- vehicle is the Vehicle entity

From the server:

TriggerEvent("rr_keyfob:giveKey", vehicle, source) -- vehicle is the Vehicle entity & source the client source

Roadmap

If there is interest in this resource I will probably rewrite a bit of the code to make it cleaner. And I will also add multiple pages to the screen. The pages I was thinking of creating

  • Fuel page (See amount of fuel left)
  • Door Control page (Control the vehicle doors)
  • More to come....

If you have any further questions please join my Discord. So that I can help you

Credits

Troughy Added vehicle owned check in db

The icons used: Car window icons created by LAFS - Flaticon

Legal

License

rr_keyfob Copyright (c) 2022 RoleplayRevisited

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

A simple keyfob script to control your car

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published