📚Library Settings

🎯 What is alpha-Lib?

This library serves as a core dependency script that ensures all of our products work seamlessly across different server setups.

🔑 Key Features

• 🔄 Automatic Framework Support: Automatically detects ESX, QB-Core, QBX-Core, and ND_Core

• 🎯 Automatic Resource Detection: Automatically finds and configures resources on your server

• 🛠️ Common Functions: Shared functions used by all Alpha Scripts

• 🔧 Compatibility Guarantee: Ensures Alpha Scripts work regardless of your server setup

• 📊 Smart Bridge System: Provides compatibility between different frameworks

🚀 Installation

1. Script Installation

# Extract the alpha-Lib to your resources directory
resources/alpha-Lib

2. server.cfg Configuration

IMPORTANT: Start alpha-Lib BEFORE all Alpha Scripts:

# Start Alpha-Lib first
ensure alpha-Lib

# Then start other Alpha Scripts
ensure alpha-OilDrum
ensure alpha-NailBox
# ... other Alpha Scripts

⚙️ Configuration

Complete Configuration

Most settings use auto-detection. Manual configuration is only recommended when necessary.

Config = {
    ---@type "auto-detect" | "qb-core" | "es_extended" | "qbx_core" | "ND_Core"
    Framework = "auto-detect",

    ---@type "auto-detect" | "qb-inventory" | "ox_inventory" | "esx_addoninventory" | "tgiann-inventory"
    Inventory = "auto-detect",

    ---@type string | false
    ---@description If set to a string, it will use the item as money, otherwise it will use the default money system
    MoneyAsItem = false,

    ---@type "auto-detect" | "qb-target" | "ox_target"
    Target = "auto-detect",

    ---@type "auto-detect" | "qb-core" | "es_extended" | "qbx_core" | "ND_Core" | "ox_lib" | "okokNotify"
    Notification = "auto-detect",

    ---@type "left" | "right" | "top" | "bottom" | "top-right" | "top-left" | "bottom-right" | "bottom-left" | "center-right" | "center-left"
    NotificationPosition = "left",

    ---@type boolean
    ---@description If true, it will play a sound when a notification is displayed
    NotificationPlaySound = false,

    ---@type "auto-detect" | "qb-core" | "esx_textui" | "ox_lib" | "okokTextUI"
    TextUI = "auto-detect",

    ---@type "left" | "right" | "top" | "bottom" | "right-center" | "left-center" | "top-center" | "bottom-center"
    TextUIPosition = "left",

    ---@type boolean
    ---@description If true, it will play a sound when a Text UI is displayed
    TextUIPlaySound = false,

    ---@type "auto-detect" | "qb-core" | "ox_lib"
    ProgressBar = "auto-detect",

    ---@type "auto-detect" | "qb-core" | "es_extended" | "ox_lib"
    Callback = "auto-detect",

    ---@type "auto-detect" | "oxmysql" | "ghmattimysql"
    Database = "auto-detect",

    ---@type "auto-detect" | "qb-policejob" | "cd_dispatch3d"
    PoliceAlert = "auto-detect",

    ---@type boolean
    ---@description If true, it will make the police alert blip flash on the map
    PoliceAlertFlashes = false,

    ---@type boolean
    ---@description If true, it will play a sound when a police alert is sent
    PoliceAlertSound = true,
}

Configuration Options Explained

Setting	Description	Available Options
Framework	Detects your server's main framework	"auto-detect", "es_extended", "qb-core", "qbx_core", "ND_Core"
Inventory	Detects your inventory system	"auto-detect", "ox_inventory", "qb-inventory", "esx_addoninventory", "tgiann-inventory"
MoneyAsItem	Use an item as money instead of cash	false or item name like "cash"
Target	Detects your targeting system	"auto-detect", "ox_target", "qb-target"
Notification	Detects your notification system	"auto-detect", "ox_lib", "okokNotify", framework default
NotificationPosition	Position of notifications on screen	"left", "right", "top", "bottom", "top-right", "top-left", "bottom-right", "bottom-left", "center-right", "center-left"
NotificationPlaySound	Play sound with notifications	true or false
TextUI	Detects your text UI system	"auto-detect", "ox_lib", "okokTextUI", "esx_textui", framework default
TextUIPosition	Position of text UI on screen	"left", "right", "top", "bottom", "right-center", "left-center", "top-center", "bottom-center"
TextUIPlaySound	Play sound with text UI	true or false
ProgressBar	Detects your progress bar system	"auto-detect", "ox_lib", framework default
Callback	Detects your callback system	"auto-detect", "ox_lib", framework default
Database	Detects your database system	"auto-detect", "oxmysql", "ghmattimysql"
PoliceAlert	Detects your police alert system	"auto-detect", "qb-policejob", "cd_dispatch3d"
PoliceAlertFlashes	Make police alert blip flash on map	true or false
PoliceAlertSound	Play sound when police alert is sent	true or false

When to Change Settings

Most users should leave everything as "auto-detect" - the library will find your resources automatically.

Only change settings if:

• Auto-detection fails to find your resources

• You want to force a specific resource to be used

• You're using custom/renamed resources

UI Positioning Settings

Notification Positions

• "left" - Left side of screen

• "right" - Right side of screen

• "top" - Top of screen

• "bottom" - Bottom of screen

• "top-right" - Top right corner (QBX only)

• "top-left" - Top left corner (QBX only)

• "bottom-right" - Bottom right corner (QBX only)

• "bottom-left" - Bottom left corner (QBX only)

• "center-right" - Center right (QBX only)

• "center-left" - Center left (QBX only)

Text UI Positions

• "left" - Left side of screen

• "right" - Right side of screen

• "top" - Top of screen

• "bottom" - Bottom of screen

• "right-center" - Right center (ox_lib only)

• "left-center" - Left center (ox_lib only)

• "top-center" - Top center (ox_lib only)

• "bottom-center" - Bottom center (ox_lib only)

Advanced Settings

Money System Customization

-- Default money system
MoneyAsItem = false

-- Use item as money (e.g., "cash" item)
MoneyAsItem = "cash"

Sound Settings

-- Sound settings
NotificationPlaySound = false  -- Play sound with notifications
TextUIPlaySound = false        -- Play sound with text UI

📋 Supported Resources

🏗️ Frameworks

• ESX (es_extended) - Full support

• QB-Core (qb-core) - Full support

• QBX-Core (qbx_core) - Full support

• ND Core (ND_Core) - Full support

🎒 Inventory Systems

• ox_inventory - Recommended

• qb-inventory - QB-Core default

• esx_addoninventory - ESX default

• tgiann-inventory

🎯 Target Systems

• ox_target - Recommended

• qb-target - QB-Core default

🔔 Notification Systems

• ox_lib - Modern UI

• okokNotify - Popular choice

• Framework defaults

📱 Text UI Systems

• ox_lib - Modern, customizable

• okokTextUI - Popular choice with animations

• esx_textui - Classic ESX style

• Framework built-in - Uses framework's default

⏳ Progress Bar Systems

• ox_lib - Modern with animations

• Framework built-in - Uses framework's default

🔗 Callback Systems

• ox_lib - Modern callback system

• Framework built-in - Uses framework's default

🗄️ Database Systems

• oxmysql - Recommended

• ghmattimysql - Legacy support

🚔 Police Alert Systems

• qb-policejob - QB-Core police system

• cd_dispatch3d

NOTE: If you want to add support for a new script or resource, please contact us through our Discord server by opening a ticket. We'll be happy to help integrate new resources into Alpha-Lib.

📞 Support

🎮 Discord Server

Join the Alpha Scripts Discord Server!Discord

📝 When asking for help, please provide:

1. Your framework (ESX, QB-Core, QBX-Core, ND_Core)

2. Console errors (copy the full error message)

3. Your server setup (what inventory, target system, etc. you use)

4. What Alpha Script you're having issues with

✅ Before asking for support:

• Make sure alpha-Lib starts before all Alpha Scripts in server.cfg

• Check that all your resources are started and working

• Try restarting your server

• Check if the issue happens with only alpha-Lib (no other scripts)