Skip to content

A lightweight, framework agnostic command & messaging ecosystem for FiveM.

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

58 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

pxCommands

License: AGPL v3 Version

pxCommands bridges the gap between complex frameworks and standalone simplicity. It handles the heavy lifting of command security creation and registration, leaving you to focus on the logic.


Key Features

  • Framework Agnostic: Native support for ESX, QBCore, QBox, and Standalone servers.
  • Secure by Design: Server side enforcement prevents client side spoofing.
  • Integrated Visuals: Built in modules for 3D Overhead Text and Color coded Notifications.
  • Proximity Aware: Range based messaging for immersive roleplay.
  • Auto Documentation: Generates command suggestions and help tooltips automatically.

Quick Start

  1. Install: Drop pxCommands into your resources folder.
  2. Initialize: Add ensure pxCommands to your server.cfg.
  3. Configure: Open system/config.lua to set your framework:
    Config.Framework = 'qbox'  -- 'esx', 'qbcore', 'qbox', or 'standalone'
  4. Create: Create your first command pack in the commands/ folder.
  5. Deploy: Open your F8 console in game and run restart pxCommands to see your new command(s) in action.

Modular System

pxCommands uses a modular client side architecture. You can easily extend how players interact with your commands.

Module Description Event Trigger
Notifications Colored screen alerts pxc:notify
Overhead Text Floating 3D text pxc:showFloatingText

Documentation

Resource Description
Getting Started Full installation and framework setup.
Command Packs How to write and register new commands.
Config Reference Deep dive into config.lua settings.
Module Reference Introduction to our module system.
Troubleshooting Common issues and information
Architecture Technical flow and module breakdown.

Open-Source License

This project is licensed under the GNU Affero General Public License v3.0. See the LICENSE file for details.