Installation Guide
Step-by-step guide to install and configure UZ Multicharacter on your FiveM server.
Welcome to the UZ Multicharacter installation guide! This comprehensive tutorial will help you install and configure the multicharacter system for your FiveM server.
Before You Begin: Make sure you have purchased the resource from our official store and have access to your Keymaster account.
Prerequisites
- FiveM server with admin access
- Basic knowledge of server file management
- FTP client or server file manager access
- Text editor for configuration files
- Active Keymaster account with purchased resource
ESX, QBCore, QBX — all fully supported with auto-detection.
Prop
Type
Step 1: Download from Keymaster
Access Your Purchase
- Navigate to Keymaster Assets
- Log in with your CFX.re account credentials
- Search for "uz_Multicharacter" in your granted assets
Download the Files
- Click the Download button next to the resource
- The download will start as a
.zipfile - Extract the contents to a temporary folder
Important: Always download the latest version to ensure compatibility and security updates.
Step 2: Server File Management
Access Your Server
Choose your preferred method: FTP Client (FileZilla, WinSCP), Server Panel (hosting file manager), or Direct Access (SSH).
Upload the Resource
Navigate to your server's resources folder, create a [UZ] subfolder, and upload the extracted resource.
Step 3: Server Configuration
3.1 Update server.cfg
Open your server.cfg file and add the following:
# Core Dependencies (Add these first)
ensure oxmysql
ensure [your_framework] # esx/qbcore/qbx
ensure uz_core
# UZ Scripts (Add at the bottom)
ensure uz_MulticharacterCritical: Always place ensure uz_Multicharacter at the very bottom of your startup order to prevent loading conflicts.
3.2 Verify Load Order
Your startup order should look like this:
# 1. Database
ensure oxmysql
# 2. Framework
ensure es_extended # or qb-core/qbx_core
# 3. Core Dependencies
ensure uz_core
# 4. Other resources...
ensure other-resources
# 5. UZ Scripts (LAST)
ensure uz_MulticharacterStep 4: Resource Configuration
- Navigate to
uz_Multicharacter/Customize.lua - Open the file in your text editor
- Configure the settings according to your preferences
Step 5: Framework Integration
QBX Users: Follow these specific configuration steps.
- Open
qbx_core/shared/config/client.lua - Find the multicharacter section
- Update the configuration:
-- Multicharacter Settings
useExternalCharacters = true,
startingApartment = false, -- Disable default apartments
enableCharacterCreator = false, -- Use UZ system- Save and close the file
ESX Users: Simple one-line configuration required.
- Open
es_extended/shared/config/main.lua - Find or add the multichar configuration:
-- Multicharacter Integration
Config.Multichar = GetResourceState("uz_Multicharacter") ~= "missing"
Config.StartingAccountMoney = {bank = 50000} -- Optional: Starting money- Save the file
QBCore Users: No additional configuration needed! The resource works out of the box.
Step 6: Database Setup
Automatic Setup
The resource includes automatic database setup. When you first start the server:
- Tables will be created automatically
- Default configurations will be applied
- Check your server console for confirmation
Manual Setup (If Needed)
If automatic setup fails, manually run:
CREATE TABLE IF NOT EXISTS `uz_multichar` (
`owner` varchar(65) DEFAULT NULL,
`maxchar` int(11) DEFAULT 1,
UNIQUE KEY `owner` (`owner`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_general_ci;
CREATE TABLE IF NOT EXISTS `uz_multichar_tebex` (
`tebex` varchar(255) DEFAULT NULL
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_general_ci;Step 7: Server Restart & Testing
Restart Your Server
- Stop your FiveM server completely
- Wait 10-15 seconds for full shutdown
- Start the server again
- Monitor the console for any errors
In-Game Testing
- Connect to your server
- You should see the multicharacter selection screen
- Test creating a new character
- Test switching between characters
- Verify all features work as expected
Troubleshooting
Support & Updates
Need Help? Contact our support team through support tickets, Discord community, or email support.
Stay Updated: Check Keymaster regularly for updates. Always backup your server before updating. Read changelogs for breaking changes.
Success! Your players can now enjoy a seamless multicharacter experience on your FiveM server!