> ## Documentation Index
> Fetch the complete documentation index at: https://mythicframework.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Prerequisites

> What you need before installing Mythic Framework

Everything you need to have ready before deploying Mythic Framework.

## System Requirements

<CardGroup cols={2}>
  <Card title="Minimum" icon="server">
    * **OS**: Windows 10/11 or Linux (Ubuntu 20.04+)
    * **RAM**: 4GB
    * **CPU**: 2 cores
    * **Storage**: 10GB free
    * **Network**: 100 Mbps upload
  </Card>

  <Card title="Recommended" icon="rocket">
    * **OS**: Windows Server 2019+ or Linux
    * **RAM**: 8GB+ (16GB for 48+ players)
    * **CPU**: 4+ cores
    * **Storage**: 20GB+ SSD
    * **Network**: 1 Gbps upload
  </Card>
</CardGroup>

## Required Software

### FiveM Server License

Get a license key from [Cfx.re Portal](https://portal.cfx.re/servers/registration-keys). Each key is tied to a specific IP — if your IP changes, generate a new one.

### MongoDB (4.4+)

Primary database for auth and game data.

<Tabs>
  <Tab title="Windows">
    1. Download from [mongodb.com/try/download/community](https://www.mongodb.com/try/download/community)
    2. Install with default settings, enable "Install as Service"
    3. Install MongoDB Compass when prompted
  </Tab>

  <Tab title="Linux">
    ```bash theme={null}
    wget -qO - https://www.mongodb.org/static/pgp/server-6.0.asc | sudo apt-key add -
    echo "deb [ arch=amd64,arm64 ] https://repo.mongodb.org/apt/ubuntu focal/mongodb-org/6.0 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-6.0.list
    sudo apt-get update
    sudo apt-get install -y mongodb-org
    sudo systemctl start mongod
    sudo systemctl enable mongod
    ```
  </Tab>

  <Tab title="Docker">
    ```bash theme={null}
    docker run -d \
      --name mythic-mongodb \
      -p 27017:27017 \
      -v mongodb_data:/data/db \
      mongo:6.0
    ```
  </Tab>
</Tabs>

### MySQL / MariaDB

For relational data and OxMySQL compatibility.

<Tabs>
  <Tab title="Windows">
    Download [MySQL Community Server](https://dev.mysql.com/downloads/mysql/) or use [XAMPP](https://www.apachefriends.org/) for an easier setup. Default port 3306.
  </Tab>

  <Tab title="Linux">
    ```bash theme={null}
    sudo apt-get install -y mariadb-server
    sudo mysql_secure_installation
    sudo systemctl start mariadb
    sudo systemctl enable mariadb
    ```
  </Tab>

  <Tab title="Docker">
    ```bash theme={null}
    docker run -d \
      --name mythic-mysql \
      -p 3306:3306 \
      -v mysql_data:/var/lib/mysql \
      -e MYSQL_ROOT_PASSWORD=your_password \
      mysql:8.0
    ```
  </Tab>
</Tabs>

### Node.js (18.x+)

Required for the JavaScript database wrapper in mythic-base.

* **Windows**: Download LTS from [nodejs.org](https://nodejs.org/)
* **Linux**: `curl -fsSL https://deb.nodesource.com/setup_18.x | sudo -E bash - && sudo apt-get install -y nodejs`

Verify: `node --version`

### Steam Web API Key

Required for Steam integration. Get one at [steamcommunity.com/dev/apikey](https://steamcommunity.com/dev/apikey).

## Ports

Open these in your firewall:

| Port  | Protocol | Purpose           |
| ----- | -------- | ----------------- |
| 30120 | TCP/UDP  | FiveM game server |
| 40120 | TCP      | txAdmin panel     |

<Warning>
  Only open MongoDB (27017) and MySQL (3306) externally if you need remote database access. Keep them local-only when possible.
</Warning>

## Out of the Box Dependencies

Mythic Framework comes pre-configured with premium maps and resources:

<CardGroup cols={3}>
  <Card title="Gabz" href="https://gabz.tebex.io/">
    Subscription (All Maps)
  </Card>

  <Card title="GN Studio" href="https://gn.studio/package/burgershot">
    Burgershot, Saloon, Mt Zonah
  </Card>

  <Card title="Dolu" href="https://dolu.tebex.io/package/5141128">
    Housing Shells
  </Card>

  <Card title="Map4All" href="https://fivem.map4all-shop.com/package/4967545">
    Noodle Exchange, Xero Gas
  </Card>

  <Card title="LB Customs" href="https://lb-customs.tebex.io/package/4339272">
    Auto Exotics
  </Card>

  <Card title="Other" href="#">
    ArtEx, Patoche, MrHunter, Junior's, Dynasty8
  </Card>
</CardGroup>

## Optional Tools

* **MongoDB Compass** — GUI for MongoDB ([download](https://www.mongodb.com/products/compass))
* **HeidiSQL** — GUI for MySQL on Windows ([download](https://www.heidisql.com/))
* **Git** — Version control ([download](https://git-scm.com/))
* **VS Code** — Code editor with Lua + React extensions ([download](https://code.visualstudio.com/))

## Next Steps

<CardGroup cols={2}>
  <Card title="Server Setup" icon="server" href="/installation/server-setup">
    Deploy Mythic Framework with txAdmin
  </Card>

  <Card title="Database Setup" icon="database" href="/installation/database-setup">
    Create databases and configure connections
  </Card>
</CardGroup>