@@ -5,7 +5,9 @@ import { Callout, Tabs } from "nextra/components";
55This comprehensive guide covers all configuration options available in Zerio Bossmenu. Each configuration file serves a specific purpose and allows you to customize the script to your server's needs.
66
77<Callout type = " warning" >
8- ** Important** : Always restart your server or the resource after making configuration changes. Some changes may require database updates or framework modifications.
8+ ** Important** : Always restart your server or the resource after making
9+ configuration changes. Some changes may require database updates or framework
10+ modifications.
911</Callout >
1012
1113## Configuration Files Overview
@@ -41,6 +43,7 @@ Config.ManagementScript = "esx_society"
4143```
4244
4345** Supported Options:**
46+
4447- ` esx_society ` - ESX society system
4548- ` qb-management ` - QBCore management
4649- ` qb-banking ` - QBCore banking
@@ -49,7 +52,8 @@ Config.ManagementScript = "esx_society"
4952- ` fd_banking ` - FD Banking
5053
5154<Callout type = " info" >
52- ** Custom Banking** : You can add support for custom banking systems by modifying the banking functions in ` server/functions.lua ` .
55+ ** Custom Banking** : You can add support for custom banking systems by
56+ modifying the banking functions in ` server/functions.lua ` .
5357</Callout >
5458
5559### Employee Management
@@ -69,6 +73,7 @@ Config.TrackWorkSessions = true -- Enable work session monitoring
6973```
7074
7175When enabled, this feature tracks:
76+
7277- Employee clock-in/clock-out times
7378- Session duration
7479- Activity logging
@@ -86,6 +91,7 @@ Config.MaxSalaries = {
8691```
8792
8893** Usage:**
94+
8995- Set maximum salary per job to prevent abuse
9096- Use ` nil ` or omit entry for no limit
9197- Applies to both individual and role-based salaries
@@ -107,6 +113,7 @@ Config.PlateSecondLength = 3 -- Length of second part of plate
107113```
108114
109115** Examples:**
116+
110117- ` ABC123 ` (PlateFirstLength=3, PlateHasSpace=false, PlateSecondLength=3)
111118- ` ABC 123 ` (PlateFirstLength=3, PlateHasSpace=true, PlateSecondLength=3)
112119
@@ -150,7 +157,8 @@ Enable for troubleshooting. Adds extra console output for debugging purposes.
150157## Framework Configuration (` configs/framework.lua ` )
151158
152159<Callout type = " info" >
153- ** Auto-Detection** : This file usually doesn't need modification as framework detection is automatic.
160+ ** Auto-Detection** : This file usually doesn't need modification as framework
161+ detection is automatic.
154162</Callout >
155163
156164``` lua
167175```
168176
169177** Manual Override** (if needed):
178+
170179``` lua
171180Config .Framework = " esx" -- Force framework type
172181Config .FrameworkResourceName = " my_custom_esx" -- Custom resource name
@@ -182,37 +191,23 @@ Config.HelpTextType = "normal"
182191
183192** Available Options:**
184193
185- <Tabs items = { [' Normal' , ' Target' , ' Proximity' ]} >
186- <Tabs.Tab >
187- ** Normal** - Standard floating help text
188-
189- ```lua
190- Config.HelpTextType = "normal"
191- Config.OpenKey = 38 -- E key (default)
192- ```
193-
194- Shows standard FiveM help text when near boss menu positions.
195- </Tabs.Tab >
196-
194+ <Tabs items = { [" Normal" , " Target" , " Proximity" ]} >
197195 <Tabs.Tab >
198- ** Target** - Targeting script integration
199-
200- ```lua
201- Config.HelpTextType = "target"
202- Config.TargetScript = "ox_target" -- or "qb-target", "qtarget"
203- ```
204-
205- Integrates with popular targeting scripts for immersive interaction.
196+ ** Normal** - Standard floating help text ```lua Config.HelpTextType =
197+ "normal" Config.OpenKey = 38 -- E key (default) ``` Shows standard FiveM
198+ help text when near boss menu positions.
206199 </Tabs.Tab >
207-
200+
201+ <Tabs.Tab >
202+ ** Target** - Targeting script integration ```lua Config.HelpTextType =
203+ "target" Config.TargetScript = "ox_target" -- or "qb-target", "qtarget" ```
204+ Integrates with popular targeting scripts for immersive interaction.
205+ </Tabs.Tab >
206+
208207 <Tabs.Tab >
209- ** Proximity** - Zerio proximity prompts
210-
211- ```lua
212- Config.HelpTextType = "proximity"
213- ```
214-
215- Requires ` zerio-proximityprompt ` resource for enhanced proximity interactions.
208+ ** Proximity** - Zerio proximity prompts ```lua Config.HelpTextType =
209+ "proximity" ``` Requires ` zerio-proximityprompt ` resource for enhanced
210+ proximity interactions.
216211 </Tabs.Tab >
217212</Tabs >
218213
@@ -223,6 +218,7 @@ Config.TargetScript = "ox_target"
223218```
224219
225220** Supported Scripts:**
221+
226222- ` ox_target ` - Overextended target
227223- ` qb-target ` - QBCore target
228224- ` qtarget ` - Standalone qtarget
@@ -289,21 +285,25 @@ Config.ActivityRetentionDays = 30 -- How many days to keep activity logs
289285### Common Problems
290286
291287** Menu Not Opening:**
288+
2922891 . Check ` Config.HelpTextType ` matches your setup
2932902 . Verify ` Config.TargetScript ` if using target mode
2942913 . Ensure boss menu positions are created via admin menu
295292
296293** Framework Integration Issues:**
294+
2972951 . Verify ` Config.Framework ` detection
2982962 . Check ` Config.FrameworkResourceName ` matches your setup
2992973 . Ensure proper load order in server.cfg
300298
301299** Banking Problems:**
300+
3023011 . Confirm ` Config.ManagementScript ` matches your banking system
3033022 . Verify banking integration in ` server/functions.lua `
3043033 . Check society/gang accounts exist
305304
306305** Permission Issues:**
306+
3073071 . Review admin permissions configuration
3083082 . Verify job grades have proper access
3093093 . Check framework permission system integration
@@ -318,15 +318,17 @@ After configuration changes:
3183184 . ** Review Logs** : Check for any warning messages
319319
320320<Callout type = " info" >
321- ** Configuration Templates** : Example configurations for common setups are available in our Discord community.
321+ ** Configuration Templates** : Example configurations for common setups are
322+ available in our Discord community.
322323</Callout >
323324
324325## Next Steps
325326
326327After completing configuration:
328+
3273291 . Set up boss menu positions using the admin command
3283302 . Configure job-specific vehicle and item catalogs
3293313 . Test employee management features
3303324 . Review and adjust permissions as needed
331333
332- For advanced customization options, see the [ Developer Documentation] ( /bossmenu/devdocs ) section.
334+ For advanced customization options, see the [ Developer Documentation] ( /bossmenu/devdocs ) section.
0 commit comments