roleplay-commands/README.MD

Simple and easy to use commands for GTA or Roblox Roleplay

# RE MAKE WITH LEO AND CIV SPOTS

# roleplay-commands
<br><br>

## Installation
#
```js
npm install roleplay-commands
```
#

## Setup
#
const RPcommands = require('roleplay-commands')
const rp = new RPcommands

<br>

# NOTICE this looks a lot better if the bot prefix is `/` since it replicates real FiveM

## Functions
#
```js
  .lockCar(message)
  .unlockCar(message)
  .refuel(message)
  .unrackRifle(message)
  .rackRifle(message)
  .windowsUp(message)
  .windowsDown(message)
  .rackShotgun(message)
  .unrackShotgun(message)
  .searchPerson(message)
  .searchVehicle(message)
  .me(message, prefix)
  .OOC(message, text)
  .twotter(message, prefix)
  .radarOn(message)
  .radarOff(message)
  .cuff(message)
  unCuff(message)
  .engineOn(message)
  .engineOff(message)
  .seatbeltOn(message)
  .seatbeltOff(message)
  .dashcamOn(message)
  .dashcamOff(message)
  .radarSet(message, prefix)
  ```
 <br><br>

 Examples are included for these last three.
```js
const mapLink = 'your_patrol_map_link_here'
.patrolMap(message, mapLink)
```
<br><br>
```js
const cadLink = 'your_cad/mdt_link_here'
.cadMdt(message, cadLink)
```
<br><br>
```js
const penalCodeLink = 'your_penal_code_link_here'
.penalCode(message, penalCodeLink
```
 #

 <br>

 <!-- ## Future Updates:
 #
 Add custom messages for most commands (Update will be on: 6/5/2021)
 #
 Add Notes, Tickets, Warnings, Arrest Reports (Update will be on: 6/5/2021)
 #
 Put every command into LEO and Civ categories (Update will be on: 6/5/2021)
 #
 Make the Notes be per user saved in a DB, make tickets, warnings, arrest reports save into a specified log channel (Update will be on: UNKNOWN)
 #
 Add Warrant Creation and save it to a specified log channel(Update will be on: UNKOWN)
 # -->

 ## Change Log
    5/9/2021
 - Changed the README file a little bit
 - Fixed action command "prefix is not defined" and added an OOC (out of character) || Changed action to `me` to look more like FiveM
 #
   5/16/2021
 - Added an updated `Future Updates` section
 #
  10/9/2021
 - Fixed the searchPerson command