Quick Start Guide

Get Mythic Framework up and running in 5 minutes

This quick start guide will help you get Mythic Framework installed and running as quickly as possible. For detailed explanations, see the full installation guide.

This guide assumes you have basic familiarity with FiveM server setup and database administration. If you’re new to FiveM, please follow the detailed installation guide instead.

Prerequisites Checklist

Before starting, ensure you have:

1. FiveM Server License

   A valid FiveM server license key from keymaster.fivem.net

2. MongoDB Installed

   MongoDB 3.6.6 or higher installed and running

3. MySQL Installed

   MySQL 5.7+ or MariaDB 10.2+ installed and running

4. System Requirements

   • OS: Windows or Linux
   • RAM: 4GB minimum (8GB+ recommended)
   • Storage: 10GB free space
   • CPU: 2+ cores recommended

Installation Steps

1. Download FiveM Server

Download the latest FiveM server artifacts for your platform:

Windows

# Download latest Windows server build
# Visit https://runtime.fivem.net/artifacts/fivem/build_server_windows/master/

2. Extract Mythic Framework

Extract the Mythic Framework files to your server directory:

MythicServer/
├── cache/
├── configs/
│   └── resources.cfg
├── resources/
│   ├── [cfx-default]/
│   └── [mythic]/
├── server.cfg
└── logo96.png

3. Configure Databases

MongoDB Setup

Create the required databases in MongoDB:

# Connect to MongoDB
mongo

# Create auth database
use auth

# Create game database
use fivem

MySQL Setup

Create the MySQL database:

CREATE DATABASE MythicFramework_345AE9 CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;

4. Configure server.cfg

Edit server.cfg and update the critical settings:

server.cfg

# Your FiveM license key
sv_licenseKey "YOUR_LICENSE_KEY_HERE"

# Steam Web API Key (get from https://steamcommunity.com/dev/apikey)
set steam_webApiKey "YOUR_STEAM_API_KEY_HERE"

# MongoDB Connections
set mongodb_auth_url "mongodb://localhost:27017/?readPreference=primary&appname=MongoDB%20Compass&ssl=false"
set mongodb_auth_database "auth"
set mongodb_game_url "mongodb://localhost:27017/?readPreference=primary&appname=MongoDB%20Compass&ssl=false"
set mongodb_game_database "fivem"

# MySQL Connection
set mysql_connection_string "mysql://root:YOUR_PASSWORD@localhost/MythicFramework_345AE9?charset=utf8mb4"

# Server Settings
sv_hostname "Your Mythic Server"
sv_maxclients 48

# Environment (dev/prod/test)
set sv_environment dev

Important: Replace YOUR_LICENSE_KEY_HERE, YOUR_STEAM_API_KEY_HERE, and YOUR_PASSWORD with your actual credentials.

5. Set Admin Permissions

Add yourself as an admin by adding your identifiers to server.cfg:

server.cfg

# Find your FiveM identifier by joining the server and checking console
# Then add it to server.cfg:

add_principal identifier.fivem:YOUR_FIVEM_ID group.admin
add_principal identifier.discord:YOUR_DISCORD_ID group.admin

To find your identifiers, join the server and type status in the F8 console. Look for your identifiers in the output.

6. Start the Server

Start your FiveM server:

Windows

run.cmd
# or
FXServer.exe +exec server.cfg

7. Verify Installation

Watch the console output for successful startup:

1. Database Connections

   Look for successful MongoDB and MySQL connection messages

2. Resources Loading

   All Mythic resources should load without errors (60+ resources)

3. Server Ready

   Console should show “Server started” or similar message

8. Connect to Your Server

1. Open FiveM client
2. Press F8 to open console
3. Type: connect localhost:30120 (or your server IP)
4. Create your first character

Default port is 30120. If you changed it in server.cfg, use that port instead.

First Login

Once connected, you should see:

1. Loading Screen

   Mythic Framework custom loading screen with logo

2. Character Creation

   Character creation interface will appear

3. Spawn In

   After creating a character, you’ll spawn in Los Santos

4. Tutorial

   Follow the on-screen prompts to learn basic controls

Verification Checklist

Verify everything is working:

✅ Database Connections

Check console for:

[mythic-base] MongoDB Connected
[oxmysql] MySQL Connected

✅ All Resources Loaded

Verify all Mythic resources started successfully (check for no errors in console)

✅ Character System

You can create and save a character

✅ HUD Visible

Health/armor bars and UI elements are visible

✅ Inventory Works

Press I or configured key to open inventory

✅ Admin Access

Type /admin to verify you have admin permissions

Common Issues

Server won't start

Solution: Check that you have a valid license key and all paths in server.cfg are correct.

Database connection failed

Solution:

• Verify MongoDB and MySQL are running
• Check connection strings in server.cfg
• Ensure databases exist
• Check firewall isn’t blocking connections

Resources failing to load

Solution:

• Check configs/resources.cfg for proper load order
• Verify all resource folders exist
• Check console for specific error messages

Can't connect to server

Solution:

• Verify server is running (check console)
• Check firewall allows port 30120 (or your custom port)
• Try connect 127.0.0.1:30120 if localhost doesn’t work

No admin permissions

Solution:

• Verify you added your correct identifiers to server.cfg
• Restart server after adding permissions
• Check console for “principal” related errors

For more detailed troubleshooting, see the Troubleshooting Guide.

Next Steps

Now that your server is running, explore the framework:

Learn Core Concepts

Understand how Mythic Framework works under the hood

Configure Features

Customize server settings and features

Add Custom Items

Learn how to add items to the inventory system

Create Custom Jobs

Set up custom jobs for your server

Development Quick Start

If you’re a developer looking to create custom resources:

1. Set up your development environment

   Install VSCode with Lua and React extensions

2. Read the architecture docs

   Understand the component proxy system

3. Check out the API reference

   Browse the Core API documentation

4. Create your first resource

   Follow the First Resource guide

Pro Tip: Enable set sv_environment dev in server.cfg for development. This provides more detailed logging and disables certain production optimizations.

Get Help

If you run into issues:

• Check the FAQ for common questions
• Read the detailed installation guide
• Join our Discord community
• Search the documentation using the search bar above

Remember: Mythic Framework is designed for experienced developers. If you’re new to FiveM development, take time to learn the Core Concepts before diving into customization.