PAID loki_PrisonCore - ESX/OX

[loki_script]

# Loki PrisonCore

Loki PrisonCore is a modern prison system for FiveM with **ESX**, **ox_inventory**, and **ox_lib**.
It allows police officers to jail, isolate, release players, or (in the Master Package) monitor them with an electronic ankle monitor.
All features can be executed via **commands** or conveniently through the **radial menu**.

---

## Table of Contents

- [Packages]
- [Installation]
- [Dependencies]
- [Commands & Radial Menu]
- [Items](#-items)
- [Events & Triggers]
- [Example Workflow]
- [Security]
- [Notes]
- [GitHub]


## Packages

### Main Package
Includes the core features of Loki PrisonCore:

- Prison system with timer
- **Jailing a player automatically removes their job**
- Isolation mode (solitary cell)
- Releasing players
- Management via **commands** and **radial menu**
- Server-side security to prevent abuse

### Master Package
Includes everything from the Main Package **plus** the exclusive Footcuff system:

#### Footcuff System (House Arrest)
- Police can equip players with an electronic ankle monitor
- Player’s live location visible to all police officers
- Customizable duration (house arrest ends automatically)
- After expiration: blip disappears + notification sent to the player
- All features accessible via **commands** and **radial menu**


## Installation

### PrisonCore (Main Package)
1. Copy the script to `resources/[police]/loki_prisoncore`
2. Add to `server.cfg`:
ensure loki_prisoncore



### Footcuff (Master Package)
1. Copy the script to `resources/[police]/footcuff`
2. Add to `server.cfg`:
ensure footcuff



## Dependencies
- ESX Legacy
- ox_inventory
- ox_lib



## Commands & Radial Menu

### PrisonCore (Main Package)
- `/jail [id] [time]` → Jail a player (**removes their job automatically**)
- `/unjail [id]` → Release a player
- `/isolation [id] [time]` → Put a player in isolation

All features are also available via the **radial menu**

### Footcuff (Master Package)
- `/fessel [id] [time]` → Equip ankle monitor
- `/removefessel [id]` → Remove ankle monitor

Also integrated into the **radial menu**

Only players with a police job can use the commands.

Demo: [Streamable](https://streamable.com/997244)
Buy: [Tebex](https://loki-esx.tebex.io/category/2641460)



## Items

### Footcuff Item (Master Package)
Add to `ox_inventory/data/items.lua`:
```lua
['ankle_monitor'] = {
label = 'Ankle Monitor',
weight = 200,
stack = false,
close = true,
description = 'Electronic ankle monitor for location tracking',
}
Events & Triggers
PrisonCore (Main Package)
Server → Client:

prison:jailPlayer → Player is jailed (job removed automatically)

prison:releasePlayer → Player is released

prison:isolatePlayer → Player is put in solitary

Footcuff (Master Package)
Client → Server:

footcuff:apply → Player receives ankle monitor

footcuff:remove → Ankle monitor is removed

Server → Client:

footcuff:createBlip → Create live location on the map

footcuff:removeBlip → Remove live location

footcuff:notify → Send notification to player

Example Workflow
PrisonCore

Officer executes /jail [id] [time] or selects player via radial menu

Player is teleported to jail

Player automatically loses their current job

Timer runs out → player is automatically released

Footcuff (Master Package)

Officer has footcuff item in inventory

Executes /fessel [id] [time] or uses radial menu

Player receives the cuff, police see live location

After expiration, blip disappears automatically

Police can manually remove the cuff anytime

Security
Only police can execute functions

Job removal on jailing enforced server-side

All actions secured server-side

Items (e.g., footcuff) removed from inventory when equipped

Player abuse is prevented

Notes
Radial menu can be customized individually

New features can be added modularly without modifying core Lua files, leaving room for updates

GitHub Repository
Official GitHub repository:

Hidden link for visitors, to see Log in or register now.