Usage

The MinimapTools package is composed of a few main components.

1. World space for the minimap defined via an IMinimapShape

   • The behaviour MinimapBoundsSource defines a MinimapSquare that can be read via the AbstractMinimap behaviour.

2. A minimap UI element defined as IMinimap There are a few concrete implementations of this defined in the project.

   • CenteredMinimap - A Centered minimap that will move and or rotate with a selected minimap icon from a tag. Also supports scaling the map to be larger or smaller.
   • SimpleStaticMinimap - This is a simple minimap that will draw the background and objects on the minimap.

3. Minimap Elements that are in a fixed position on the minimap. The interface for this is defined as IMinimapElement

   • BoxMinimapElement - Box minimap that will draw a solid box on the background at a given position, rotation, and size.
   • SpriteMinimapElement - Sprite minimap element that will draw a given texture on the background at a given position, rotation, and size.

4. Minimap Icons that move around on top of the minimap. The interface for icons is defined as IMinimapIcon

   • FixedSizeSpriteIcon - Icon that will always have the same pixel size on the minimap no matter the zoom level.
   • @nickmaltbie.MinimapTools.Icon.RelativeSizeIcon - Icon that will scale with the map to maintain a consist size with its world size.

Sample

The sample MinimapFPS defined at Assets\Samples\MinimapFPS has an example of the minimap as part of the UIManager prefab for minimaps at the path Assets\Samples\MinimapFPS\UI\Minimap.