Skip to content
Blixt

Install

This guide walks through a fresh Blixt install on a FiveM server.

Blixt is distributed as separate resources so you can install only what you need.

ResourceFolder nameStatusPricingNotes
Blixt PhoneblixtAvailable$49 USD, one-timeRequired core resource
Blixt Map Tilesblixt-map-tilesAvailableFreeRequired for the Maps app to render. Static tile assets served to the in-phone Maps surface via cfx-nui-blixt-map-tiles/.... Without it the Maps area is blank.
Blixt Tabletblixt-tabletAvailableFreeDepends on blixt
Blixt Businessblixt-businessCOMING SOON—Depends on blixt
Blixt Racingblixt-racingCOMING SOON—Standalone resource with Blixt integration

Install the phone first, then map tiles. Tablet, Business, Racing, and external apps either depend on blixt directly or integrate with it when Blixt device surfaces are enabled.

Blixt Phone is a complete phone resource. It is not an LB Phone plugin. For a production server, use one full phone resource for the same player phone experience.

1. Prerequisites

Section titled “1. Prerequisites”
  • FXServer on a current recommended build.
  • A supported framework: qbox, qbcore, esx, or standalone.
  • MariaDB or MySQL 8+ reachable from the FXServer host.
  • oxmysql loaded before Blixt.
  • screenshot-basic for camera and photo capture.
  • pma-voice for in-game calls and mute behaviour.

Racing preview/release builds are expected to require oxmysql. Business and Tablet depend on the core blixt resource.

2. Download and extract

Section titled “2. Download and extract”

Available resources are downloaded from Tebex. Coming soon resources are listed here so you can plan the folder names and install order, but they are not public purchases until release.

Extract resources into your FXServer resources tree:

resources/
└── [blixt]/
    ├── blixt/            # phone, available, $49
    ├── blixt-map-tiles/  # map tiles, available, free — required for Maps app
    ├── blixt-tablet/     # tablet, available, free
    ├── blixt-business/   # business, coming soon
    └── blixt-racing/     # racing, coming soon

The inner folder names matter. Do not rename blixt, blixt-map-tiles, blixt-tablet, blixt-business, or blixt-racing.

3. server.cfg

Section titled “3. server.cfg”

Set the database, framework, and Blixt convars before starting Blixt resources.

# Database, used by oxmysql and Blixt
set mysql_connection_string "mysql://user:password@127.0.0.1:3306/blixt"


# Framework selection
set blixt:framework "auto"   # auto | qbox | qbcore | esx | standalone


# Anonymous boot ping. See /privacy
set blixt:telemetry "true"


# Required dependencies
ensure oxmysql
ensure screenshot-basic
ensure pma-voice


# Blixt core
ensure blixt


# Map tiles — required for the Maps app to render.
# Skip this and the Maps surface will show a blank canvas.
ensure blixt-map-tiles


# Optional available companion
ensure blixt-tablet

Order matters: oxmysql must start before blixt; blixt-map-tiles can start before or after blixt (no script dependency, just static assets); and blixt must start before blixt-tablet.

4. Coming soon resources

Section titled “4. Coming soon resources”

Business and Racing are not public purchases yet. These notes are for release/preview builds only.

# Only add released or preview resources you intentionally trust.
set blixt:trusted_resources "blixt-business,blixt-racing"


ensure blixt-business
ensure blixt-racing

blixt:trusted_resources is a comma-separated allowlist for resources that can call privileged Blixt server exports. Do not add random resources to this list.

Business is expected to depend on blixt. Racing is expected to be a standalone blixt-racing resource with oxmysql, and to use Blixt integration when blixt is installed and the resource is trusted.

5. Database

Section titled “5. Database”

There is no manual migration command for Blixt Phone. On first boot, blixt connects using mysql_connection_string, runs pending migrations, and logs the result.

[@blixt/database] Connected to database
[@blixt/database] Ran N migrations: [ ... ]

If migrations fail, the resource will not finish starting. Fix the connection string or database permissions, then restart blixt.

The database user needs CREATE, ALTER, DROP, INDEX, plus the normal SELECT, INSERT, UPDATE, and DELETE permissions.

6. Configure Blixt

Section titled “6. Configure Blixt”

Blixt ships with blixt/config.json. The defaults boot a working phone; edit the file when you want server-specific branding or app behaviour.

Common fields:

  • phone.branding.deviceName and tablet.branding.deviceName.
  • phone.disabledApps and tablet.disabledApps.
  • phone.wallpapers.
  • phone.featuredApps and tablet.featuredApps.
  • tablet.toggleKey.

See Configuration for the full config reference.

Back up config.json before extracting a new release zip. See Upgrading for the update flow.

Section titled “7. Camera, gallery, and voice memo storage”

The camera uses screenshot-basic. Photos and voice memos then use the storage backend you configure.

Image storage supports:

  • Cloudflare R2
  • Generic S3-compatible storage
  • Fivemanage
  • Discord webhook

Voice memo storage supports:

  • Cloudflare R2
  • Generic S3-compatible storage
  • Fivemanage

See Convars for every storage convar.

8. Smoke test

Section titled “8. Smoke test”

Start the server. In console you should see:

[@blixt/database] Connected to database
[@blixt/database] Ran N migrations: [ ... ]
[blixt] Loaded config.json
[blixt] Framework: <auto|qbox|qbcore|esx|standalone>

Join the server and run /phone or press the configured phone key. For the tablet, run /tablet or bind it under FiveM Settings > Key Bindings > Blixt > Toggle Tablet.

If the phone never opens, re-read the FXServer console for an error from blixt, oxmysql, screenshot-basic, or your framework. See Troubleshooting.

Section titled “What to read next”