Installing RedM Map Editor
Requirements
| Required | ||
|---|---|---|
| RedM server | Yes | Any build supporting fx_version 'cerulean' and lua54 'yes' |
| oxmysql | Yes | Started before this resource |
| MySQL / MariaDB | Yes | Five tables, created on first start |
| Framework | No | ACE works on any server; VORP groups are supported if you have one |
There is no SQL to import and no build step.
Install
Unzip so the folder is named exactly
rm_mapeditor, inside yourresourcesfolder.Add three lines to
server.cfg:cfgensure oxmysql ensure rm_mapeditor add_ace group.admin rm_mapeditor.use allowoxmysql must come first — the editor reads and writes its maps through it from the moment it starts.
Restart, then type
/mapeditorin 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:
| Table | Holds |
|---|---|
rm_mapeditor_maps | Maps — name, centre, radius, enabled, permanent or temporary |
rm_mapeditor_objects | Every placed object |
rm_mapeditor_removed | Game world props you removed for everyone |
rm_mapeditor_unavailable | Models the server could not resolve |
rm_mapeditor_audit | Who 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.
| Check | Expected |
|---|---|
| Resource started | No red errors for rm_mapeditor in the server console |
| Tables created | No oxmysql errors naming rm_mapeditor_* |
| Command works | /mapeditor opens the editor |
| Catalogue loads | The Props panel fills with categories |
| Placing works | Pick a prop, left-click to place it |
| It persists | Close, /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_diagRuns 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_statsThe 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:
-- 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:
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
| Mistake | Symptom | Fix |
|---|---|---|
| No permission granted | /mapeditor does nothing | add_ace group.admin rm_mapeditor.use allow |
| oxmysql after the editor | Errors on start, no maps | Put ensure oxmysql above it |
| Folder renamed | Exports break for other resources | Rename back to rm_mapeditor |
| Custom prop resource starts late | Your models show as unavailable | Start it before rm_mapeditor |
| Expecting FiveM | Nothing works | RedM only |
Next
- Permissions — who may build, delete, export and manage maps
- Controls — every key
- Building a map — your first placement