# Waypoints

`Waypoints` is a FiveM 3D waypoint system that renders immersive world markers using DUI technology.

It is designed to provide a more modern and interactive alternative to standard map markers by displaying customizable 3D waypoint indicators directly in the game world. Markers can show live distance, custom icons, custom colors, and smooth fade-out behavior based on distance.

The resource also includes built-in support for player GPS waypoints and allows developers to create fully custom waypoints through simple client-side exports.

### Features

* 3D in-world waypoint markers
* Built-in GPS waypoint support
* Live distance display
* Smooth fade-out by distance
* Custom icons, colors, and sizes
* Client-side exports for full control
* Performance-friendly DUI pooling
* Persistent GPS marker toggle
* Automatic cleanup on resource stop
* Vue-based marker rendering

### How it works

When a player sets a waypoint on the map, the resource automatically creates a 3D marker in the world at that location.

The marker displays a styled icon and optional live distance counter. As the player moves farther away, the marker fades smoothly based on the configured draw distance and fade distance.

Other resources can also create, update, and remove their own custom waypoints using exports.

### Included Pages

* Installation
* Configuration

### Requirements

Before using this resource, make sure all required dependencies are installed and started correctly.

### Notes

* GPS waypoint markers can be toggled by the player
* Custom waypoints can be controlled through exports
* DUI instances are pooled for better performance
* All active waypoints are cleaned up automatically when the resource stops


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://mskscripts.gitbook.io/mskscripts/scripts/waypoints.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
