Documentation
Everything you need to set up and manage your FiveM server
Getting Started
1 Download and Install
Download CrystalFive Host from the download page and run the installer. Allow administrator access when prompted.
Note: You may see a Windows SmartScreen warning. Click "More info" then "Run anyway" to continue.
2 Sign In
Open the app and sign in with your Discord or Google account. This creates your CrystalFive account automatically.
3 Configure Your Server
Point the app to your FiveM server files directory. The app will detect your server configuration automatically.
- • Use txAdmin recipes for quick setup
- • Or use your existing server files
4 Start the Server
Click "Start Server" to launch your FiveM server and connect to the relay. Share the connection link with your friends.
Example connection link:
cfx.re/join/abc123 Database Setup
CrystalFive Host includes a local MariaDB database, pre-configured for ESX, QBCore, and other popular frameworks.
Connection Details
Using with ESX/QBCore
Update your server.cfg with the connection string:
set mysql_connection_string "mysql://root:PASSWORD@localhost:3306/fivem" Replace PASSWORD with the password shown in the CrystalFive app.
Discord Bot
CrystalFive Host includes a built-in Discord bot that runs directly from the desktop app. All data stays on your machine — your token is encrypted and never leaves your PC.
Setup
- 1. Go to Discord Developer Portal and create a new application
- 2. Under the Bot section, click "Reset Token" and copy it
- 3. Enable Server Members Intent and Message Content Intent in the bot settings
- 4. In CrystalFive Host, go to the Discord Bot tab, enter your Application ID, Bot Token, and Guild ID
- 5. Click the generated invite link to add the bot to your Discord server
- 6. Click Start Bot — slash commands register automatically
Feature Tiers
Features are unlocked based on your subscription tier:
/status ·
/players ·
/faq (3 entries)
Everything in Trial, plus:
/kick ·
/ban ·
/warn ·
/whitelist ·
/announce ·
Welcome messages · Logs channel · Role-job mapping & sync
Everything in Starter, plus:
/quiz (10 questions) ·
/ticket ·
/template ·
FAQ (10 entries)
Everything in Plus, plus: Custom quiz questions · Quiz (25 questions) · Unlimited FAQ entries
Commands
/status Trial+
Shows a live server status embed with online/offline state, player count, and uptime.
/players Trial+
Lists currently connected players with a visual capacity bar. Pulls live data from txAdmin.
/kick /ban /warn Starter+
Moderate players directly from Discord. Kicks, bans (with duration: 1h to permanent), and warnings. All actions are logged to your logs channel.
/announce Starter+
Broadcast messages to all in-game players and to your Discord announcement channel. Types: General, Warning, Emergency, Info.
/whitelist Starter+
Manage server access. Subcommands: add, remove, approve, deny, check, list, request (player self-service).
/faq Trial+
Manage FAQ entries with keyword triggers. The bot auto-replies when players ask questions in your FAQ channel using fuzzy Arabic text matching.
/quiz Plus+
Quiz-based whitelist system. Players take a quiz on your server rules; passing auto-whitelists them and grants a Discord role. Configurable pass threshold, attempt limits, cooldown, and time per question. Arabic preset questions included.
/ticket Plus+
Support ticket system. Creates a "Open Ticket" button; players get private channels. Staff can close tickets with a reason. One open ticket per user.
/template Plus+
Apply pre-built Discord server structures for RP communities. Creates roles, categories, and channels with proper permissions. Available in Arabic and English. Templates: Basic RP, Advanced RP, Minimal RP.
Whitelist Modes
Configure how players gain access to your server (Starter+ required):
/whitelist approve Channel Configuration
Assign Discord channels for each feature in the Channels tab:
Status Channel
Auto-updating server status
Announcement Channel
Server broadcasts & alerts
Welcome Channel
New member greetings
Logs Channel
Moderation action logs
FAQ Channel
Auto-replies to questions
Quiz Channel
Whitelist quiz submissions
Role-Job Mapping
Automatically sync Discord roles with in-game FiveM jobs. The system auto-detects your framework (ESX/QBCore) and reads available jobs directly from your running server.
How it works
- 1. Go to the Role-Job Mapping section in the Discord Bot tab
- 2. Click Add Mapping — available jobs are pulled from your FiveM server automatically
- 3. Select a FiveM job — if a matching Discord role exists, it's auto-selected. If not, you'll be prompted to create one inline
- 4. Choose the minimum job grade required, then save
Two-way sync
Once mapped, roles sync both ways automatically:
- • Game → Discord: When a player gets a job in-game (e.g. hired as police), they automatically receive the corresponding Discord role
- • Game → Discord: When a player loses a job in-game (e.g. fired or job changed), the Discord role is automatically removed
Auto-detect & auto-create
- • Framework detection: Automatically detects ESX or QBCore and reads jobs from your database
- • Role auto-create: If no matching Discord role exists for a job, you can create one directly from the mapping form without leaving the app
txAdmin Integration
Connect the bot to your txAdmin panel to enable /kick, /ban, /warn, /players, and /announce. In the txAdmin tab, enter:
Credentials are encrypted with AES-256-GCM and stored locally. Use the "Test Connection" button to verify.
Troubleshooting
Server won't start
• Make sure your FiveM server files are valid
• Check that the server path is correct in settings
• Try running as administrator
• Check the logs in the app for specific errors
Players can't connect
• Verify the relay connection is active (green indicator)
• Make sure players are using the correct connection link
• Check if you've reached your player limit
• Ensure Windows Firewall allows CrystalFive
High latency/lag
• Check your internet upload speed (minimum 10 Mbps recommended)
• Close bandwidth-heavy applications
• Try using a wired connection instead of WiFi
• Reduce server resource count if CPU is maxed
Database connection issues
• Check if MariaDB is running in the app status
• Verify the connection string in server.cfg
• Make sure the password matches what's shown in the app
• Try restarting the database from the app
Still Need Help?
Join our Discord community for live support from the team and other users.
Join Discord