292 lines
13 KiB
Markdown
292 lines
13 KiB
Markdown
|
# Project Sloth MDT
|
||
|
|
|
||
|
|
For all support questions, ask in our [Discord](https://www.discord.gg/projectsloth) support chat. Do not create issues if you need help. Issues are for bug reporting and new features only.
|
||
|
|
|
||
|
|
## Dependencies
|
||
|
|
|
||
|
|
- [QBCore](https://github.com/qbcore-framework/qb-core)
|
||
|
|
- [ps-dispatch](https://github.com/Project-Sloth/ps-dispatch)
|
||
|
|
- [oxmysql](https://github.com/overextended/oxmysql)
|
||
|
|
- [qb-apartments](https://github.com/qbcore-framework/qb-apartments) | [Config](https://github.com/Project-Sloth/ps-mdt/blob/0ce2ab88d2ca7b0a49abfb3f7f8939d0769c7b73/shared/config.lua#L3) available to enable or disable.
|
||
|
|
- [qb-communityservice](https://github.com/Zepherlah/qb-community-service) - If you're planning on sending to community service.
|
||
|
|
|
||
|
|
# Installation
|
||
|
|
* Download ZIP
|
||
|
|
* Drag and drop resource into your server files, make sure to remove -main in the folder name
|
||
|
|
* Run the attached SQL script (mdt.sql)
|
||
|
|
|
||
|
|
# Weapon Info Export
|
||
|
|
|
||
|
|
Adds server export for inserting weaponinfo records, that can be used elsewhere in your server, such as weapon purchase, to add information to the mdt. Below is the syntax for this, all arguments are strings.
|
||
|
|
|
||
|
|
```
|
||
|
|
exports['ps-mdt']:CreateWeaponInfo(serial, imageurl, notes, owner, weapClass, weapModel)
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
## Self Register Weapons
|
||
|
|
* Your citizens can self-register weapons found on their inventory. Event to trigger is below if you're using qb-target. There's also a command available named `registerweapon` but you'll need to uncomment if you want to use it.
|
||
|
|
```
|
||
|
|
ps-mdt:client:selfregister
|
||
|
|
```
|
||
|
|
|
||
|
|
https://user-images.githubusercontent.com/82112471/226150422-0c4776f0-0927-4b07-a272-972dd1c20077.mp4
|
||
|
|
|
||
|
|
# Automatic Mugshot Pictures
|
||
|
|
|
||
|
|
|
||
|
|
## Setup for Automatic Mugshot
|
||
|
|
* Set Config.UseCQCMugshot to true, It is true by default. (Line 5 in Config.lua)
|
||
|
|
```lua
|
||
|
|
Config.UseCQCMugshot = true
|
||
|
|
```
|
||
|
|
* Choose what photos you want by changing this: (Line 8 in Config.lua)
|
||
|
|
```lua
|
||
|
|
-- Front, Back Side. Use 4 for both sides, we recommend leaving at 1 for default.
|
||
|
|
Config.MugPhotos = 1
|
||
|
|
```
|
||
|
|
* Create a Discord Webhook and add it [here](https://github.com/Project-Sloth/ps-mdt/blob/c10ea056705dd7b04894716266cd387b00109aff/server/main.lua#L16C26-L16C26)
|
||
|
|
```lua
|
||
|
|
-- Images for mug shots will be uploaded here. Add a Discord webhook.
|
||
|
|
local MugShotWebhook = ''
|
||
|
|
```
|
||
|
|
# Fine & Citation via item
|
||
|
|
|
||
|
|
* Add the item to your shared.lua > items.lua
|
||
|
|
```
|
||
|
|
['mdtcitation'] = {['name'] = 'mdtcitation', ['label'] = 'Citation', ['weight'] = 1000, ['type'] = 'item', ['image'] = 'citation.png', ['unique'] = true, ['useable'] = false, ['shouldClose'] = true, ['combinable'] = nil, ['description'] = 'Citation from a police officer!'},
|
||
|
|
```
|
||
|
|
* Add the below code to your inventory > app.js. Should be somewhere around markedbills, see below for reference.
|
||
|
|
```
|
||
|
|
} else if (itemData.name == "mdtcitation") {
|
||
|
|
$(".item-info-title").html("<p>" + itemData.label + "</p>");
|
||
|
|
$(".item-info-description").html(
|
||
|
|
'<p><strong>Citizen ID: </strong><span>' + itemData.info.citizenId + '</span></p>' +
|
||
|
|
'<p><strong>Fine: </strong><span>' + itemData.info.fine + '</span></p>' +
|
||
|
|
'<p><strong>Citation Date: </strong><span>' + itemData.info.date + '</span></p>' +
|
||
|
|
'<p><strong>Incident ID: </strong><span>' + itemData.info.incidentId + '</span></p>' +
|
||
|
|
'<p><strong>Involved Officer: </strong><span>' + itemData.info.officer + '</span></p>'
|
||
|
|
);
|
||
|
|
```
|
||
|
|
* Reference for proper placement.
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
# Clock In/Out & Leaderboard
|
||
|
|
* Triggers when officers Toggle Duty from inside the mdt.
|
||
|
|
* Create a Discord Webhook and add it here [here](https://github.com/Project-Sloth/ps-mdt/blob/c10ea056705dd7b04894716266cd387b00109aff/server/main.lua#L20)
|
||
|
|
```
|
||
|
|
local ClockinWebhook = ''
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
# Jailing & Community Service
|
||
|
|
* If you're getting kicked for attempted exploit abuse when jailing. Located the follow event below on qb-policejob > server > main.lua
|
||
|
|
|
||
|
|
```lua
|
||
|
|
police:server:JailPlayer
|
||
|
|
```
|
||
|
|
|
||
|
|
* Then comment out around line [779](https://github.com/qbcore-framework/qb-policejob/blob/937499495aa73538710737c14bd1b26d233dd599/server/main.lua#L779) as seen below
|
||
|
|
|
||
|
|
```lua
|
||
|
|
-- if #(playerCoords - targetCoords) > 2.5 then return DropPlayer(src, "Attempted exploit abuse") end
|
||
|
|
```
|
||
|
|
|
||
|
|
# Inventory Edit | Automatic Add Weapons with images
|
||
|
|
* [lj-inventory](https://github.com/loljoshie/lj-inventory) will come already with the changes needed for this to work.
|
||
|
|
* [qb-inventory](https://github.com/qbcore-framework/qb-inventory) follow instructions below.
|
||
|
|
|
||
|
|
1. Edit the following event
|
||
|
|
```
|
||
|
|
RegisterNetEvent('inventory:server:SetInventoryData', function(fromInventory, toInventory, fromSlot, toSlot, fromAmount, toAmount)
|
||
|
|
```
|
||
|
|
```
|
||
|
|
elseif QBCore.Shared.SplitStr(shopType, "_")[1] == "Itemshop" then
|
||
|
|
if Player.Functions.RemoveMoney("cash", price, "itemshop-bought-item") then
|
||
|
|
if QBCore.Shared.SplitStr(itemData.name, "_")[1] == "weapon" then
|
||
|
|
itemData.info.serie = tostring(QBCore.Shared.RandomInt(2) .. QBCore.Shared.RandomStr(3) .. QBCore.Shared.RandomInt(1) .. QBCore.Shared.RandomStr(2) .. QBCore.Shared.RandomInt(3) .. QBCore.Shared.RandomStr(4))
|
||
|
|
itemData.info.quality = 100
|
||
|
|
end
|
||
|
|
local serial = itemData.info.serie
|
||
|
|
local imageurl = ("https://cfx-nui-qb-inventory/html/images/%s.png"):format(itemData.name)
|
||
|
|
local notes = "Purchased at Ammunation"
|
||
|
|
local owner = Player.PlayerData.charinfo.firstname .. " " .. Player.PlayerData.charinfo.lastname
|
||
|
|
local weapClass = 1
|
||
|
|
local weapModel = QBCore.Shared.Items[itemData.name].label
|
||
|
|
AddItem(src, itemData.name, fromAmount, toSlot, itemData.info)
|
||
|
|
TriggerClientEvent('qb-shops:client:UpdateShop', src, QBCore.Shared.SplitStr(shopType, "_")[2], itemData, fromAmount)
|
||
|
|
QBCore.Functions.Notify(src, itemInfo["label"] .. " bought!", "success")
|
||
|
|
exports['ps-mdt']:CreateWeaponInfo(serial, imageurl, notes, owner, weapClass, weapModel)
|
||
|
|
TriggerEvent("qb-log:server:CreateLog", "shops", "Shop item bought", "green", "**"..GetPlayerName(src) .. "** bought a " .. itemInfo["label"] .. " for $"..price)
|
||
|
|
elseif bankBalance >= price then
|
||
|
|
Player.Functions.RemoveMoney("bank", price, "itemshop-bought-item")
|
||
|
|
if QBCore.Shared.SplitStr(itemData.name, "_")[1] == "weapon" then
|
||
|
|
itemData.info.serie = tostring(QBCore.Shared.RandomInt(2) .. QBCore.Shared.RandomStr(3) .. QBCore.Shared.RandomInt(1) .. QBCore.Shared.RandomStr(2) .. QBCore.Shared.RandomInt(3) .. QBCore.Shared.RandomStr(4))
|
||
|
|
itemData.info.quality = 100
|
||
|
|
end
|
||
|
|
local serial = itemData.info.serie
|
||
|
|
local imageurl = ("https://cfx-nui-qb-inventory/html/images/%s.png"):format(itemData.name)
|
||
|
|
local notes = "Purchased at Ammunation"
|
||
|
|
local owner = Player.PlayerData.charinfo.firstname .. " " .. Player.PlayerData.charinfo.lastname
|
||
|
|
local weapClass = 1
|
||
|
|
local weapModel = QBCore.Shared.Items[itemData.name].label
|
||
|
|
AddItem(src, itemData.name, fromAmount, toSlot, itemData.info)
|
||
|
|
TriggerClientEvent('qb-shops:client:UpdateShop', src, QBCore.Shared.SplitStr(shopType, "_")[2], itemData, fromAmount)
|
||
|
|
QBCore.Functions.Notify(src, itemInfo["label"] .. " bought!", "success")
|
||
|
|
exports['ps-mdt']:CreateWeaponInfo(serial, imageurl, notes, owner, weapClass, weapModel)
|
||
|
|
TriggerEvent("qb-log:server:CreateLog", "shops", "Shop item bought", "green", "**"..GetPlayerName(src) .. "** bought a " .. itemInfo["label"] .. " for $"..price)
|
||
|
|
else
|
||
|
|
QBCore.Functions.Notify(src, "You don't have enough cash..", "error")
|
||
|
|
end
|
||
|
|
````
|
||
|
|
|
||
|
|
# Wolfknight Plate Reader & Radar Compatibility
|
||
|
|
|
||
|
|
Support for Wolfknight Radar & Plate Reader
|
||
|
|
https://github.com/WolfKnight98/wk_wars2x
|
||
|
|
|
||
|
|
Plate reader automatically locks and alerts Police if:
|
||
|
|
|
||
|
|
* Vehicle owner is Wanted
|
||
|
|
* Vehicle owner has no drivers licence
|
||
|
|
* Vehicle has a BOLO
|
||
|
|
|
||
|
|
**IMPORTANT:**
|
||
|
|
|
||
|
|
* Ensure you set "CONFIG.use_sonorancad = true" in wk_wars2x/config.lua
|
||
|
|
|
||
|
|
This reduces the plate reader events to player's vehicles and doesn't query the database for hundreds of NPC vehicles
|
||
|
|
|
||
|
|
### Video Demonstration
|
||
|
|
https://youtu.be/w9PAVc3ER_c
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
### Traffic Stop Radialmenu Alert
|
||
|
|
|
||
|
|
* When initiating a traffic stop allows you to notify your fellow officers of your location and provide details about the current location and stopped vehicle through the radial menu.
|
||
|
|
|
||
|
|
|
||
|
|
1. Add the following code right above `function READER:Main()` on `cl_plate_reader.lua`
|
||
|
|
|
||
|
|
```
|
||
|
|
local Vehicle = nil
|
||
|
|
local function GetFrontPlate()
|
||
|
|
local data = {
|
||
|
|
locked = READER.vars.cams["front"].locked,
|
||
|
|
plate = READER.vars.cams["front"].plate,
|
||
|
|
veh = Vehicle,
|
||
|
|
}
|
||
|
|
return data
|
||
|
|
end exports("GetFrontPlate", GetFrontPlate)
|
||
|
|
```
|
||
|
|
|
||
|
|
2. Add the following into `cl_plate_reader.lua` after `local veh = UTIL:GetVehicleInDirection( PLY.veh, start, offset )` on the function `function READER:Main()`
|
||
|
|
```
|
||
|
|
if i == 1 then
|
||
|
|
Vehicle = veh
|
||
|
|
end
|
||
|
|
```
|
||
|
|
|
||
|
|
* Should look like this after completing the above steps.
|
||
|
|
|
||
|
|
|
||
|
|
3. Add **ps-mdt:client:trafficStop** into the Radialmenu
|
||
|
|
|
||
|
|
* Preview.
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
# Roster and SOPs Setup
|
||
|
|
|
||
|
|
* You need a Google Document / Sheet link that is viewable.
|
||
|
|
|
||
|
|
Paste the link you got in the config here:
|
||
|
|
```
|
||
|
|
-- Google Docs Link
|
||
|
|
Config.sopLink = {
|
||
|
|
['police'] = '',
|
||
|
|
['ambulance'] = '',
|
||
|
|
['bcso'] = '',
|
||
|
|
['doj'] = '',
|
||
|
|
['sast'] = '',
|
||
|
|
['sasp'] = '',
|
||
|
|
['doc'] = '',
|
||
|
|
['lssd'] = '',
|
||
|
|
['sapr'] = '',
|
||
|
|
}
|
||
|
|
|
||
|
|
-- Google Docs Link
|
||
|
|
Config.RosterLink = {
|
||
|
|
['police'] = '',
|
||
|
|
['ambulance'] = '',
|
||
|
|
['bcso'] = '',
|
||
|
|
['doj'] = '',
|
||
|
|
['sast'] = '',
|
||
|
|
['sasp'] = '',
|
||
|
|
['doc'] = '',
|
||
|
|
['lssd'] = '',
|
||
|
|
['sapr'] = '',
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
# Preview
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
# Multi Departments
|
||
|
|
* LSPD
|
||
|
|
|
||
|
|
* BCSO
|
||
|
|
|
||
|
|
* SASP
|
||
|
|
|
||
|
|
* SAST
|
||
|
|
|
||
|
|
* SAPR
|
||
|
|
|
||
|
|
* LSSD
|
||
|
|
|
||
|
|
* DOC
|
||
|
|
|
||
|
|
|
||
|
|
# FAQ
|
||
|
|
- **How do I add charges to a criminal in an Incident?** - After finding and adding the criminal citizen to the incident, right-click in the space under the criminal's name and select "Add Charge".
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
- **My dispatch calls are not being populated?** - You have not started the dispatch resource before the mdt or renamed the dispatch resource name and not made the necessary changes in mdt to reflect that.
|
||
|
|
|
||
|
|
# Reskins
|
||
|
|
The below repos are direct forks of ps-mdt and have been edited to fit certain countries/look.
|
||
|
|
|
||
|
|
* [US](https://github.com/OK1ez/ps-mdt/tree/main) Different layout and different colors.
|
||
|
|
* [UK](https://github.com/Harraa/ps-mdt)
|
||
|
|
|
||
|
|
# Credits
|
||
|
|
* Originally Echo RP MDT released by [Flawws#999](https://github.com/FlawwsX/erp_mdt)
|
||
|
|
* [CQC-Scripting](https://github.com/CQC-Scripting) for their [cqc-mugshot](https://github.com/CQC-Scripting/cqc-mugshot)
|
||
|
|
* [JoeSzymkowicz](https://github.com/JoeSzymkowicz)
|
||
|
|
* [MonkeyWhisper](https://github.com/MonkeyWhisper)
|
||
|
|
* [Snipe](https://github.com/pushkart2)
|
||
|
|
* [BackSH00TER](https://github.com/BackSH00TER)
|
||
|
|
* [nggcasey](https://github.com/nggcasey)
|
||
|
|
* [OK1ez](https://github.com/OK1ez)
|
||
|
|
* [Crayons0814](https://github.com/Crayons0814)
|
||
|
|
* [LeSiiN](https://github.com/LeSiiN)
|
||
|
|
* [ImXirvin](https://github.com/ImXirvin)
|
||
|
|
* [lenzh](https://github.com/lenzh)
|
||
|
|
* Everyone else that we may have missed, thank you!
|