Tool Ring System (Irina)

From Yanfly.moe Wiki
Revision as of 19:22, 1 April 2020 by Irina (talk | contribs) (Created page with "{{MvPlugin |preview = <html><a href='https://atelieririna.itch.io/tool-ring-system'><img src='https://img.itch.zone/aW1nLzMxODIyMjIucG5n/original/Il9wVw.png'></a></html> |link...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
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.

Atelier Irina

IrinaAvatar.png

This is a plugin created by Atelier Irina.

You can also follow Atelier Irina on itch.io.

RPG Maker Version

This plugin is made for and tested on RPG Maker MV with version 1.6.2. I cannot guarantee if it works on lower versions. Some of the plugin parameters require the later updates of RPG Maker MV for you to be able to use their entries so please update RPG Maker MV to the latest version if you want the best experience in using this plugin.

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. 'RPG Maker Irina' 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.

Help File

Introduction

This plugin adds in a Tool Ring System into your game, which your players can access to switch their active tool. Tools, when used, will launch a designated Common Event to allow your players to perform various tasks.

The Tool Ring System can be accessed by players using the "A" button on the keyboard (or anything you wish to designate it to). There are a total of 8 slots that can be equipped and each can be easily accessed by pressing a direction upon opening the Tool Ring System.

The active tool can be used via the "SPACE" bar (or whatever you wish).

Setup Instructions

  1. Open up the Plugin Parameters.
  2. Define which switch will determine the accessibility of the Tool Ring System. THIS SWITCH MUST BE ON TO USE IT!
  3. Determine which key will be used to open up the Tool Ring System and which key will be used to use the active tool.
  4. Go into your game's Database > Items tab and create new tools.
  5. Insert <Tool Common Event: x> into the item's notebox. Replace x with the ID of a Common Event to launch when used.

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.

---

<Tool Common Event: x>
- For: Items ONLY
- Replace 'x' with the ID of the Common Event to launch when used.

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:

Open Tool Ring
- Opens up the tool ring forcefully.

Plugin Parameters

Switches:

Tool Ring Enable Switch:
- If this switch is on, enable the Tool Ring System.
If not used, the Tool Ring will always be accessible.

Keys:

Open Tool Ring Key:
- Select which key to open up the Tool Ring System.

Use Active Tool:
- Select which key to use the currently equipped active tool.

Visual:

Icon Size Rate:
- The rate of the tools' icon sizes.
- 1.00 = 100%, 2.00 = 200%

Active Icon:
- Icon used to represent the currently active tool.

Empty Icon:
- Icon used to represent an empty tool slot.

Normal Background Color:
Active Background Color:
Empty Background Color:
- Color of the background circles in the Tool Ring System.
- Format #rrggbb

Tool Tip Color:
- Color of the tool tip window background in the Tool Ring System.
- Format #rrggbb

Vocabulary:

Empty Tool Tip:
- Tool Tip text when no tool is found in the slot.

Quantity Format:
- Text format on how to display quantities over 1.
%1 - Quantity

Tool Tip Shift:
- Tool tip text on the Shift key for removal/registering tools.

Tool Tip OK:
- Tool tip text on the Shift key for ok button.

Tool Tip Cancel:
- Tool tip text on the Shift key for cancel button.

Changelog

  • Version 1.00
    • Plugin released!