Skip to content

A configurable compass strip showing player's heading along with questmarkers including distance and time to arive.

License

Notifications You must be signed in to change notification settings

BelegCufea/CompassHUD

Repository files navigation

CompassHUD

A configurable compass strip that displays your character's heading, along with various markers with information such as name, distance, and time to arrival.

Example1

Inspirations

I was inspired by Compass and GoWCompass.
While influenced by their ideas, I wrote my own code from scratch—avoiding too much copy-paste.

Main Features

  • Fully movable and resizable compass strip.
  • Optional numeric heading display.
  • Support for predefined or custom compass textures.
  • Plethora of markers to be displayed on the compass.

Some examples:

- Changing background and border:
BackgroundBorder

- Configuring compass HUD FOV (up to 360°):
FOV

- Allowing quest markers to remain visible on the edge of the compass HUD:
QuestOutOfBoundery

- Customizing visibility, textures, and behavior for various pointer types:
CustomTextures

- Setting numerical heading display options:
Heading

Configuration

Find the CompassHUD addon in the Options -> AddOns section of the game menu.

HUD settings

  • The General panel contains basic global settings. For many of these settings, there is a tooltip shown while hovering over the them.
    Settings

  • The Compass HUD panel lets you choose between the default texture or customize your own strip with posibility to show/hide/edit several elements.
    Custom

Supertracker

Under the Supertracker submenu, you can configure visibility and behavior for various pointer types.

General behavior settings:
PointerGeneral

Choosing from pointer texture presets:
PointerPresets

For each pointer type, you can also customize:
- Visibility, position, size, default texture
- Edge detection and rotation (mainly for arrow trextures)
- Dynamic icon replacements (for World Quests, POI map pins, etc.)
- In-game SuperTracker retexturing

PointerTexts

Text display options with font and size selection:
PointerTextures

Minimap tracking

Under the Minimap tracking submenu, you’ll find settings for icons usually shown on the minimap. These modules can display many icons on the HUD, potentially impacting FPS if used with all options enabled.

Minimap icons

The Minimap icons section covers standard WoW minimap icons (off by default).

You can configure:

  • Tracking radius
  • Opacity gradient based on distance
  • Icon filtering by type
  • Text display options (name, distance, TTA)
  • Whether texts are shown for all icons or only the one you're facing
  • Keybind for setting the facing minimap icon as a Supertracker

MinimapIcons

Party/Raid

In the Party/Raid section, you can configure the visibility of party and raid members, including icon textures, name display, and formatting.
(Default: Party only)

Addon integrations

Additional sections support integrations with other addons (off by default).

For example, if you have GatherMate2, you can display possible gathering node locations on the HUD.

Miscelaneous

Custom compass strip textures

You can use your own.
It must be 2048x16, has 720 degrees starting from N(orth) and be in BLP or TGA fromat (see CompassHUD.tga at Media folder for reference).

Save your file somewhere in Interface\Addons folder (outside any addon folder to avoid deletion on update).

In your SavedVariables file located at WTF\Account\<AccountID>\SavedVariables\CompassHUD.lua, add:
CompassTextureTexture = [[Interface\Addons\]] .. {your file name without extension}
just after the line containing:
["PositionX"]

Check if you put it in correct profile.

Issues and suggestions

If you run into problems or have feature requests, feel free to open an issue on GitHub.

About

A configurable compass strip showing player's heading along with questmarkers including distance and time to arive.

Topics

Resources

License

Stars

Watchers

Forks

Contributors

Languages