Skip to content

Releases: CommanderFoo/Unity-Horizontal-Compass

2.1.0

Choose a tag to compare

@CommanderFoo CommanderFoo released this 18 Jul 16:39

Added

  • Configurable distance units. New Distance Unit setting: METERS (default, unchanged behaviour), KILOMETERS (meters that roll over to km), or IMPERIAL (feet that roll over to miles).
  • World-position markers. New add_marker(Vector3 world_position, ...) overload for tracking a fixed point without a Transform, alongside the existing add_marker(Transform ...).
  • Marker events. On_Marker_Entered_View, On_Marker_Exited_View, and On_Marker_Within_Range (fired in play mode) let you react to markers. Set Marker Range Threshold above 0 to enable the range event.
  • Events demo. A Compass_Event_Demo example script under Horizontal Compass/Examples that logs each event.

Changed

  • Serialized inspector fields now use camelCase for cleaner default inspector labels. Existing scenes keep their values automatically (via FormerlySerializedAs).

This release is backward compatible. Still requires Unity 6.5 or newer and the Universal Render Pipeline (URP).

Installation

Download the .unitypackage below and import it, or clone the repository for the full sample project. See the README for setup and the runtime API.

Full Changelog: 2.0.1...2.1.0

2.0.1

Choose a tag to compare

@CommanderFoo CommanderFoo released this 18 Jul 16:15

Fixed

  • Switched to the versioned Panel Renderer UI-reload callback. This resolves the deprecation warning on Unity 6.6 and skips redundant UI reloads when the UI has not changed.

No API changes. Still requires Unity 6.5 or newer and the Universal Render Pipeline (URP).

Installation

Download the .unitypackage below and import it, or clone the repository for the full sample project. See the README for setup and the runtime API.

Full Changelog: 2.0.0...2.0.1

2.0.0

Choose a tag to compare

@CommanderFoo CommanderFoo released this 18 Jul 15:59

Breaking Changes

This release requires Unity 6.5+ and is not backwards compatible with 1.x.

  • The compass now uses the Panel Renderer component instead of UI Document. On your compass GameObject, remove the UI Document component, add a Panel Renderer, and assign the same Panel Settings and source UXML.
  • Minimum Unity version is now 6.5 (Panel Renderer was introduced in 6.5).
  • Scripts moved into the net.pixeldepth.horizontal_compass namespace. Add using net.pixeldepth.horizontal_compass; where you reference the compass.

Still on Unity 6.3 or 6.4? Use the unity-6.4 tag, the last UI Document based version.

Changed

  • Simplified controller initialization to a single Panel Renderer UI-reload callback, removing the previous re-initialization workarounds.

Requirements

  • Unity 6.5 or newer
  • Universal Render Pipeline (URP)

Installation

Download the .unitypackage below and import it, or clone the repository for the full sample project. See the README for setup and the runtime API.

Full Changelog: 1.0.0...2.0.0

1.0.0

Choose a tag to compare

@CommanderFoo CommanderFoo released this 18 Jan 20:54
image

Initial release of Unity Horizontal Compass, a customizable horizontal compass UI built with UI Toolkit.

Features

  • Smooth horizontal compass bar with tick marks and cardinal directions
  • Real-time heading tracking based on camera rotation
  • Waypoint marker system with custom icons, colors, and distance display
  • Editor preview mode for testing without entering Play mode
  • Fully customizable via the Inspector and USS stylesheets

Requirements

  • Developed for Unity 6 (UI Toolkit)
  • Built for the Universal Render Pipeline (URP)

Tested With

  • Unity 6000.3 (6.3)

Installation

Download the .unitypackage below and import it into your project, or clone the repository to open the full sample project. See the README for setup, configuration, and the runtime API.

Full Changelog: https://github.com/CommanderFoo/Unity-Horizontal-Compass/commits/1.0.0