Server Setup

Deploy Mythic Framework using the txAdmin Recipe Deployer

This guide covers deploying Mythic Framework to your FiveM server using the txAdmin Recipe Deployer — the recommended method for all users.

What is txAdmin? txAdmin is the official FiveM server management panel. It comes pre-installed with FiveM server builds and provides web-based server management, recipe deployment, and more.

Prerequisites

Before using the recipe deployer, make sure you have:

• FiveM Server — Windows or Linux (txAdmin included)
• MongoDB 4.4+ — See Database Setup
• MariaDB/MySQL 10.5+ or MySQL 8.0+ — See Database Setup
• Node.js 18.x+ — nodejs.org

Deployment

1. Start txAdmin

   Launch FXServer.exe (Windows) or ./run.sh (Linux) for the first time. txAdmin will provide a setup URL, usually http://localhost:40120.

2. Create Admin & Link License

   Open the txAdmin URL in your browser, create an admin account, and link your FiveM license key from Cfx.re Portal.

3. Deploy Recipe

   In the deployment screen:

   1. Select “Custom Recipe” or “Remote URL Template”
   2. Enter the Mythic Framework recipe URL:
      https://raw.githubusercontent.com/Mythic-Framework/txAdminRecipe/main/mythic-stable.yaml
      
   3. Click “Next” or “Deploy”
4. Enter Credentials

   The recipe will prompt you for:

   • MongoDB connection string, auth DB name, game DB name
   • MariaDB/MySQL host, port, username, password, database name
   • Server name, max players, license key, Steam Web API key

   Have your database credentials ready before starting. The recipe tests connections during setup.

5. Wait for Deployment

   The recipe will download resources, install npm dependencies, configure server.cfg, and set up the database. This takes 10-15 minutes depending on your connection.

6. Verify

   Once done, check the txAdmin dashboard shows “Server Online”, verify resources loaded in the console, and connect via FiveM.

Post-Deployment

Server Settings

Edit server.cfg in txAdmin or directly:

sv_hostname "My Mythic Server"
sv_maxclients 32

sets tags "mythic, roleplay, economy"
sets banner_detail "https://url-to-your-banner.png"
sets banner_connecting "https://url-to-your-banner.png"

# OneSync (required)
set onesync on

Database Connections

Database connections are auto-configured by the recipe. If your credentials change later, update them in server.cfg:

set mongodb_auth_url "mongodb://localhost:27017/..."
set mongodb_auth_database "auth"
set mongodb_game_url "mongodb://localhost:27017/..."
set mongodb_game_database "fivem"
set mysql_connection_string "mysql://user:pass@localhost/dbname"

Resource Load Order

Resource loading order is set in resources.cfg.

Do NOT change the load order of core Mythic resources. They depend on each other and must start in a specific sequence. mythic-base must always load first, followed by its dependencies. Changing this order will cause cascading failures across the framework.

If adding custom resources, place them after all Mythic resources in the load order.

Admin Permissions

Add yourself as admin in server.cfg:

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

Find your identifiers by joining the server and typing status in the F8 console.

Troubleshooting

Recipe URL not found

• Verify the URL: https://raw.githubusercontent.com/Mythic-Framework/txAdminRecipe/main/mythic-stable.yaml
• Check your server has internet access
• Try opening the URL in a browser

Database connection failed

• Verify database servers are running
• Check credentials are correct
• Check firewall isn’t blocking ports (27017 for MongoDB, 3306 for MySQL)
• Make sure databases exist and user has permissions

npm/pnpm errors during deployment

• Verify Node.js: node --version (18.x+)
• Check internet connection
• Try manually running npm install in UI resource directories

Resources not loading

• Check resource directories exist in resources/[mythic]/
• Verify resources.cfg was created
• Check console for specific errors
• Restart txAdmin

For more help, see the Troubleshooting Guide.

Next Steps

First Start

Connect to your server and create your first character

Configuration

Customize server settings and features