> For the complete documentation index, see [llms.txt](https://multicore-games.gitbook.io/dynamic-compass-or-ue5-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://multicore-games.gitbook.io/dynamic-compass-or-ue5-documentation/dynamic-compass.md).

# Dynamic Compass

## Overview

> ## **Description**

The **Dynamic Compass System** is a lightweight and highly customizable solution for Unreal Engine projects that need an intuitive navigation system. Designed as a blueprint component, it automatically tracks objectives and displays markers on a sleek compass bar at the top of the screen.

Markers can be dynamically added to any actor in your level with just one component, and all visual elements can be customized to fit the style of your project. The system also supports scaling, color coding, and animation for key objectives, making it versatile and user-friendly for both developers and players.<br>

> ## **Key Features**

1. **Compass Bar**: Smooth, dynamic bar that follows player orientation.
2. **Custom Markers**: Attach the component to any actor to create an automatic compass marker.
3. **Icon Library**: Includes a default set of icons (Home, Key, Quest, Reward, Person, Location).
4. **Auto-Hide**: Markers disappear when behind the player or beyond a set distance.
5. **Customization**: Easily replace icons, adjust sizes, colors, and scaling behaviors.
6. **Plug & Play**: Drop the component in your project and start using it instantly.

> ## [**Demo level included**](https://multicore-games.itch.io/dynamic-compass)

The demo level includes examples of all features of the **Dynamic Compass System**, each with interactive examples and use cases!

<details>

<summary><strong>Supported Unreal Engine Versions:</strong></summary>

• UE 5.0

• UE 5.1

• UE 5.2

• UE 5.3

• UE 5.4

• UE 5.5

• UE 5.6

</details>

{% content-ref url="/pages/HqV5aJe629vNZJR7rIFN" %}
[Features](/dynamic-compass-or-ue5-documentation/overview/features.md)
{% endcontent-ref %}

***

## Setup and Implementation

{% content-ref url="/pages/FUPFv1DDxyFRN3qDIlQ9" %}
[Getting set up](/dynamic-compass-or-ue5-documentation/setup-and-implementation/getting-set-up.md)
{% endcontent-ref %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://multicore-games.gitbook.io/dynamic-compass-or-ue5-documentation/dynamic-compass.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.