Skip to content

A modular chat and command system for FiveM supporting ESX, QBCore, QBox, and standalone servers.

License

Notifications You must be signed in to change notification settings

CodeMeAPixel/pxCommands

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

42 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

pxCommands

A modular chat and command system for FiveM supporting ESX, QBCore, QBox, and standalone servers.

Features

  • Framework agnostic with explicit configuration
  • Modular architecture (commands, modules, system)
  • Event namespace (pxc:*)
  • Server-side security enforcement
  • Automatic command help and suggestions
  • Range-based proximity messaging

Quick Start

  1. Place pxCommands in your resources folder
  2. Add ensure pxCommands to server.cfg
  3. Edit system/config.lua with your framework:
    Config.Framework = 'esx'  -- or 'qbcore', 'qbox', 'standalone'
  4. Create command packs in commands/ folder

Full setup guide: docs/GETTING_STARTED.md

Command Packs

Create .lua files in commands/:

CommandPack("MyPack", "AuthorName", {
    {
        command = "hello",
        format = "#name# says hello!",
        help = "Say hello",
    },
})

Full reference: docs/COMMAND_PACKS.md

Documentation

Doc Purpose
docs/GETTING_STARTED.md Installation and first steps
docs/COMMAND_PACKS.md How to create commands
docs/CONFIG_REFERENCE.md All configuration options
docs/ARCHITECTURE.md Technical structure
docs/TROUBLESHOOTING.md Common issues
.github/SECURITY.md Security policy