Status
Lightweight, High-Performance Player Status System | Framework Agnostic
lcky-status is a modern player status system with advanced Bridge system for full framework compatibility.
โจ Features
| Feature | Description |
|---|---|
| ๐ Bridge System | Auto-detects qbx_core, qb-core, or ESX |
| ๐พ Metadata Storage | Uses native framework metadata (no SQL tables) |
| ๐จ Modern UI | ox_lib context menus and input dialogs |
| ๐๏ธ Multi-Targeting | Works with ox_target and qb-target |
| ๐ Proximity Alerts | Notifies players within 10m when status changes |
| โก Optimized | 0.00ms idle performance |
| ๐ ๏ธ Developer API | Comprehensive exports for integration |
๐ฆ Compatibility
Supported Frameworks
- โ
Qbox (
qbx_core) - โ
QBCore (
qb-core) - โ
ESX (
es_extended)
Supported Target Systems
- โ ox_target
- โ qb-target
Dependencies
- ox_lib (opens in a new tab) (Required)
๏ฟฝ Installation
# 1. Place in resources folder
# resources/lcky-status/
# 2. Add to server.cfg
ensure lcky-status
# 3. Restart server๐ฎ Usage
For Players
Set Status
/statusOpens a menu where you can:
- Set Status - Enter a custom message (e.g., "Working", "AFK - Brb")
- Clear Status - Remove your current status
View Others' Status
Press your interaction key (default Alt) while looking at another player to see their status.
๐ Proximity Notifications
When you update your status, players within a 10-meter radius receive a notification informing them of the change.
๐ป Developer API
Server-Side Exports
-- Get a player's status
local status = exports['lcky-status']:GetPlayerStatus(source)
-- Returns: "Working at the Forge" or nil
-- Set a player's status
exports['lcky-status']:SetPlayerStatus(source, "Custom Status")Client-Side Exports
-- Get your current status from server
local status = exports['lcky-status']:GetPlayerStatusFromServer()๐ License
Developed by LuckyScripts Special thanks to Qbox Project and Overextended team