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.
- 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.
- Install: Drop
pxCommandsinto yourresourcesfolder. - Initialize: Add
ensure pxCommandsto yourserver.cfg. - Configure: Open
system/config.luato set your framework:Config.Framework = 'qbox' -- 'esx', 'qbcore', 'qbox', or 'standalone'
- Create: Create your first command pack in the
commands/folder. - Deploy: Open your F8 console in game and run
restart pxCommandsto see your new command(s) in action.
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 |
| 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. |
This project is licensed under the GNU Affero General Public License v3.0. See the LICENSE file for details.