# XWUIGameCompass

Horizontal compass strip. It shows the current `heading` (0-360, 0 = North) as sliding cardinal labels (N, S, E, W) with degree tick marks, and overlays bearing `markers` (each `bearing`, `icon`, optional `label`/`type`) for quests, POIs, and enemies. `conf_comp` sets the strip `width`, toggles `showCardinals`/`showDegrees`, and whitelists `markerTypes` (default `["quest", "poi", "enemy"]`). Rotate it with `setHeading(heading)` and swap pins with `setMarkers(markers)`.

## Basic Usage

Mounts the compass strip with cardinal directions and bearing markers.

```example
file: examples/BasicUsage.ts
html: examples/BasicUsage.html
title: Basic Usage
description: Mounts the horizontal compass strip showing heading with cardinal labels and bearing markers.
```

## Minimal Band

Hides the numeric ticks with `showDegrees: false` and narrows the strip via `width` for a compact HUD band.

```example
file: examples/MinimalBand.ts
html: examples/MinimalBand.html
title: Minimal Band
description: A narrow compass strip with showDegrees off, keeping only cardinal labels and a couple of pins.
```

## Busy Horizon

Restricts a crowded marker set with the `markerTypes` whitelist so only quest and POI pins render.

```example
file: examples/BusyHorizon.ts
html: examples/BusyHorizon.html
title: Busy Horizon
description: Six bearing markers filtered by markerTypes to show only quest and poi types.
```

```api
```
