Database Setup
Before installing Azure Framework, you need to prepare your database. Don't worry - we'll guide you through it!
What You Need
You'll need to gather this information before continuing:
- Database host (usually localhost if it's on your server)
- Database name (like fivem_azure)
- Database username
- Database password
- Port number (usually 3306)
How to Create a Database
If you don't have a database yet, here's what to do:
- Contact your server provider and ask for a MySQL database
- Use a free online database service if you don't have one
- Ask a tech-savvy friend to help set one up for you
Tip: Many FiveM server providers include a database with your server. Check your control panel!
Install ox_lib
ox_lib is a helper tool that Azure Framework needs to work properly. Let's install it!
Download Instructions
Follow these simple steps:
- Click the download link below
- Click the green "Code" button
- Select "Download ZIP"
- Save the file to your computer
Download ox_lib from GitHub
Installation Steps
Now let's add it to your server:
- Unzip the downloaded file
- Copy the folder named "ox_lib"
- Paste it into your server's "resources" folder
- That's it! We'll activate it later
Install oxmysql
oxmysql connects your server to your database. Let's get it set up!
Download Instructions
Same process as before:
- Click the download link below
- Click the green "Code" button
- Select "Download ZIP"
- Save the file to your computer
Download oxmysql from GitHub
Installation Steps
Add it to your server:
- Unzip the downloaded file
- Copy the folder named "oxmysql"
- Paste it into your server's "resources" folder
Connect to Your Database
We'll use the information from Step 1:
- Open the oxmysql folder you just added
- Find the file named "config.lua"
- Open it with any text editor (like Notepad)
- Find the connection string near the top
set('mysql_connection_string', 'mysql://USERNAME:PASSWORD@HOST:PORT/DATABASE')
Replace the highlighted parts with your database information
Install Azure Framework
Now we'll install the actual Azure Framework files. Almost there!
Organize Your Files
Let's put everything in the right place:
- Create a new folder inside "resources" called "framework"
- Unzip the Azure Framework files you downloaded
- Place them inside the "framework" folder like this:
resources/
└── [framework]/
├── Az-Framework/
├── Az-Banking/
└── Az-Admin/
Configure Server
Let's set up your server.cfg to load resources in the right order,
and securely wire in your Discord credentials.
Place Resources
- Put Az-Framework directly into
resources/
- Put all other Azure scripts (e.g. Az-Banking, Az-Admin) into
resources/[framework]/
server.cfg Settings
Open your server.cfg and add in this exact order:
set mysql_connection_string "mysql://USERNAME:PASSWORD@HOST:PORT/DATABASE"
start oxmysql
start ox_lib
start Az-Framework
start [framework]
- Always start
oxmysql before ox_lib
- Always start
ox_lib before any Azure Framework scripts
Secure Discord Credentials
Still in server.cfg, add your Discord convars (keep these out of version control!):
set DISCORD_BOT_TOKEN "your_bot_token"
set DISCORD_WEBHOOK_URL "your_webhook_url"
set DISCORD_GUILD_ID "your_guild_id"
Launch
Save and close server.cfg, then start your FXServer. All database tables will auto-generate, and your HUD, economy, and admin systems will be ready.
First Launch
Start your server for the first time to create database tables.
Launch Server
- Run your FiveM server
- Watch console for success messages
- Fix any errors (check credentials)
In-Game Test
Verify framework features in-game.
Character Command
- Join your server
- Type
/char
- Create a character and check database
Final Setup
Configure final framework settings like Discord integration.
Discord Webhooks
Edit server.lua in Az-Framework:
Config.DiscordBotToken = 'YOUR_BOT_TOKEN'
Config.LogWebhook = 'https://discord.com/api/webhooks/...'
Config.ReportWebhook = 'https://discord.com/api/webhooks/...'