View source for Proximity Compass VisuStella MZ

{{MzPlugin
|preview = <youtube>https://www.youtube.com/watch?v=5FjywrQlAAk</youtube>
|link1 = <html><iframe frameborder="0" src="https://itch.io/embed/786766" width="552" height="167"><a href="https://visustellamz.itch.io/proximity-compass">Proximity Compass by VisuStellaMZ</a></iframe></html>
|link2 = {{VisuStella Wave 4}}
|link3 = {{VisuStella All Waves Collection}}

}}

<!-- Preview -->

[[File:ProximityCompass_Preview1.png|600px]]

[[File:ProximityCompass_Preview2.png|600px]]

[[File:ProximityCompass_Minimap01.gif]]

[[File:ProximityCompass_Minimap03.gif]]

{| style="width: 800px;" cellspacing="0" cellpadding="0"
| style="width: 100%; vertical-align: top;" |

<!--
{{RequiredPluginsMZ}}
* [[Required Plugin 1|Name1]]
* [[Required Plugin 2|Name2]]
* [[Required Plugin 3|Name3]]

{{ExtensionPluginsMZ}}
* [[Extension Plugin 1|Name1]]
* [[Extension Plugin 2|Name2]]
* [[Extension Plugin 3|Name3]]
-->

{{Visustella MZ}}

== Introduction ==

This is a RPG Maker MZ plugin that adds a compass to the map screen, marking
the position of nearby events and the directions of far away events. Events
are represented by icons from the icon set. This can be used to help the
player locate objectives, points of interests, NPCs, and more.

Features include all (but not limited to) the following:

* Places a compass on the main map screen.
* Said compass will show the marked events on it with icons.
* Marked events will move around the compass relative to the player's current position on the map.
* Fade out marked events that are too far from the player's location.
* Minimap subfeature will display all of the passable tiles under the compass frame.
* Minimap can be toggled to a larger version shown on the middle of the screen displaying more of the map's data all at once.
* Use custom graphics to kit out the minimap to your liking.
* The compass can be turned on/off in the Options menu.
* The compass can also be resized in the Options menu.

== Requirements ==

This plugin is made for RPG Maker MZ. This will not work in other iterations
of RPG Maker.

== VisuStella MZ Compatibility ==

While this plugin is compatible with the majority of the VisuStella MZ
plugin library, it is not compatible with specific plugins or specific
features. This section will highlight the main plugins/features that will
not be compatible with this plugin or put focus on how the make certain
features compatible.

---

=== [[Events and Movement Core VisuStella MZ]] ===

Region marked passability using the Events and Movement Core region
restriction notetags will also be counted towards the creation of the
minimap. These are the notetags that will affect the minimap:

  <All Allow Region: x>
  <Player Allow Region: x>
  <All Forbid Region: x>
  <Player Forbid Region: x>

---

{{MZ Tier 4}}

{{Notetags MZ}}

{{VisuMZ Proximity Compass Notetags}}

{{Plugin Commands MZ}}

{{VisuMZ Proximity Compass Plugin Commands}}

== Plugin Parameters ==

=== Default Settings ===

[[File:ProximityCompass_Preview1.png|600px]]

[[File:ProximityCompass_Param1.png]]

Default settings used for the Proximity Compass.

---

Default

  Show by Default:
  - Show the Proximity Compass by default?

  Proximity Range:
  - Default range from the player to be shown on the Proximity Compass.

  Player Icon:
  - Icon used for the player to show on the Proximity Compass.

---

=== Compass Settings ===

[[File:ProximityCompass.gif]]

[[File:ProximityCompass_Param2.png]]

Compass settings used for the Proximity Compass.

---

Position

  Center X:
  - Code used to calculate the X position of the compass's center.
  - This is NOT the upper left corner of the compass.

  Center Y:
  - Code used to calculate the Y position of the compass's center.
  - This is NOT the upper left corner of the compass.

---

[[File:CompassFrame.png]]

Contents

  Default Event Icons:

    Below Characters:
    - Default icon used for events on below characters level.
    - These appear on the compass and large minimap.

    Same as Characters:
    - Default icon used for events on same as characters level.
    - These appear on the compass and large minimap.

    Above Characters:
    - Default icon used for events on above characters level.
    - These appear on the compass and large minimap.

  Filename:
  - The picture used for the compass' frame.
  - This will come from the img/pictures/ folder.

  Radius:
  - Radius of the Proximity Compass in pixels.

  Tile Scale:
  - The scale used to calculate the distance of a tile relative to the
    distance on the compass

  Back Color:
  - Use #rrggbb for custom colors or regular numbers for text colors from
    the Window Skin.

  Back Opacity:
  - Sets the opacity of the back color.

---

Fading

  Close Minimum Opacity:
  - Minimum opacity when the player is too close to the compass on the
    map screen.
  - Hiding the compass during messages and events will make the compass
    fully transparent.

  Compass Fade Speed:
  - Fade speed of the compass when toggled on/off.
  - Lower is slower. Higher is faster.

  Icon Fade Speed:
  - Fade speed of the icons when out of range.
  - Lower is slower. Higher is faster.

---

Hiding

  Hide During Messages:
  - If true, hide compass whenever a message is being displayed.

  Hide During Events:
  - If true, hide compass whenever an event is running.

---



=== Minimap Settings ===

As of the v1.06 update, this plugin now has a Minimap feature. This section
governs the minimap feature, if you want to use it, and how it appears.

[[File:ProximityCompass_Minimap01.gif]]

A keyboard button can be used to toggle the "large" minimap (provided
minimaps are enabled for the current map). This minimap will show the areas
that are explored and not explored. As the player moves around, the
exploration area will enlarge based on the game's screen size.

[[File:ProximityCompass_Minimap03.gif]]

For mouse toggling, we recommend using VisuStella MZ's Picture Common Events
and this plugin's "Minimap: Toggle Large Minimap" Plugin Command for the
best customization options.

The minimap used on the compass itself will always be fully revealed due to
its limited area of visibility.

[[File:ProximityCompass_Update96_Param1.png]]

---

General

  Enable Minimap?:
  - Enable the minimap for the game? Cannot disable midgame.
  - The <Hide Minimap> map notetag can hide it though.

---

Contents

[[File:Minimap_Frame.png]]

  Filename:
  - Use this picture if current map uses a minimap.
  - This will come from the img/pictures/ folder.
  - If empty, it will use the filename used by the default compass.

  Hide Ceilings:
  - Ceiling autotiles are normally passable.
  - Hide them in the minimap?

  Tile Color:
  - Sets the color of the passable tiles found on the minimap.
  - Use #rrggbb for custom colors or regular numbers for text colors from
    the Window Skin.

  Tile Opacity:
  - What is the opacity level for the tiles?

  Tile Sharpness:
  - How sharp do you want the passability minimap to be?
  - Use a number from 2 to 16.

---

Large Minimap Settings

  Border Buffer:
  - Determine the buffer distance from the edge of the map when creating the
    large minimap.

  Default Event Icons:

    Below Characters:
    - Default icon used for events on below characters level.
    - These only appear on the large minimap.

    Same as Characters:
    - Default icon used for events on same as characters level.
    - These only appear on the large minimap.

    Above Characters:
    - Default icon used for events on above characters level.
    - These only appear on the large minimap.

  Default Explorable?:
  - By default, are maps explorable or already mapped?
  - Notetags will override this feature.

  Hide During Messages:
  - If true, hide large minimap whenever a message is being displayed.

  Hide During Events:
  - If true, hide large minimap whenever an event is running.

  Icon Scaling:

    Player Icon Scale:
    - What is the icon scale for the player icon?
    - Only applies to the large minimap.

    Compass Icon Scale:
    - What is the icon scale for <Compass Icon: x>?
    - Only applies to the large minimap.

    Minimap Icon Scale:
    - What is the icon scale for <Minimap Icon: x>?
    - Only applies to the large minimap.

  Ignore Icon Proximity:
  - If true, <Compass Proximity: x> notetag effects are ignored on the
    large minimap.

  Toggle Key:
  - What key is used to toggle the larger minimap on/off?
  - This feature is not usable unless the compass is enabled.
  - This feature won't trigger if there is a <Hide Minimap> notetag.

---

Large Minimap Background Image

  Background Filename:
  - Use this picture if for the large minimap's background.
  - This will come from the img/pictures/ folder.

  Hide Background Color:
  - If true, hide the background color when using the minimap
    background image.

  Image Opacity:
  - Sets the opacity of the minimap background image.

  Minimap Blend Mode:
  - What kind of blend mode do you wish to apply to the rendered
    passability minimap?

---

=== Options Settings ===

[[File:ProximityCompass_Preview2.png|600px]]

[[File:ProximityCompass_Param3.png]]

Options settings used for the Proximity Compass.

---

Options

  Add Show Option?:
  - Add the 'Show Compass' option to the Options menu?

    Option Name:
    - Command name of the option.

  Add Size Option?:
  - Add the 'Compass Size' option to the Options menu?

    Option Name:
    - Command name of the option.

  Adjust Window Height:
  - Automatically adjust the options window height?

---

{{VisuStella MZ Terms of Use}}

== Credits ==

If you are using this plugin, credit the following people in your game:

Team VisuStella

* [[Yanfly]]
* [[Arisu]]
* [[Olivia]]
* [[Irina]]

== Changelog ==

Version 1.08: October 6, 2022
* Compatibility Update!
** Plugins should be more compatible with one another.



Version 1.07: August 11, 2022
* Feature Update!
** Minimap can now no-longer be toggled during events and messages if the other minimap-related settings have it disabled. Update made by Arisu.



Version 1.06: June 16, 2022
* Documentation Update!
** List new minimap feature under Introduction.
** Added "VisuStella MZ Compatibility" for VisuMZ_1_EventsMoveCore in regards to the new Minimap feature.
** Help file updated for new features.
** Split the Notetags section up between "Map Notetags" and "Event Notetags" for better category searching.
** Added segment to <Compass Icon: x> notetag:
*** This notetag effect will take priority over the <Minimap Icon: x> notetag.
* New Features!
** New Plugin Parameter added by Olivia and sponsored by AndyL:
*** Plugin Parameters > Compass Settings > Contents > Default Event Icons
**** These settings allow you to set the default icons used for the compass based on their character priority level.
*** Plugin Parameters > Compass Settings > Fading > Close Minimum Opacity
**** Minimum opacity when the player is too close to the compass on the map screen. Hiding the compass during messages and events will make the compass fully transparent.
** New Feature Set: Minimap, added by Olivia and sponsored by AndlyL:
*** Plugin Parameters > Minimap Settings
**** Read the help file for details.
** New Notetags added by Olivia and sponsored by AndyL:
*** <Hide Minimap>
*** <Explorable>
*** <Already Explored>
*** <Minimap Icon: x>
*** <Hide Minimap Icon>
**** Read the help file for details.
** New Plugin Commands added by Olivia and sponsored by AndyL:
*** Minimap: Clear Explored Minimap
*** Minimap: Fully Reveal Minimap
*** Minimap: Toggle Large Minimap
**** Read the help file for details.



Version 1.05: March 31, 2022
* Feature Update!
** Spawned events with proximity compass icons will no longer show the whole spritesheet for a frame. Update made by Olivia.



Version 1.04: January 6, 2022
* Optimization Update!
** Plugin should run more optimized.



Version 1.03: January 15, 2021
* Feature Update!
** Failsafes added in case events added manually through other plugins do not update with proper events.



Version 1.02: November 15, 2020
* Bug Fix!
** Events spawned by the Events & Movement Core will now have their compass icons displayed upon spawning without requiring a reload of the map. Fix made by Arisu.



Version 1.01: October 25, 2020
* Documentation Update
** Added clarity on the notetags and comment tags on when their effects are present.



Version 1.00: October 23, 2020
* Finished Plugin!



== See Also ==

* [[Inspiration Behind Wave 4]]



== End of File ==

|}

<!-- This is a comment, remove the arrows surrounding this for the categories you want to show -->
<!-- [[Category: RPG Maker MZ Core Plugins]] -->
<!-- [[Category: RPG Maker MZ Battle Plugins]] -->
<!-- [[Category: RPG Maker MZ Item Plugins]] -->
<!-- [[Category: RPG Maker MZ Skill Plugins]] -->
<!-- [[Category: RPG Maker MZ Equip Plugins]] -->
<!-- [[Category: RPG Maker MZ Status Menu Plugins]] -->
<!-- [[Category: RPG Maker MZ Gameplay Plugins]] -->
[[Category: RPG Maker MZ Movement Plugins]]
<!-- [[Category: RPG Maker MZ Quest Plugins]] -->
<!-- [[Category: RPG Maker MZ Options Plugins]] -->
[[Category: RPG Maker MZ Eventing Plugins]]
[[Category: RPG Maker MZ Utility Plugins]]
<!-- [[Category: RPG Maker MZ Mechanical Plugins]] -->
[[Category: RPG Maker MZ Visual Plugins]]
<!-- [[Category: RPG Maker MZ Menu Plugins]] -->
<!-- [[Category: RPG Maker MZ Message Plugins]] -->
[[Category: RPG Maker MZ Quality of Life Plugins]]
<!-- [[Category: Action Sequences (MZ)]] -->
<!-- [[Category: Comment Tags (MZ)]] -->
<!-- [[Category: Main Menu Manager Integration (MZ)]] -->
<!-- [[Category: Notetags (MZ)]] -->
<!-- [[Category: Options Core Integration (MZ)]] -->
<!-- [[Category: Plugin Commands (MZ)]] -->
<!-- [[Category: Script Calls (MZ)]] -->
<!-- [[Category: Text Codes (MZ)]] -->