Installation Guide
Follow this comprehensive guide to properly install and configure Zerio Bossmenu on your FiveM server.
Before You Begin: Ensure you have a compatible framework (ESX, QBCore, or QBXCore) and database system (oxmysql) installed.
Prerequisites
Before installing Zerio Bossmenu, verify you have the following:
- Framework: ESX, QBCore, or QBXCore
- Database: oxmysql
- Server Access: Some kind of access to your server files
- Database Access: MySQL/MariaDB database
Installation Steps
Step 1: Download and Extract
- Download the
zerio-bossmenu
resource from the fivem portal - Extract the resource to your server’s
resources
folder - Ensure the folder is named
zerio-bossmenu
Step 2: Database Setup
Execute the SQL files in your database in the following order:
- Main Tables: Import
sql/main.sql
- Creates all necessary tables
Step 3: Server Configuration
Add the resource to your server.cfg
:
ensure zerio-bossmenu
Load Order: Ensure zerio-bossmenu
is loaded after your framework
(ESX/QBCore) and database resource (oxmysql/etc).
Step 4: Configuration
Configure the resource by editing the files in the configs/
folder:
Step 5: First Start/Use
- Restart Your Server: Fully restart your server to load all changes
- Create Bossmenu Position: Use the admin menu to create your first boss menu position
- Test Basic Functionality: Hire an employee and test basic menu functions
Post-Installation
Admin Command
The admin command is configurable in configs/adminmenu.lua
. By default, it’s typically /bossmenuadmin
(exact command may vary based on configuration).
Use this command to:
- Create boss menu positions
- Manage 3D models
- Configure job-specific settings
- Set up vehicle and item catalogs
Permissions
Configure admin permissions in your framework’s permission system.
Testing
- Basic Functionality: Test hiring/firing employees
- Financial Operations: Test withdrawing/depositing money
- Vehicle System: Test vehicle ordering (if configured)
- Item System: Test item ordering (if configured)
Troubleshooting
Common Issues
Resource Not Starting:
- Check console for errors
- Verify all SQL tables were created
- Ensure proper load order in server.cfg
Menu Not Opening:
- Check if boss menu positions are created
- Verify player has appropriate job/permissions
- Check interaction type configuration
Database Errors:
- Verify SQL files were imported correctly
- Check database permissions
- Ensure oxmysql/database resource is working
Framework Integration Issues:
- Double-check integration code placement
- Verify backup folders have write permissions
- Restart server after framework modifications
Need Help? Join our Discord community for support or check our comprehensive FAQ section.
Next Steps
After successful installation:
- Read the Configuration Guide for detailed customization options
- Check the FAQ for common setup questions
- Review the Developer Documentation if you plan to integrate with other resources