> ## Documentation Index
> Fetch the complete documentation index at: https://docs.dietrich-development.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> Custom player blips and immersive compass overlay for RedM servers

A map marker system that allows players to create custom blips on the map and compass overlay, providing an immersive navigation experience in RedM.

<Info>
  This script lets players create, manage, and customize their own map markers with support for various blip sprites, colors, and compass overlay integration.
</Info>

## Features

<Columns cols={2}>
  <Card title="Custom blip creation" icon="map-pin">
    Players can create personalized map markers with custom names, sprites, and colors.
  </Card>

  <Card title="Immersive compass overlay" icon="compass">
    Optional compass overlay feature that displays custom markers on the compass UI.
  </Card>

  <Card title="Multiple placement options" icon="location-dot">
    Place markers at the current position, waypoint location, or specific coordinates.
  </Card>

  <Card title="Sprite and color customization" icon="palette">
    Extensive sprite library with customizable colors and visual styles.
  </Card>

  <Card title="Player management" icon="users">
    Individual player blip management with safety limits and personal organization.
  </Card>

  <Card title="Framework integration" icon="gears">
    Compatible with VORP Core and RSG Core frameworks with custom framework support.
  </Card>
</Columns>

## Usage

### Opening the UI

Players open the map marker interface using the configured command:

```bash theme={null}
/mapmarkers
```

### Creating markers

<Steps>
  <Step title="Open interface">
    Use the `/mapmarkers` command to open the UI
  </Step>

  <Step title="Select options">
    Choose a sprite, color, and placement location
  </Step>

  <Step title="Configure details">
    Set a custom name and enable/disable compass overlay
  </Step>

  <Step title="Create marker">
    Click "Create" to place the marker on the map
  </Step>
</Steps>

### Placement options

<AccordionGroup>
  <Accordion title="Current position">
    Places the marker at the player's current location. Useful for marking points of interest you're currently at.
  </Accordion>

  <Accordion title="Waypoint">
    Places the marker at the active waypoint location. Useful for marking destinations or navigation points.
  </Accordion>

  <Accordion title="Specific coordinates">
    Allows manual input of X, Y, Z coordinates for precise marker placement. Useful for marking locations you know the coordinates for.
  </Accordion>
</AccordionGroup>

## Next steps

<Columns cols={2}>
  <Card title="Setup" icon="screwdriver-wrench" href="/scripts/mapmarker/setup">
    Installation, sprites, colors, compass overlay, and localization.
  </Card>

  <Card title="Docs home" icon="book-open" href="/">
    Installation basics and links to every script.
  </Card>
</Columns>