Proximity Compass (Olivia)

From Yanfly.moe Wiki
Jump to navigation Jump to search

Welcome to the wiki! This is where you can find resources from Yanfly.moe, Ækashics.moe,
VisuStella, Caz Wolf, Fallen Angel Olivia, Atelier Irina, and other affiliated content creators.



Download

System

This is a plugin created for RPG Maker MV.

For help on how to install plugins, click here.

For help on how to update plugins, click here.

Got errors with your RPG Maker MV plugin? Click here.

Fallen Angel Olivia

FallenAngelOlivia.png

This is a plugin created by Fallen Angel Olivia.

You can also follow Fallen Angel Olivia on itch.io.

RPG Maker Version

This plugin is made for RPG Maker MV versions 1.6.1 and below. If you update RPG Maker MV past that and this plugin breaks, I am NOT responsible for it.

Terms of Use

You are only allowed to use the plugins made by Atelier Irina if you agree to all of the following:

  1. These plugins may be used in free or commercial games.
  2. 'Fallen Angel Olivia' must be given credit in your games.
  3. You are allowed to edit the code.
  4. Do NOT change the filename, parameters, and information of the plugin.
  5. You are NOT allowed to redistribute these Plugins.
  6. You may NOT take code for your own released Plugins.

Introduction

This is a RPG Maker MV 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.

Sample Project

The sample project download for this will include the following:

The main plugin itself along with some supporting plugins. The popular Yanfly Options Core plugin will also have settings pre-configured for the Compass options.

The elegant compass frame picture that is shown in the video above! This will be included in the sample project's img/pictures/ folder.

Pre-configured plugin parameters that will be used to make the compass look the way it does in the video above!

Examples created in pre-made maps to help those who learn visually or hands-on. There are the two quests included in the sample project that are shown in the video above, too!

And last but not least, pre-made icons at the bottom of the icon sheet to show off the utility of the proximity compass.

Plugin Parameters

There are Plugin Parameters that you may configure for this plugin.

Default Show: Show the compass by default on the screen. This is the system setting for the game. The player setting will bypass this if the player chooses to hide the compass.

Default Proximity: This is the default proximity range for icons to show up on the compass (otherwise, they fade away). This is the distance in tiles and not pixels. Make this as a high number if you want icons to always show.

Player Icon: This is the default icon used to indicate the player's position at the center of the compass.

X Center, Y Center: These settings are the code used to determine the center coordinates of the compass.

Radius: This is the radius (in pixels) for the compass from the center. This will be adjusted for if the player decides to change the Compass Size.

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

Back Color: The color used for the back of the compass.

Compass Frame: The picture used for the compass' frame. This will come from the img/pictures/ folder. An image will be provided in the sample project.

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.

Hide During Messages: Gives option to hide during message events. Does not apply when the player is simply performing movement actions or receiving items.

Hide During Events: Gives option to hide during any event except parallel events. This is more wide covered than Hide During Messages.

Show Compass: Text in options menu to show the compass.

Compass Size: Text in the options menu to change the compass size.

Notetags

NotetagsMV.png

RPG Maker MV's editor is unable to allow for custom traits/properties that a game dev may wish to associate with a database object, event, map, etc. Notetags are used to work around such limitations by allowing the game dev to tag certain traits/properties using specific Notetags declared by the related plugin.

Here is a list of Notetag(s) that you may use.

---

<Hide Compass>
- Place this notetag inside maps where you don't want the compass to show.

Comment Tags

CommentTags.png

Comment Tags are similar to Notetags. RPG Maker MV's editor is unable to allow for custom traits/properties that a game dev may wish to associate with an event or common event. Comment Tags are used to work around such limitations by allowing the game dev to tag certain traits/properties using specific Comment Tags declared by the related plugin.

Here is a list of Comment Tag(s) that you may use.

<Compass Icon: x>
- This will set the event's icon to x.

<Compass Proximity: x>
- This icon will only appear on the compass if the player is within x tiles.

Plugin Commands

PluginCommandsMV.png

Plugin Commands are event commands that are used to call upon functions added by a plugin that aren't inherently a part of RPG Maker MV.

Here is a list of Plugin Command(s) that you may use:

ShowCompass
HideCompass
ToggleCompass
- This will show, hide, or toggle the compass from view. If shown, this will
make the compass visible, unless the player opts to hide the compass or if
the map has a <Hide Compass> notetag.

PlayerCompassIcon x
- Changes the player's compass icon to x.

Changelog