Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.borntocraftstudio.net/llms.txt

Use this file to discover all available pages before exploring further.

The Minimap Marker Action allows dynamic management of markers (waypoints, objectives, POIs) on a player’s minimap.

​
Configuration

​
action
Enum
default:"ADD"
Operation to perform: ADD, REMOVE, or CLEAR_ALL.
​
markerId
String
required
Unique ID for the marker. Used for subsequent removal or updates.
​
customDefinition
Ref<CustomMarkerDefinition>
Optional reference to a Custom Marker style.
​
global
Boolean
default:"false"
If true, the marker is added for ALL players on the server.

​
Positioning (for ADD)

​
usePlayerLocation
Boolean
default:"true"
If true, places the marker at the player’s current location.
​
world
String
World name (required if usePlayerLocation is false).
​
x
Double
X coordinate.
​
y
Double
Y coordinate.
​
z
Double
Z coordinate.

​
Customization

​
icon
String
Override icon path (e.g., minimap/quest.png).
​
label
String
Override display label text.
action:
  type: minimap_marker
  action: ADD
  markerId: "quest_obj_alpha"
  usePlayerLocation: false
  x: 154.0
  y: 72.0
  z: -420.0
  label: "Extraction Point"