Skip to content

Installing RedM Map Editor ​

Requirements ​

Required
RedM serverYesAny build supporting fx_version 'cerulean' and lua54 'yes'
oxmysqlYesStarted before this resource
MySQL / MariaDBYesFive tables, created on first start
FrameworkNoACE works on any server; VORP groups are supported if you have one

There is no SQL to import and no build step.

Install ​

  1. Unzip so the folder is named exactly rm_mapeditor, inside your resources folder.

  2. Add three lines to server.cfg:

    cfg
    ensure oxmysql
    ensure rm_mapeditor
    add_ace group.admin rm_mapeditor.use allow

    oxmysql must come first — the editor reads and writes its maps through it from the moment it starts.

  3. Restart, then type /mapeditor in game.

/mapedit and /medit do the same thing.

Without a permission grant the command does nothing

The default mode is 'both', meaning an ACE or a VORP group will pass. If you grant neither, /mapeditor is silently refused — which looks exactly like the resource not loading.

See Permissions for the four modes and the six separate grants.

The database ​

Nothing to do. Five tables are created on first start if they are missing:

TableHolds
rm_mapeditor_mapsMaps — name, centre, radius, enabled, permanent or temporary
rm_mapeditor_objectsEvery placed object
rm_mapeditor_removedGame world props you removed for everyone
rm_mapeditor_unavailableModels the server could not resolve
rm_mapeditor_auditWho did what, kept 45 days by default

Every map records who created and last updated it, and when.

First open ​

Type /mapeditor. You should get the editor interface and a flying camera.

CheckExpected
Resource startedNo red errors for rm_mapeditor in the server console
Tables createdNo oxmysql errors naming rm_mapeditor_*
Command works/mapeditor opens the editor
Catalogue loadsThe Props panel fills with categories
Placing worksPick a prop, left-click to place it
It persistsClose, /mapeditor again — the prop is still there

If the catalogue is there but every thumbnail is blank, that is the preview images failing to reach GitHub — see below. The editor itself is unaffected.

Verify it properly ​

/rm_diag

Runs the editor's own diagnostics and prints what it finds. /rm_diag keys additionally shows what every key binding resolved to, which is the fastest way to find a binding that collided with something else.

On the server console:

rm_mapeditor_diag
rm_mapeditor_stats

The first runs server-side diagnostics; the second prints how many maps, objects and open sessions you have.

Prop thumbnails come from the internet ​

The catalogue ships the 17,473 model names, but not their preview images. Those are fetched from GitHub at runtime.

This is not a fault to chase

On a server with no outbound access the thumbnail grid is blank and everything else works — names, search, categories and the live in-world preview before you place. If you want images, the server's clients need to reach raw.githubusercontent.com.

Custom props ​

Stream your own props from their own resource, then list them so they appear in the catalogue:

lua
-- config.lua
Config.CustomProps = {
    { model = 'my_prop', label = 'My Prop', category = 'Custom', sub = 'Buildings' },
}

Start the prop's resource before rm_mapeditor

A model that is not streamed yet cannot be previewed or placed, and the editor will list it as unavailable.

Turning features off ​

Every major feature has a switch in Config.Features. Set one to false and it disappears from the interface:

lua
Config.Features = {
    removeWorldProps = false,   -- no one can delete the game's own props
    doors            = false,   -- no door tooling
    brush            = false,   -- no Brush or Scatter
}

The full list is in Configuration.

Common install mistakes ​

MistakeSymptomFix
No permission granted/mapeditor does nothingadd_ace group.admin rm_mapeditor.use allow
oxmysql after the editorErrors on start, no mapsPut ensure oxmysql above it
Folder renamedExports break for other resourcesRename back to rm_mapeditor
Custom prop resource starts lateYour models show as unavailableStart it before rm_mapeditor
Expecting FiveMNothing worksRedM only

Next ​

Documentation for RedMorrow. Scripts are licensed per server — redistribution is not permitted.