Documentation
Everything you need to get Quasar Tutorial Creator running: one ensure line, one SQL file, and your first cinematic.
Quasar Tutorial Creator has almost no requirements. No ox_lib and no framework are needed to play a tutorial — the bundled tutorials are compiled into the page, so the overlay draws correctly before the client has even spoken to the server.
Requirement | Status | Notes |
|---|---|---|
| Required | Either one — |
'auto'MySQL database | Required | Holds your tutorials and player progress |
Framework | Optional | qs-core, ESX, QBX or QB-Core — also runs standalone |
| Not needed | — |
The framework is only ever asked two things: who the player is, and whether somebody may open the creator.
Without a SQL driver the tutorial still plays, because the bundled ones are compiled into the page — but nothing can be stored, and everybody watches it again on every spawn.
Quasar Tutorial Creator is linked to your CFX Portal account.
Sign in to the CFX Portal using the same account used during checkout, then open Granted Assets and locate Tutorial Creator in your asset library. Download the latest version and extract the archive.
After extracting the download, you should have the following folder:
qs-tutorialNever rename the resource folder. It must remain qs-tutorial — your media is served from cfx-nui-qs-tutorial/.
Local media is stored as a relative path and resolved at render time, so renaming the resource does not break every reference in your database — but the folder name still has to match for the files to be served at all.
Move the qs-tutorial folder into your server's resources directory. Although the resource can be placed anywhere inside the folder, keeping Quasar resources organized inside their own directory is recommended.
A typical installation looks like this:
resources/
└── [quasar]/
└── qs-tutorial/Then add it to your server.cfg:
ensure qs-tutorialThat is the whole install. The resource has no hard dependencies, so there is no loading order to respect — although your framework and your SQL driver should start before it so the adapter resolves on the first try.
Detection is retried. If
Config.Frameworkis'auto'and nothing was running when the resource started, the adapter is re-resolved once the session is up and swapped in.
Quasar Tutorial Creator uses MySQL, and only MySQL.
Open your preferred database manager (such as phpMyAdmin, HeidiSQL, DBeaver, or Navicat), select your server's database, and execute database/sql.sql. It is plain SQL with nothing else in it, so it pastes straight into HeidiSQL.
It creates three tables:
Table | Holds |
|---|---|
| The tutorials you build |
| The live tutorial id |
| Who has already watched it, per character |
Importing is belt and braces, not a prerequisite. The resource issues the same
CREATE TABLE IF NOT EXISTSstatements on boot.
The bundled tutorials are not in the database. They ship inside the UI bundle, which is also why there is nothing to seed — the only row the file inserts is active = 'welcome'. The tables hold what you make in the creator.
Either of these works, and both are in shared/config.lua:
The ACE command.tutorialcreator
A framework group listed in Config.Creator.adminGroups
add_ace group.admin command.tutorialcreator allowThe group check goes through custom/, so it works on whatever framework you run and can be changed without touching the resource. With no framework at all, ACE permissions are the whole story.
After completing the installation, restart your FiveM server.
Join your server and run:
/tutorialIf the cinematic plays — the screen fades, the camera flies and the narration appears — the install is done.
Then, with an administrator account:
/tutorialcreatorIf the editor opens, Quasar Tutorial Creator has been installed correctly. Pick a tutorial, change it, Save, then Set live — every player gets it immediately, and nobody reconnects.
The Player Commands
Command | What it does |
|---|---|
| Plays the live tutorial, ignoring whether you have seen it |
| Forgets what you have watched, so the next spawn replays it |
| Opens the editor |