Markers

configs/map-markers.jsonc controls how the map draws the markers it shows: those created by your other resources, the player’s own marker, the destination marker, and the points of interest players place. These are fallbacks and shared behaviour. A marker that states its own icon, colour or size keeps it; the values here apply to markers that state nothing, and to the parts of a marker no resource controls.

Settings

Fallback appearance

Used for a marker whose creator did not set that property.

Key	Default	Meaning
`defaults.sprite`	`1`	The icon. `1` is the standard round marker.
`defaults.color`	`0`	The colour, as a game colour index.
`defaults.scale`	`1.25`	The size every marker is drawn at, and what a marker’s own scale is measured against: a marker that asks for `2.0` is twice this.
`defaults.font`	`1`	The font used for the marker’s label.

Pointing at a marker

Key	Default	Meaning
`hoverScale`	`1.15`	How much a marker grows while the cursor is on it. `1.15` is fifteen percent larger.

Markers outside the view

Key	Default	Meaning
`edgeIndicators`	`false`	Whether a marker off the edge of the screen is drawn as an indicator at that edge, pointing towards it.

This is the default for every marker. A marker that states its own setting keeps it, which is why the player’s own marker is always shown at the edge regardless of this value. Turning it on shows where things are while zoomed in, at the cost of a busier edge when many markers are off view.

The player’s marker

Key	Default	Meaning
`player.sprite`	`6`	The icon for the player’s own position. `6` is the standard player arrow.
`player.color`	`0`	Its colour.

This marker follows the player, is always drawn on top, cannot be clicked, and is shown at the edge of the screen when the player is off view.

Vision cones

A marker can show a cone in the direction it faces. These apply to a marker that asks for a cone without stating its own values.

Key	Default	Meaning
`cone.fov`	`90.0`	How wide the cone is, in degrees.
`cone.range`	`50.0`	How far it reaches, in metres.
`cone.color`	`11`	Its colour. A marker that carries a colour outside the game’s palette draws its cone in that colour instead, unless it names a cone colour of its own.
`cone.alpha`	`153`	How opaque it is, from `0` (invisible) to `255` (solid). Applies to every cone; a marker cannot override it.

The destination marker

Key	Default	Meaning
`waypoint.sprite`	`8`	The icon the map places where a destination is set.
`waypoint.color`	`27`	Its colour.

Points of interest

Personal markers a player places from the map. See How players use the map.

Key	Default	Meaning
`poi.sprite`	`162`	The icon.
`poi.color`	`5`	Its colour.
`poi.max`	`10`	How many a player may have at once. Placing one more moves the oldest marker.
`poi.atCursor`	`false`	Place a point under the mouse pointer. When `false`, place it at the centre of the map.

Placing a point of interest on top of an existing one removes it instead. How close counts as on top grows with altitude, so removal works at every zoom level.

Example

Larger markers, more room for points of interest and stronger cones:

{
  "namespace": "map-markers",
  "configVersion": 1,
  "scope": "client",
  "values": {
    "hoverScale": 1.3,
    "poi": {
      "max": 25
    },
    "cone": {
      "alpha": 200
    }
  }
}

Each group is merged key by key, so everything not listed keeps its shipped value.

Applying changes

restart element_3d_pausemenu

Markers created by other resources take these values the next time the map is opened.

Limits

Key	Stay within	Why
`poi.max`	Roughly `5` to `30`	Each point of interest is drawn every frame while the map is open. Raising it far above the default costs performance for every player.
`hoverScale`	Roughly `1.05` to `1.5`	Below `1.0` a marker shrinks when pointed at, which reads as an error.
`cone.range`	Roughly `10` to `200`	A very large value draws cones covering the whole view, hiding what is under them.
`cone.alpha`	`0` to `255`	Outside that range the value is not meaningful. `0` hides every cone.

Sprite, colour and font values are game indexes, not names. An index the game does not have produces a blank or default icon rather than an error, so check the result in game after changing one.

Configuration
Exports: the properties a resource can set per marker
Markers do not appear

Get started

Guides

Configuration

For scripters

Troubleshooting

Changelog

Settings

Fallback appearance

Pointing at a marker

Markers outside the view

The player’s marker

Vision cones

The destination marker

Points of interest

Example

Applying changes

Limits

Get started

Guides

Configuration

For scripters

Troubleshooting

Changelog

​Settings

​Fallback appearance

​Pointing at a marker

​Markers outside the view

​The player’s marker

​Vision cones

​The destination marker

​Points of interest

​Example

​Applying changes

​Limits

​Related

Settings

Fallback appearance

Pointing at a marker

Markers outside the view

The player’s marker

Vision cones

The destination marker

Points of interest

Example

Applying changes

Limits

Related