Before You Begin#
Before installing MLO Creator, make sure your server meets the minimum requirements. Three things are mandatory; your framework is optional and detected on its own.
Requirement | Status | Notes |
|---|---|---|
OneSync | Required | The resource refuses to start without it. |
| Required | Latest release. |
| Required | With a working MySQL or MariaDB database. |
| Optional | ESX. Detected automatically. |
| Optional | QBCore or Qbox. Detected automatically. |
Appearance script | Optional | Used to put the player's clothes back after a live build. See Integrations. |
Without ESX, QBCore or Qbox the script runs in standalone mode and uses ACE permissions to decide who is an admin. Everything else about the script works the same.
github.comox_lib — ReleasesDownload the latest release of ox_lib, a FiveM library resource required by MLO Creator.github.comoxmysql — ReleasesDownload the latest release of oxmysql, the MySQL connector required by MLO Creator.Downloading MLO Creator#
MLO Creator is delivered through the CFX Portal. Sign in with the Cfx.re account you bought the script with, open Granted Assets and download the latest version.
The download is a single [mlocreator] folder. Every piece inside it has a job:
[mlocreator]/
├── qs-mlocreator/ -- the script itself
├── qs_mlotextures/ -- texture pack used by every interior you build
├── [maps]/ -- ships empty: every map you build lands here
└── [sql]/
└── database.sql -- optional, the tables are created automatically
-- created on the first start, never part of a download:
└── qs-mlocreator-data/ -- editor base interiors and a copy of every exportDo not rename
qs-mlocreatororqs_mlotextures. The interface, the permissions and every exported interior refer to them by name.
Installing the Resource#
Drop the whole [mlocreator] folder into your resources directory, exactly as it came:
resources/
├── [ox]/
│ ├── ox_lib/
│ └── oxmysql/
├── [framework]/ -- es_extended, qb-core or qbx_core (optional)
└── [mlocreator]/
├── qs-mlocreator/
├── qs_mlotextures/
└── [maps]/Then open your server.cfg and add the permissions and the ensure line after ox_lib, oxmysql and your framework:
ensure ox_lib
ensure oxmysql
ensure es_extended # or qb-core / qbx_core, if you use one
# MLO Creator starts and stops the maps you build while the server runs.
# It needs these five permissions to do it.
add_ace resource.qs-mlocreator command.ensure allow
add_ace resource.qs-mlocreator command.start allow
add_ace resource.qs-mlocreator command.stop allow
add_ace resource.qs-mlocreator command.restart allow
add_ace resource.qs-mlocreator command.refresh allow
ensure [mlocreator]The loading order matters. ensure [mlocreator] starts the script, the texture pack and every map you have already built, so all three must come after their dependencies.
The Database#
There is nothing you have to import. On the first start the script creates its two tables on its own. The same SQL ships in [sql]/database.sql if you prefer to run it yourself with HeidiSQL or any other client.
Table | Holds |
|---|---|
| Every project from every tool: interiors, dressings, ymaps, cuts and occlusion work, with who saved it, when, and where in the world it is. |
| Every setting changed in the in-game Settings panel. Only values that differ from the defaults get a row, so a reset is simply a delete. |
Because settings and projects live in the database, updating the script never wipes your work or your tuning.
Claiming Admin Access#
Only admins can open the studio. Who counts as an admin depends on the framework the script detected:
Players in the group admin or superadmin.
-- custom/esx/server.lua
return player.getGroup() == 'admin' or player.getGroup() == 'superadmin'Players with the god or admin permission, or the ACE command.
-- custom/qb/server.lua
return QBCore.Functions.HasPermission(source, 'god')
or IsPlayerAceAllowed(source, 'command')
or QBCore.Functions.HasPermission(source, 'admin')Players with the ACE command, which the default group.admin already has:
add_principal identifier.license:YOUR_LICENSE group.admin
add_ace group.admin command allowTo use a different rule — a job, a custom permission, a list of identifiers — edit playerIsAdmin in qs-mlocreator/custom/<framework>/server.lua. Every action in every tool goes through that single function.
Configuring the Resource#
Almost nothing is configured in files. Camera, gizmo, every tool, the map resources, the build and the language all live in the in-game Settings panel (the gear in the studio header), each field with its own explanation. The few files you can touch:
File | Contents |
|---|---|
| Start-up language, framework detection and appearance script detection. |
| The furniture catalogue shown in the MLO Editor, by room category. |
| Fence families and gates for the YMAP Creator's fence tool. |
| Admin rule and skin reload per framework. |
| 41 languages. Copy |
-- config/main.lua
Config.Locale = 'en' -- language used until the database answers with the one chosen in gameEvery setting saved in game reaches all players instantly. Only the command, the open key, the cursor key and the build flush key need a
restart qs-mlocreator— the panel tells you when.
Verifying the Installation#
Start the server and watch the console. A healthy start prints the framework that was picked:
[INFO] Successfully loaded the framework. esx # or qb / standaloneIf instead you see a red block of add_ace lines repeating, one of the five permissions above is missing. Then go in game:
Open the studio
Join as an admin and type
/mlocreator. The studio opens with one card per tool.Set your language and keys
Press the gear in the header. Pick a language, and optionally a key to open the studio.
Build your first map
Follow the Where to start board in the studio, or read Usage.
Updating#
Replace qs-mlocreator and qs_mlotextures with the new version, then restart. If you edited config/, custom/ or locales/, copy your changes back afterwards.
Back up the database,
[maps]andqs-mlocreator-datatogether. Restored together, they bring back everything.