@@ -7,15 +7,12 @@ system/
77├── config.lua Shared configuration table
88├── server/
99│ ├── pre.lua Initialization, framework setup, helpers
10- │ ├── commands.lua Command registration and handler
11- │ └── fxcheck_*.lua Version checks (executed last)
10+ │ └── commands.lua Command registration and handler
1211├── client/
1312│ └── proximity.lua Range-based message broadcast
1413└── versioncheck.lua Update checking and autoupdate
1514modules/
16- ├── cl_*.lua Client modules (auto-loaded)
17- ├── sv_*.lua Server modules (auto-loaded)
18- └── sh_*.lua Shared modules (auto-loaded)
15+ └── cl_*.lua Client modules (auto-loaded)
1916commands/
2017└── *.lua Command packs (auto-loaded)
2118```
@@ -24,13 +21,8 @@ commands/
2421
25221 . ` fxmanifest.lua ` loads all scripts in order
26232 . ` system/config.lua ` initializes Config table
27- 3 . ` settings.lua ` allowed to override Config
28- 4 . ` system/server/pre.lua ` runs framework detection and init
29- 5 . Any module files load based on pattern
30- 6 . Command pack files load from ` commands/ `
31- 7 . ` system/server/fxcheck_*.lua ` validates environment
32- 8 . ` system/server/commands.lua ` registers all commands
33- 9 . ` system/versioncheck.lua ` checks for updates
24+
25+ ** Client:** ` modules/cl_*.lua ` client modules load in parallel with server
3426
3527## Data Flow
3628
@@ -60,11 +52,7 @@ onCommandExecuted hook (if set)
6052
6153## Configuration
6254
63- Config is a global shared table. Modify in:
64- - ` system/config.lua ` (defaults)
65- - ` settings.lua ` (user overrides)
66-
67- All fields optional; library provides sensible defaults.
55+ Config is a global shared table. Modify in ` system/config.lua ` .
6856
6957## Security Model
7058
@@ -92,12 +80,38 @@ All fields optional; library provides sensible defaults.
9280
9381## Extending pxCommands
9482
83+ ### Custom Command Packs
84+
85+ The primary extension method is creating command packs in ` commands/*.lua ` :
86+
87+ ``` lua
88+ CommandPack (" MyCustom" , " AuthorName" , {
89+ {
90+ command = " mycommand" ,
91+ help = " My custom command" ,
92+ format = " #username# did something" ,
93+ cb = function (source , message , command , args , raw )
94+ -- Your custom logic here
95+ end
96+ }
97+ })
98+ ```
99+
100+ See [ COMMAND_PACKS.md] ( ./COMMAND_PACKS.md ) for detailed documentation.
101+
95102### Custom Modules
96103
97- Drop ` .lua ` files into ` modules/ ` and they auto-load via pattern:
98- - ` cl_*.lua ` → Client (shared)
99- - ` sv_*.lua ` → Server (shared)
100- - ` sh_*.lua ` → Shared
104+ To add custom server or shared modules, manually add them to ` fxmanifest.lua ` :
105+
106+ ``` lua
107+ server_scripts {
108+ ' system/server/pre.lua' ,
109+ ' commands/*.lua' ,
110+ ' modules/my_custom_module.lua' , -- Add here
111+ ' system/server/commands.lua' ,
112+ ' system/versioncheck.lua'
113+ }
114+ ```
101115
102116### Custom Admin Logic
103117
0 commit comments