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

Rewrite of current esx_policejob #60

Open
wants to merge 21 commits into
base: dev
Choose a base branch
from
Open
Show file tree
Hide file tree
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
55 changes: 31 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,27 +2,22 @@

This resource for ESX adds police armories, vehicle garages and ability for cops to search, handcuff people and much more.

### Requirements
* Auto mode
* [esx_billing](https://github.com/esx-framework/esx_billing)
* [esx_vehicleshop](https://github.com/esx-framework/esx_vehicleshop)
### **Required Dependencies**

* Player management (boss actions and armory with buyable weapons)
* [esx_addoninventory](https://github.com/esx-framework/esx_addoninventory)
* [esx_datastore](https://github.com/esx-framework/esx_datastore)
* [esx_society](https://github.com/esx-framework/esx_society)
These dependencies are required **100%** for the resource to function properly:

* ESX Identity Support
* [esx_identity](https://github.com/esx-framework/esx_core/tree/main/%5Bcore%5D/esx_identity)
* [ox_lib](https://github.com/overextended/ox_lib)
* [esx_service](https://github.com/esx-framework/esx_service) *(Required on the server, but can be disabled in Config)*
* [esx_society](https://github.com/esx-framework/esx_society) *(Required on the server, but can be disabled in Config)*

* ESX License Support
* [esx_license](https://github.com/esx-framework/esx_license)
### **Optional Features Based on Configuration**

* ESX Service Support
* [esx_service](https://github.com/esx-framework/esx_service)
These additional features can be enabled/disabled through the configuration in `Config.EnabledModules`:

* ESX Status Support
* [esx_status](https://github.com/esx-framework/esx_status)
- **esx_optionalneeds** - *Allows checking the drunk state of a player (e.g., police officers can check the alcohol level of other players).*
- **esx_license** - *Allows police officers to give and remove licenses from players.*

These features are optional, and only required if enabled in the configuration.

## Download & Installation

Expand All @@ -41,20 +36,32 @@ git clone https://github.com/esx-framework/esx_policejob [esx]/esx_policejob
- Download https://github.com/esx-framework/esx_policejob/archive/master.zip
- Put it in the `[esx]` directory

### Installation

1. **Database Setup**
- Import the `esx_policejob.sql` file into your database.

2. **Enable Optional Features**
Modify the `Config.EnabledModules` section in the `config.lua` file to enable the following features:

- **License Management:**
Set `Config.EnabledModules.esxLicense` to `true` to allow adding and removing licenses.

## Installation
- Import `esx_policejob.sql` in your database
- Add this to your server.cfg:
- **Fine Issuing:**
Set `Config.EnabledModules.esxBilling` to `true` if you want to enable the ability to issue fines.

- **ID Card Info:**
Set `Config.EnabledModules.esxIdentity` to `true` to include additional information like gender, height, and date of birth on the ID card.

- **Drunk Level:**
Set `Config.EnabledModules.esxOptionalNeeds` to `true` to display the player's drunk level on the ID card.

- Add this to your `server.cfg`:

```
start esx_policejob
```

- * If you want player management you have to set `Config.EnablePlayerManagement` to `true` in `config.lua`
* If you want armory management you have to set `Config.EnableArmoryManagement` to `true` in `config.lua`
* If you want license management you have to set `Config.EnableLicenses` to `true` in `config.lua`
* If you want service management you have to set `Config.MaxInService` to a higher value than `-1` in `config.lua`

# Legal
### License
esx_policejob - police script for ESX
Expand Down
Loading