Peak Ped Manager Documentation

Welcome to the official documentation for Peak Ped Manager, a standalone FiveM resource for real-time in-world ped spawning, scenario & animation customization, prop attachments, ox_target interactions, and SQL persistence.

1. Overview & Features
2. Installation Guide
3. Configuration
4. Commands & Keybindings
5. Developer API (Exports & Events)
6. Target Interactions & Event Payloads
7. NUI Development & Building
8. Database Schema
9. Performance & Streaming Culling

Peak Ped Manager provides a standalone tool with a clean React 18 NUI allowing server owners to spawn static or animated peds, set their animations, scenarios (e.g. leaning on cars, drinking coffee, inspecting clipboards, guarding, sitting), props, and interaction points, saving them directly to SQL.

Key Features:

• 🎨 Modern React + Tailwind NUI: High-performance glassmorphism dashboard with search and tabs.
• 📍 Live 3D Placement & Gizmo Sliders: Position, ground-align, and rotate peds in real-time in the world with instant visual feedback.
• 🎭 GTAV Scenarios & Animations: Built-in library of GTAV native scenarios and custom animation dictionary support.
• 📦 Prop Attachment System: Attach props (clipboard, coffee cup, notepad, pen, phone) to peds with bone index customization.
• ⚡ Distance Culling & Dynamic Streaming: Authoritative server state syncing that dynamically spawns/despawns peds based on player proximity.
• 🎯 Multi-Target System: Seamless integration with ox_target, qb-target, qtarget, or 3D Text / E-key fallback prompts.
• 💾 SQL Persistence: Saves ped configurations directly to MySQL via oxmysql with zero data loss on server restarts.
• ⚙️ Framework Agnostic: Native support for QBCore, ESX, Qbox, and Standalone servers.
• 📤 Import & Export JSON: Share or backup ped placement configurations across multiple servers.

Prerequisites

• oxmysql

🤖 AI-First Setup (Recommended)

1. Open PROMPT.md in the resource folder.
2. Copy the content and paste it into your AI assistant.
3. Follow its instructions to automatically configure the framework and target settings.

Manual Setup

1. Download and place the peak-pedmanager folder into your resources directory.
2. Import install/schema.sql into your database.
3. Configure shared/config.lua for your framework and preferences.
4. Add ensure peak-pedmanager to your server.cfg after oxmysql.

• shared/config.lua: Primary configuration file for permissions, open keys, and streaming thresholds.
• shared/scenarios.lua: GTAV scenario names, animation dicts, ped model categories, and prop presets.

Server Exports

lua
-- Get all cached ped records
local peds = exports['peak-pedmanager']:GetAllPeds()

-- Get ped by DB ID
local ped = exports['peak-pedmanager']:GetPedById(12)

The UI for Peak Ped Manager is built with React 18, TypeScript, and Tailwind CSS.

bash
cd ui
npm install
npm run build

Pre-built assets are included in ui/dist.

peak_peds

• id: INT AUTO_INCREMENT PRIMARY KEY
• title: VARCHAR(100)
• model: VARCHAR(100)
• x, y, z, h: FLOAT
• scenario: VARCHAR(100)
• anim_dict, anim_name: VARCHAR(100)
• prop_model: VARCHAR(100), prop_bone: INT
• freeze, invincible, block_events, collision: TINYINT(1)
• interaction_type, interaction_label, interaction_icon, interaction_payload: Target action config.

Documentation generated by Peak Studios. For support, visit our Discord.