Map/Compass HUD Plugin (RMMV)

Map/Compass HUD Plugin

The Map/Compass HUD plugin displays a window on the map showing the map name, compass/direction and player coordinates, each of which can be toggled on or off.

 
Map/Compass HUD PluginMain FeaturesUsage InstructionsScreenshotUpdate LogPersonal NotesPlugin RequirementsCompatibility Issues/Known BugsDownloadFuture UpdatesTerms of Use
Version: 1.0
Author: Companion Wulf
Platform: RMMV
Script Type: Plugin
Required: None
Filesize: 15 Kb
File Format: JS/JGSS
Release Date: v1.0 26 February 2016
Last Update: 26 February 2016
These are the main features in the Map/Compass HUD plugin:

  • Map Name – Displays the current map name.
  • Compass Icon & Direction – Displays a compass icon and textual cardinal point for the direction the character is facing.
  • Player Coordinates – Displays the XY co-ordinates of the player on the current map.

Each of these can be toggled on/off in the Plugin Manager options.

All options can be toggled on/off to your preferences in the Plugin Manager.

Plugin Commands

In the event Plugin Command, use HUD followed by:

show – Show the map/compass window on the map.

hide – Hide the map/compass window on the map.

Other settings in the Plugin Manager include setting the opacity and corner position of the Map/Compass HUD.

Icons

The Map/Compass HUD plugin uses a separate iconset, rather than modify the default system one.

In this case, it’s named "CompassIconSet", but you can create your own with the four compass points. If you do use your own, be sure to change the "Compass Icon Filename" parameter and place your file in the "img/system" folder.

Here’s the example iconset I’ve used:

Map/Compass HUD Icons

Map/Compass HUD Icons

Alternatively, it can be downloaded here.

This screenshot is taken from the developmental version of Otherworld.

Map/Compass HUD Plugin

Map/Compass HUD Plugin

Version.Update.Bug Fix/Tweak

  • v1.0.0 (26-Feb-2016)
       –Release Version 1.0 (Public)
  • v0.11.7 (21-Feb-2016)
       –Bug Fix: Default show/hide HUD still showing if false (messy fix)
       –Bug Fix: Map update lag
       –Add: Default show/hide HUD
       –Bug Fix: Compass icon disappearing after reopen
       –Add: Plugin commands to show/hide map/compass HUD
  • v0.9.4 (20-Feb-2016)
       –Add: Map HUD window opacity
       –Bug Fix: Partially fixed update lag
       –Add: New iconset routine to save overwriting default
       –Bug Fix: Compass icons not displaying as they should
       –Add: Compass icons
       –Bug Fix: Player coordinates not displaying properly
       –Bug Fix: Compass points directions the wrong way around
       –Add: Compass points
       –Add: Alternative map name if display name is not defined
       –Add: Player coordinates
       –Add: Map name display
  • v0.2.0 (19-Feb-2016)
       –Add: Map HUD skeleton
       –Started RGSS conversion
The Map/Compass HUD plugin was originally created for the first "Paranormality" game for RMXP, which was then ported over to RMVX (mainly to see if I could do it). When development on "Otherworld" officially transferred to RMVXA, the script was also converted to RGSS3.

After the decision to migrate Otherworld to RMMV was made, it naturally followed that the main scripts would also need to be converted to JGSS.

The plugin must be installed in RMMV’s Plugin Manager to run. All of the settings can be changed in the Parameters section.
There shouldn’t be compatibility issues or bugs.
Download the .js file directly into the JS folder in your RMMV project.
  • Add meta map/compass HUD toggle plugin commands
  • Add diagonal directions
  • Dynamic window sizing for disabled elements
You are free to use this in non-commercial projects, but please refer to the RPG Maker Times blogsite for other details, including commercial use.

Credit "Companion Wulf" or "RPG Maker Times" if using this plugin in your projects.