For the complete documentation index, see llms.txt. This page is also available as Markdown.

Installation

1

Install the Dependencies

Make sure everything on the Dependencies page is installed and starting before this resource.

2

Add the Resource

Download the package from Portal, unzip it, and put the folder in your server's resources directory:

  • rm_mapeditor

3

Start It

Add it to your server.cfg, below oxmysql:

ensure oxmysql

ensure rm_mapeditor
4

Grant Access

Nobody can open the editor until they are allowed to. Two tiers, and the broad command ace counts as both:

# a builder: their own layouts, and nothing of anybody else's
add_ace group.builder command.map_editor allow

# every layout, and the switch that stands one up for the whole server
add_ace group.admin rm_mapeditor.admin allow

Or by identifier, for one or two people without touching aces, in cfg.lua:

cfg.authorizedIdentifiers = {
    ['license:110000112a4b6c8'] = true,
}

Both ace names are settings, not fixed strings. See Configuration.

5

Database

Nothing to run. The rm_mapeditor_layouts table is created on the first save, and only if the layout library is switched on.

6

Try It

In game:

/map_editor

The layout browser opens. New layout drops you into the editor with a free camera and the prop picker along the bottom.

/prop_inspect

The same session with nothing to place: click anything in the world to read what it is.

About the Prop Pictures

The picker draws around 30000 thumbnails, packed into sprite sheets. They are not downloaded when a player joins: they arrive the first time somebody opens the picker (about 80 MB) and are cached by hash from then on, so it is one wait, once, per version.

If you would rather serve them yourself, point cfg.nui.imageBaseUrl at a host you control and copy assets/props/ across. Details in Configuration.