Equip Medal System VisuStella MZ

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 MZ.

InstallPluginsMz.png

UpdatePlugins.png

Troubleshooting.jpg

Click here for help on how to install plugins and an explanation on the Tier Hierarchy System.

Click here to learn how to update plugins.

Click here for how to troubleshoot plugins if you get an error.


Masterarbeit Writer


EquipMedalSys Preview1.png

EquipMedalSys Preview2.png

EquipMedalSys Preview3.png

Required Plugins

The following plugins are required in order to use this plugin.

Place the following plugins above this plugin located in the Plugin Manager.


VisuStella MZ

This plugin is a part of the VisuStella MZ Plugin Library.

Click here if you want to help support VisuStella on Patreon.

Introduction

VisuMZ.149.jpg

Medals are a type of personalized equipment that actors can wear. They function just like pieces of armor which means they can get all of the parameter bonuses and traits that armors add. Medals can be acquired through various conditions and allow your actors can be customized in more ways.

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

  • Medals can be found and toggled from the equip scene.
  • Medals are limited to the medal slots that an actor has and the amount of slots that a medal takes up.
  • Since medals are armors in the database, they also take on all of the aspects that armors do like parameters and traits.
  • Determine which medals an actor can acquire through notetags.
  • Some medals can be acquired for the whole party when the player acquires certain items, weapons, armors, or key items.
  • Medals can be acquired by fulfilling the conditions needed to be met.
  • Upon acquiring medals, actors can branch out and unlock more medals to be acquired through various means.
  • Some of these conditions include leveling, winning battles, escaping, being afflicted by states, attacking a certain amount of times, and more!
  • Give and remove medals to and from all actors in a party globally.
  • Medals have the ability to gain Glory, a form of Medal EXP, to evolve and transform into other medals.


Requirements

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

Required Plugin List

This plugin requires the above listed plugins to be installed inside your game's Plugin Manager list in order to work. You cannot start your game with this plugin enabled without the listed plugins.


Tier 2

This plugin is a Tier 2 plugin. Place it under other plugins of lower tier value on your Plugin Manager list (ie: 0, 1, 2, 3, 4, 5).

This is to ensure that your plugins will have the best compatibility with the rest of the VisuStella MZ Plugin library.



How Equippable Medals Work

This section explains how Equippable Medals work in detail.

---

Armors at Base

EquipMedalSys Preview1.png

Equippable Medals are personalized armors that actors can equip and unequip as long as the actors have enough "Medal Slots" to support the medals. Since medals are armors at the fundamental level, they have all of the traits that armors have access to in addition to the ability to give stat bonuses.

---

Unlock Conditions

EquipMedalSys Preview2.png

If an actor has unacquired Equippable Medals listed, that actor can attempt to meet the conditions of those medals and acquire them. Actors will not be able to acquire medals that aren't listed, regardless of the actor meeting all the unlock conditions for the unlisted Equippable Medals.

Unlock conditions can range from things like fighting 5 battles since the time the Equippable Medal has been listed to things like casting 8 magical skills. There is a huge list of unlock conditions that can be used found in the notetags section.

---

Medal Evolution

EquipMedalSys Preview3.png

When Equipped Medals are worn in battle, they can earn "Glory", a type of EXP for medals. Enemies can reward players different amounts of Medal EXP based off their notetags.

When medals receive enough Medal EXP, they will "evolve", transforming them into a different Medal that can be worn by the actor. By default, the previous Medal will be hidden away in favor of the newer evolved Medal. Any excess Medal EXP will be transferred over to the newer evolved Medal.

Medal Evolution does not take into consideration Unlock Conditions. Evolving a Medal can happen without fulfilling Unlock Conditions as evolutions just bypass them altogether.

Not all medals need to evolve. Only those that can evolve will take in Medal EXP. In Scene_Equip, where medals can be viewed, a gauge will be displayed next to evolvable medals to represent the progress made so far in acquiring Medal EXP for those medals.

---


Extra Features

There are some extra features found if other VisuStella MZ plugins are found present in the Plugin Manager list.

---

Elements and Status Menu Core VisuStella MZ

VisuMZ.008.jpg

Certain notetags will become available if the VisuStella MZ Elements and Status Menu Core plugin is installed in addition to this plugin. This notetag is the <Equip Medal Learn Defeat name Trait: x> notetag.

---


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.

---

Victory Aftermath VisuStella MZ

VisuMZ.013a.jpg

If Victory Aftermath is installed (and updated to the latest version), reward strips can be updated to show the amount of Glory (Medal EXP) that is gained in battle.

---


Notetags

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


The following are notetags that have been added through this plugin. These notetags will not work with your game if this plugin is OFF or not present.

---

Setup-Related Notetags

EquipMedalSys Preview1.png

---

<Equip Medal Cost: x>

- Used for: Armor Notetags
- Determines the Medal Slot cost of the Equippable Medal.
- Replace 'x' with a number representing the Medal Slot cost.
- If this notetag is not used, the Medal Slot cost will default to
  the setting found in the Plugin Parameters.

---

<Learnable Equip Medal: id>
<Learnable Equip Medals: id, id, id>

<Learnable Equip Medal: name>
<Learnable Equip Medals: name, name, name>

<Learnable Equip Medals>
 name
 name
 name
</Learnable Equip Medals>

- Used for: Actor, Class Notetags
- Determines which Equippable Medals that actors and classes can learn.
- Replace 'id' with a number representing the ID of the medal.
- Replace 'name' with the name of the medal.

---

<Equip Medal Icon: x>
<Equip Medal Name: name>

- Used for: Armor Notetags
- Changes the icon and name of the Equippable Medal to something different
  than how it is listed in the database or found in other menus.
- Replace 'x' with a number representing the icon index you want.
- Replace 'name' with the text of the name you want used.

---

<Equip Medal Help Description>
 text
 text
</Equip Medal Help Description>

- Used for: Armor Notetags
- Changes the help description of the Equippable Medal to something
  different than how it is listed in the database or found in other menus.
- Replace 'text' with text you want displayed when this medal is selected
  and can be possibly equipped.

---

<Learned Equip Medal: id>
<Learned Equip Medals: id, id, id>

<Learned Equip Medal: name>
<Learned Equip Medals: name, name, name>

- Used for: Actor Notetags
- Allows this actor to already have learned this Equippable Medal by
  default so that it is available when the actor joins your party.
- These Equippable Medals do not have to be listed through the learnable
  notetags.
- Replace 'id' with a number representing the ID of the medal.
- Replace 'name' with the name of the medal.

---

<Already Equip Medal: id>
<Already Equip Medals: id, id, id>

<Already Equip Medal: name>
<Already Equip Medals: name, name, name>

- Used for: Actor Notetags
- Allows this actor to already have learned this Equippable Medal and has
  it equipped by default so that it is available when the actor joins your
  party.
- These Equippable Medals do not have to be listed through the learnable
  notetags.
- Replace 'id' with a number representing the ID of the medal.
- Replace 'name' with the name of the medal.

---

<Branch Learn Equip Medal: id>
<Branch Learn Equip Medals: id, id, id>

<Branch Learn Equip Medal: name>
<Branch Learn Equip Medals: name, name, name>

- Used for: Armor Notetags
- When this Equippable Medal is learned, also learn target medal(s).
- Target medal(s) does not have to be learnable listed.
- Replace 'id' with a number representing the ID of the target medal.
- Replace 'name' with the name of the target medal.

---

<Branch Learnable Equip Medal: id>
<Branch Learnable Equip Medals: id, id, id>

<Branch Learnable Equip Medal: name>
<Branch Learnable Equip Medals: name, name, name>

- Used for: Armor Notetags
- When this Equippable Medal is learned, add target medal(s) to the
  actor's learnable medal list.
- Replace 'id' with a number representing the ID of the target medal.
- Replace 'name' with the name of the target medal.

---

<Link Learn Equip Medal: id>
<Link Learn Equip Medals: id, id, id>

<Link Learn Equip Medal: name>
<Link Learn Equip Medals: name, name, name>

- Used for: Item, Weapon, Armor Notetags
- When this item, weapon, or armor is gained, also learn target medal(s).
- Target medal(s) does not have to be learnable listed.
- Replace 'id' with a number representing the ID of the target medal.
- Replace 'name' with the name of the target medal.

---

<Link Learnable Equip Medal: id>
<Link Learnable Equip Medals: id, id, id>

<Link Learnable Equip Medal: name>
<Link Learnable Equip Medals: name, name, name>

- Used for: Item, Weapon, Armor Notetags
- When this item, weapon, or armor is gained, add target medal(s) to the
  actor's learnable medal list.
- Replace 'id' with a number representing the ID of the target medal.
- Replace 'name' with the name of the target medal.

---

Hiding-Related Notetags

EquipMedalSys Preview2.png

---

<Hide If Not Learned Equip Medal>

- Used for: Armor Notetags
- Bypasses Medals listing and hides the medal regardless of the
  Plugin Parameter settings.

---

<Hide If Learned Equip Medal: id>
<Hide If Learned Equip Medal: name>

<Hide If Learned All Equip Medals: id, id, id>
<Hide If Learned All Equip Medals: name, name, name>

<Hide If Learned Any Equip Medals: id, id, id>
<Hide If Learned Any Equip Medals: name, name, name>

- Used for: Armor Notetags
- Hides the medal from the Medals listing based on whether or not
  other medals are learned.
- Replace 'id' with a number representing the ID of the medal.
- Replace 'name' with the name of the medal.
- The 'All' notetag variant requires all of the listed medals to be
  learned in order for this medal to be hidden.
- The 'Any' notetag variant requires only one of the listed medals to be
  learned in order for this medal to be hidden.

---

Masking-Related Notetags

EquipMedalSys Preview2.png

---

<Mask If Not Learned Equip Medal>
<No Mask If Not Learned Equip Medal>

- Used for: Armor Notetags
- Bypasses the masking settings determined in the Plugin Parameters to mask
  or not mask the Equippable Medal if the medal is not learned.

---

<Equip Medal Mask Name: name>

- Used for: Armor Notetags
- Instead of displaying ?'s for the mask name, this allows you to insert
  custom mask names instead.
- Replace 'name' with the text you want for the mask name.

---

Medal Evolution-Related Notetags

EquipMedalSys Preview3.png

---

<Equip Medal Evolves Into id: exp>
<Equip Medal Evolves Into name: exp>

- Used for: Armor Notetags
- Allows this Equippable Medal to evolve into target medal upon reaching
  'exp' Medal EXP.
- Equipped Medal must be equipped in order to receive Medal EXP.
- Replace 'id' with a number representing the ID of the evolution medal ID
  (armor ID).
- Replace 'name' with text representing the evolution medal (armor) name.
- Replace 'exp' with a number representing the amount of Medal EXP needed
  for this Equippable Medal to evolve.
- If no evolve notetags are used, the Equippable Medal will not evolve and
  won't receive any Medal EXP.

---

<Equip Medal Evolves Into Next: exp>

- Used for: Armor Notetags
- Allows this Equippable Medal to evolve into the next available armor as
  a medal in the database upon reaching 'exp' Medal EXP.
  - The target armor/medal is just whatever this Equippable Medal's ID is
    but +1.
- Equipped Medal must be equipped in order to receive Medal EXP.
- Replace 'exp' with a number representing the amount of Medal EXP needed
  for this Equippable Medal to evolve.
- If no evolve notetags are used, the Equippable Medal will not evolve and
  won't receive any Medal EXP.

---

<Medal EXP: x>

- Used for: Enemy Notetags
- Determines how much Medal EXP this enemy will give when defeated.
- Replace 'x' with a number representing the amount of Medal EXP given.
- If this notetag is not used, the Medal EXP given will be determined by
  the Plugin Parameters.

---

<Medal EXP Rate: x%>

- Used for: Actor, Class, Weapon, Armor, State Notetags
- Increases the amount of Medal EXP the affected actor will gain by a
  percentile value.
- Replace 'x' with a percentage number representing the amount of Medal EXP
  that will be acquired.
- This stacks multiplicatively with each other.
- This does not apply when Medal EXP are directly added.

---

<Equip Medal Full EXP Gauge>

- Used for: Armor Notetags
- If you want an Equippable Medal to have a gauge but it does not evolve,
  this will allow a full gauge to appear.
- Useful for medals at the end of an evolution track.

---

<Equip Medal EXP Gauge Color 1: x>
<Equip Medal EXP Gauge Color 2: x>

- Used for: Armor Notetags
- Allows you to adjust the gauge colors used for this Equippable Medal.
- Replace 'x' with a number representing the text color you want (ranges
  from 0 to 31).
- Alternatively, use '#rrggbb' for custom colors in hex color format.

---

Unlock Conditions-Related Notetags

EquipMedalSys Preview2.png

---

<Equip Medal Learn Condition Text>
 text
 text
</Equip Medal Learn Condition Text>

- Used for: Armor Notetags
- Assigns text to the Equip Medals learn unlock conditions.
- Replace 'text' with text you want displayed when this medal is selected
  and has not yet been learned.
- If this notetag is not used, the help description will default be
  automatically constructed through the plugin using Plugin Parameters.

---

<Equip Medal Learn Level: x>

- Used for: Armor Notetags
- Adds an unlock condition that the actor must reach level 'x'.
- If this Equippable Medal is found in the learnable list and all unlock
  conditions in addition to this unlock condition are met, then the actor
  will learn the Equippable Medal.
- Replace 'x' with a number representing the level the actor must reach.

---

<Equip Medal Learn Battles: x>
<Equip Medal Learn Victories: x>
<Equip Medal Learn Escapes: x>
<Equip Medal Learn Defeats: x>

- Used for: Armor Notetags
- Adds a battle result-related unlock condition that the actor must fulfill
  in order to learn this Equippable Medal.
- If this Equippable Medal is found in the learnable list and all unlock
  conditions in addition to this unlock condition are met, then the actor
  will learn the Equippable Medal.
- Replace 'x' with a number representing the number of battle results that
  must be fulfilled.
  - The number counter will start from the moment Equippable Medal is
    listed in the learnable list.
  - This does NOT take into account previous battle results before listing.
- The 'Battles' notetag variant requires participating in any battles.
- The 'Victories' notetag variant requires winning battles.
- The 'Escapes' notetag variant requires successfully escaping battles.
- The 'Defeats' notetag variant requires losing battles.

---

<Equip Medal Learn Attack Times: x>
<Equip Medal Learn Guard Times: x>

- Used for: Armor Notetags
- Adds an unlock condition that the actor must attack or guard 'x' times.
- If this Equippable Medal is found in the learnable list and all unlock
  conditions in addition to this unlock condition are met, then the actor
  will learn the Equippable Medal.
- Replace 'x' with a number representing the number of times the actor must
  attack or guard.
  - The number counter will start from the moment Equippable Medal is
    listed in the learnable list.
  - This does NOT take into account previous actions before listing.

---

<Equip Medal Learn Use Skills: x>
<Equip Medal Learn Use Physical Skills: x>
<Equip Medal Learn Use Magical Skills: x>
<Equip Medal Learn Use Certain Hit Skills: x>

- Used for: Armor Notetags
- Adds an unlock condition that the actor must use 'x' skills.
- If this Equippable Medal is found in the learnable list and all unlock
  conditions in addition to this unlock condition are met, then the actor
  will learn the Equippable Medal.
- Replace 'x' with a number representing the number of times the actor must
  use skills.
  - The number counter will start from the moment Equippable Medal is
    listed in the learnable list.
  - This does NOT take into account previous actions before listing.
- The 'Skills' notetag variant allows any kind of skill usage.
- The 'Physical Skills' notetag variant requires physical hit skills.
- The 'Magical Skills' notetag variant requires magical hit skills.
- The 'Certain Hit Skills' notetag variant requires certain hit skills.

---

<Equip Medal Learn SType id: x>
<Equip Medal Learn SType name: x>

- Used for: Armor Notetags
- Adds an unlock condition that the actor must use 'x' skills that belong to
  a specific skill type.
- If this Equippable Medal is found in the learnable list and all unlock
  conditions in addition to this unlock condition are met, then the actor
  will learn the Equippable Medal.
- Replace 'id' with a number representing the needed skill type's ID number.
- Replace 'name' with text representing the needed skill type's name.
- Replace 'x' with a number representing the number of times the actor must
  use skills belonging to the needed skill type.

---

<Equip Medal Learn Use Items: x>

- Used for: Armor Notetags
- Adds an unlock condition that the actor must use 'x' items.
- If this Equippable Medal is found in the learnable list and all unlock
  conditions in addition to this unlock condition are met, then the actor
  will learn the Equippable Medal.
- Replace 'x' with a number representing the number of times the actor must
  use items.
  - The number counter will start from the moment Equippable Medal is
    listed in the learnable list.
  - This does NOT take into account previous actions before listing.
- Any kind of item can be used.

---

<Equip Medal Learn Inflict Critical Times: x>
<Equip Medal Learn Receive Critical Times: x>

- Used for: Armor Notetags
- Adds an unlock condition that the actor must inflict or receive 'x'
  critical hits from actions.
- If this Equippable Medal is found in the learnable list and all unlock
  conditions in addition to this unlock condition are met, then the actor
  will learn the Equippable Medal.
- Replace 'x' with a number representing the number of times the actor must
  inflict or receive critical hits.
  - The number counter will start from the moment Equippable Medal is
    listed in the learnable list.
  - This does NOT take into account previous actions before listing.
- The 'Inflict' notetag variant requires the critical hit to be caused by
  the actor.
- The 'Receive' notetag variant requires the critical hit to be caused
  against the actor.

---

<Equip Medal Learn Miss Times: x>
<Equip Medal Learn Evade Times: x>

- Used for: Armor Notetags
- Adds an unlock condition that the actor must miss or evade 'x' actions.
- If this Equippable Medal is found in the learnable list and all unlock
  conditions in addition to this unlock condition are met, then the actor
  will learn the Equippable Medal.
- Replace 'x' with a number representing the number of times the actor must
  miss or evade actions.
  - The number counter will start from the moment Equippable Medal is
    listed in the learnable list.
  - This does NOT take into account previous actions before listing.
- The 'Miss' notetag variant requires the actor to miss an action.
- The 'Evade' notetag variant requires the actor to evade an action.

---

<Equip Medal Learn Inflict Element id Damage: x>
<Equip Medal Learn Inflict Element name Damage: x>

<Equip Medal Learn Receive Element id Damage: x>
<Equip Medal Learn Receive Element name Damage: x>

- Used for: Armor Notetags
- Adds an unlock condition that the actor must inflict or receive damage
  from a specific element 'x' times.
- If this Equippable Medal is found in the learnable list and all unlock
  conditions in addition to this unlock condition are met, then the actor
  will learn the Equippable Medal.
- Replace 'id' with a number representing the element ID number.
- Replace 'name' with text representing the element's name.
- Replace 'x' with a number representing the number of times the actor must
  inflict or receive damage from a specific element.
  - The number counter will start from the moment Equippable Medal is
    listed in the learnable list.
  - This does NOT take into account previous actions before listing.
- The 'Inflict' notetag variant requires the elemental damage to be caused
  by the actor.
- The 'Receive' notetag variant requires the elemental damage to be caused
  against the actor.

---

<Equip Medal Learn Inflict State id: x>
<Equip Medal Learn Inflict State name: x>

<Equip Medal Learn Receive State id: x>
<Equip Medal Learn Receive State name: x>

- Used for: Armor Notetags
- Adds an unlock condition that the actor must inflict or receive a specific
  state 'x' times.
- If this Equippable Medal is found in the learnable list and all unlock
  conditions in addition to this unlock condition are met, then the actor
  will learn the Equippable Medal.
- Replace 'id' with a number representing the state ID number.
- Replace 'name' with text representing the state's name.
- Replace 'x' with a number representing the number of times the actor must
  inflict or receive a specific state.
  - The number counter will start from the moment Equippable Medal is
    listed in the learnable list.
  - This does NOT take into account previous actions before listing.
- The 'Inflict' notetag variant requires the target state damage to be caused
  by the actor.
- The 'Receive' notetag variant requires the target state damage to be caused
  against the actor.

---

<Equip Medal Learn Defeat name Trait: x>

- Used for: Armor Notetags
- Requires VisuMZ_1_ElementStatusCore!
- Adds an unlock condition that the actor must defeat enemies with specific
  trait sets 'x' times.
- If this Equippable Medal is found in the learnable list and all unlock
  conditions in addition to this unlock condition are met, then the actor
  will learn the Equippable Medal.
- Replace 'name' with text representing the trait set's name.
- Replace 'x' with a number representing the number of times the actor must
  defeat enemies with the target trait set.

---

<Equip Medal Learn Inflict Total Damage: x>
<Equip Medal Learn Receive Total Damage: x>

<Equip Medal Learn Inflict Total Healing: x>
<Equip Medal Learn Receive Total Healing: x>

- Used for: Armor Notetags
- Adds an unlock condition that the actor must inflict or receive a total
  amounts of damage or healing since the time the medal is listed.
- If this Equippable Medal is found in the learnable list and all unlock
  conditions in addition to this unlock condition are met, then the actor
  will learn the Equippable Medal.
- Replace 'x' with a number representing the total number of damage and
  healing the actor must reach.
  - The number counter will start from the moment Equippable Medal is
    listed in the learnable list.
  - This does NOT take into account previous actions before listing.
- The 'Inflict' notetag variant requires the damage/healing to be caused
  by the actor.
- The 'Receive' notetag variant requires the damage/healing to be caused
  against the actor.

---

<Equip Medal Learn Kill Count: x>
<Equip Medal Learn Death Count: x>
<Equip Medal Learn Assist Count: x>

- Used for: Armor Notetags
- Adds an unlock condition that the actor must fulfill the needed amount of
  kills, suffer the amount of deaths, or partake in the number of assists
  since the time the medal is listed.
- If this Equippable Medal is found in the learnable list and all unlock
  conditions in addition to this unlock condition are met, then the actor
  will learn the Equippable Medal.
- Replace 'x' with a number representing the number of kills, deaths, or
  assists the actor must reach.
  - The number counter will start from the moment Equippable Medal is
    listed in the learnable list.
  - This does NOT take into account previous actions before listing.
- The 'Kill' notetag variant refers to the number of enemies directly
  defeated by the actor (death via slip damage or events do not count).
- The 'Death' notetag variant refers to the number of times the actor must
  die (ie reaching 0 HP or receiving the Death state).
- The 'Assist' notetag variant refers to the number of times the actor is
  present in battle when an enemy is defeated and not directly by the actor.

---

<Equip Medal Learn Have Gold: x>

- Used for: Armor Notetags
- Adds an unlock condition that the party must have 'x' gold present at the
  moment.
- If this Equippable Medal is found in the learnable list and all unlock
  conditions in addition to this unlock condition are met, then the actor
  will learn the Equippable Medal.
- Replace 'x' with a number representing the needed amount of gold.

---

<Equip Medal Learn Have Item id: x>
<Equip Medal Learn Have Item name: x>

<Equip Medal Learn Have Weapon id: x>
<Equip Medal Learn Have Weapon name: x>

<Equip Medal Learn Have Armor id: x>
<Equip Medal Learn Have Armor name: x>

- Used for: Armor Notetags
- Adds an unlock condition that the party must have 'x' quantities of a
  specific item, weapon, or armor present at the moment.
- If this Equippable Medal is found in the learnable list and all unlock
  conditions in addition to this unlock condition are met, then the actor
  will learn the Equippable Medal.
- Replace 'id' with a number representing the ID of the item, weapon, or
  armor needed for the medal.
- Replace 'name' with text representing the name of the item, weapon, or
  armor needed for the medal.
- Replace 'x' with a number representing the needed amount of the item,
  weapon, or armor.

---

<Equip Medal Learn Reach Param name: x>

- Used for: Armor Notetags
- Adds an unlock condition that the actor must have 'x' value for its base
  parameter value at the moment.
- If this Equippable Medal is found in the learnable list and all unlock
  conditions in addition to this unlock condition are met, then the actor
  will learn the Equippable Medal.
- Replace 'name' with 'MaxHP', 'MaxMP', 'ATK', 'DEF', 'MAT', 'MDF', 'AGI',
  or 'LUK' to determine which parameter to be referenced.
- Replace 'x' with a number representing the needed parameter value.

---

<Equip Medal Learn Reach XParam name: x%>

- Used for: Armor Notetags
- Adds an unlock condition that the actor must have 'x' value for its
  X-parameter value at the moment.
- If this Equippable Medal is found in the learnable list and all unlock
  conditions in addition to this unlock condition are met, then the actor
  will learn the Equippable Medal.
- Replace 'name' with 'HIT', 'EVA', 'CRI', 'CEV', 'MEV', 'MRF', 'CNT',
  'HRG', 'MRG', 'TRG' to determine which parameter to be referenced.
- Replace 'x' with a number representing the needed parameter percent value.

---

<Equip Medal Learn Reach SParam name: x%>

- Used for: Armor Notetags
- Adds an unlock condition that the actor must have 'x' value for its
  S-parameter value at the moment.
- If this Equippable Medal is found in the learnable list and all unlock
  conditions in addition to this unlock condition are met, then the actor
  will learn the Equippable Medal.
- Replace 'name' with 'TGR', 'GRD', 'REC', 'PHA', 'MCR', 'TCR', 'PDR',
  'MDR', 'FDR', 'EXR' to determine which parameter to be referenced.
- Replace 'x' with a number representing the needed parameter percent value.

---


Plugin Commands

PluginCommandsMZ.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 MZ.

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

---


The following are Plugin Commands that come with this plugin. They can be accessed through the Plugin Command event command.

---

Actor Plugin Commands

VisuMZ.149.jpg

---

Actor: Gain Medal EXP
- Target actor(s) gains equippable Medal EXP for all currently
- equipped medals. Applies any Medal EXP bonus rates.

  Actor ID(s):
  - Select which Actor ID(s) to affect.

  Medal EXP:
  - Determine how much Medal EXP target actor(s) gains.

  Show Text Popup?:
  - Shows text popup of actor(s) learning the medal if any?

---

Actor: Add Medal EXP
- Target actor(s) gains equippable Medal EXP for all currently
- equipped medals. Does not apply any Medal EXP bonus rates.

  Actor ID(s):
  - Select which Actor ID(s) to affect.

  Medal EXP:
  - Determine how much Medal EXP target actor(s) receives.

  Show Text Popup?:
  - Shows text popup of actor(s) learning the medal if any?

---

Actor: Learn Equippable Medal
- Target actor(s) learns equippable medal(s).
-

  Actor ID(s):
  - Select which Actor ID(s) to affect.

  Medal ID(s):
  - Select which Armor ID(s) to add as an equippable medal.

  Show Text Popup?:
  - Shows text popup of actor(s) learning the medal?

---

Actor: Forgets Equippable Medal
- Target actor(s) forgets equippable medal(s).
-

  Actor ID(s):
  - Select which Actor ID(s) to affect.

  Medal ID(s):
  - Select which Armor ID(s) to forget as an equippable medal.

---

Actor: Add Unlearned Equippable Medal
- Gives target actor(s) the ability to learn target medal(s).
-

  Actor ID(s):
  - Select which Actor ID(s) to affect.

  Medal ID(s):
  - Select which Armor ID(s) to add as an unlearned equippable medal.

---

Actor: Remove Unlearned Equippable Medal
- Removes target actor(s) the ability to learn target medal(s).
-

  Actor ID(s):
  - Select which Actor ID(s) to affect.

  Medal ID(s):
  - Select which Armor ID(s) to remove unlearned equippable medal.

---

Global Plugin Commands

VisuMZ.149.jpg

---

Global: Learn Equippable Medal
- All actors learns equippable medal(s).
-

  Medal ID(s):
  - Select which Armor ID(s) to add as an equippable medal.

  Show Text Popup?:
  - Shows text popup of party learning the medal?

---

Global: Forgets Equippable Medal
- All actors forgets equippable medal(s).
-

  Medal ID(s):
  - Select which Armor ID(s) to forget as an equippable medal.

---

Global: Add Unlearned Equippable Medal
- Gives all actors the ability to learn target medal(s).
-

  Medal ID(s):
  - Select which Armor ID(s) to add as an unlearned equippable medal.

---

Global: Remove Unlearned Equippable Medal
- Removes from all actors the ability to learn target medal(s).
-

  Medal ID(s):
  - Select which Armor ID(s) to remove unlearned equippable medal.

---

System Plugin Commands

VisuMZ.149.jpg

---

System: Show Medal in Equip Scene?
- Shows/hides Medal command inside the equip scene.
-

  Show/Hide?:
  - Shows/hides Medal command inside the equip scene.

---


Plugin Parameters

General Settings

EquipMedalSys Preview1.png

EquipMedalSys Params1.png

General settings for the Equip Medal System.

---

General Settings:

 Default Show Command:
 - Shows Medal Command by default?
 Auto-Equip on Learn:
 - Automatically equips newly learned Medals.
 Text Popup on Learn:
 - Produce a text popup when a Medal is learned?
   Text Popup Format:
   - Text format used for text popup.
   - %1 - Actor, %2 - Medal, %3 - Icon

---

Slot Settings:

 Slot Formula:
 - What is the formula used to determine current max capacity?
 Default Slot Cost:
 - What is the default capacity cost of equipping a Medal?
 Minimum Slot Cap:
 - What is the minimum capacity value?
 Maximum Slot Cap:
 - What is the maximum capacity value?
 Check Over-Capacity:
 - Checks over-capacity when EXP changes.

---

Medal EXP Settings:

 EXP Formula:
 - What is the formula used to determine how much exp an enemy gives?
 - Variable 'user' refers to the defeated enemy.
   Alive Actors?:
   - Do actors have to be alive to receive Medal EXP from defeated enemies?
 Show During Victory?:
 - Show how much Medal EXP is earned during victory phase?

---


Vocabulary Settings

EquipMedalSys Preview2.png

EquipMedalSys Params2.png

These settings let you adjust the text displayed for this plugin.

---

Medal EXP:

 Medal EXP Name:
 - Text used to represent Medal EXP.
 Medal EXP Icon:
 - Icon used to represent Medal EXP.
 Medal EXP Name Format:
 - Text format used to display Medal EXP name. %1 - Name, %2 - Icon
 Reward Message Format:
 - Text format used when Medal EXP is received. %1 - Amount, %2 - Name

---

Scene_Equip:

 Command Name:
 - Text used for the Medals Command.
   Command Icon:
   - Icon used for the Medals command and for any medals that are displayed
     without any icon.
 Capacity Text:
 - Text used for Medals Capacity.
   Capacity Icon:
   - Icon used to represent Medals Capacity when displayed as a limited
     resource.
   Capacity Format:
   - Text format used to representing Capacity.
   - %1 - Current, %2 - Max, %3 - Icon
 Cost Format:
 - Text format used for Capacity Cost. %1 - Cost, %2 - Icon
   Unlearned Text:
   - Text displayed instead of cost for unlearned Medals.
 Gauge EXP Format:
 - Text format used when displaying Medal EXP in a gauge.
 - %1 - Current, %2 - Needed, %3 - Percent
   Decimal Places:
   - How many decimal places should the percent digits go out to for the
     percent value?
   Mastered Medal Text:
   - Text used in Medal EXP Gauge for mastered medals.
   - You may use text codes.

--- Help Window:

 Description Format:
 - Text format used to create help descriptions.
 - %1 - Unlocking Conditions
 Word Wrap?:
 - Apply word wrap to unlock conditions?
 - Requires VisuMZ_1_MessageCore!
 Spacing?:
 - Add spacing between conditions?
 Spacer:
 - Text inserted between conditions.
 Empty Descriptions:
 - Text used when no condition text is made.

---

Unlock Condition Text:

 Condition Met Color:
 - Use text colors from the Window Skin only.
 Progress Format:
 - Text format used to indicate progress amount.
 - %1 - Progress Text
   Fraction Format:
   - Text format used for progress fraction.
   - %1 - Current, %2 - Goal
   Percent Format:
   - Text format used for percentile value.
   - %1 - Percent
   Length Limit:
   - What is the character limit before a percentage is used instead
     fractions for progress text?
   Complete:
   - Progress text used when unlock condition is fulfilled.
 Level Format:
 - Text format used for level conditions.
 - %1 - Level, %2 - Progress
 Battle Format:
 - Text format used for fought battles.
 * %1 - Needed, %2 - Progress
   Victory Format:
   - Text format used for victorious battles.
   - %1 - Needed, %2 - Progress
   Escape Format:
   - Text format used for escaped battles.
   - %1 - Needed, %2 - Progress
   Defeat Format:
   - Text format used for lost battles.
   - %1 - Needed, %2 - Progress
 Attack Format:
 - Text format used for attack times.
 - %1 - Needed, %2 - Progress
   Guard Format:
   - Text format used for guard times.
   - %1 - Needed, %2 - Progress
 Skill Format:
 - Text format used for skill times.
 - %1 - Needed, %2 - Progress
   Physical Skills:
   - Text format used for physical skills.
   - %1 - Needed, %2 - Progress
   Magical Skills:
   - Text format used for magical skills.
   - %1 - Needed, %2 - Progress
   Certain Hit Skills:
   - Text format used for certain hit skills.
   - %1 - Needed, %2 - Progress
 Item Format:
 - Text format used for item uses.
 - %1 - Needed, %2 - Progress
 Deal Criticals:
 - Text format used for dealing criticals.
 - %1 - Needed, %2 - Progress
   Take Criticals:
   - Text format used for taking criticals.
   - %1 - Needed, %2 - Progress
 Miss Format:
 - Text format for missing attacks.
 - %1 - Needed, %2 - Progress
   Evade Format:
   - Text format for evading attacks.
   - %1 - Needed, %2 - Progress
 SType Use:
 - Text format for using SType Skills.
 - %1 - Needed, %2 - Progress, %3 - Type Text
 Deal Element DMG:
 - Text format used for inflicting element damage.
 - %1 - Needed, %2 - Progress, %3 - Element
   Take Element DMG:
   - Text format used for receiving element damage.
   - %1 - Needed, %2 - Progress, %3 - Element
 Deal State:
 - Text format used for inflicting states.
 - %1 - Needed, %2 - Progress, %3 - State
   Take State:
   - Text format used for receiving states.
   - %1 - Needed, %2 - Progress, %3 - State
 Trait Slayer:
 - Text format for slaying trait types.
 - %1 - Needed, %2 - Progress, %3 - Type Text
 Total Damage Dealt:
 - Text format for total damage dealt.
 - %1 - Needed, %2 - Progress
   Total Damage Taken:
   - Text format for total damage received.
   - %1 - Needed, %2 - Progress
 Total Healing Dealt:
 - Text format for total healing given.
 - %1 - Needed, %2 - Progress
   Total Healing Taken:
   - Text format for total healing taken.
   - %1 - Needed, %2 - Progress
 Kills Format:
 - Text format for kills performed.
 - %1 - Needed, %2 - Progress
   Deaths Format:
   - Text format for deaths in battle.
   - %1 - Needed, %2 - Progress
 Assists Format:
   - Text format for assists made.
   - %1 - Needed, %2 - Progress
 Reach Gold Total:
 - Text format for reaching gold quantity.
 - %1 - Needed, %2 - Progress, %3 - Gold
   Reach Item Total:
   - Text format for reaching item quantity.
   - %1 - Needed, %2 - Progress, %3 - Item
   Reach Weapon Total:
   - Text format for reaching weapon quantity.
   - %1 - Needed, %2 - Progress, %3 - Weapon
   Reach Armor Total:
   - Text format for reaching armor quantity.
   - %1 - Needed, %2 - Progress, %3 - Armor
 Reach Base Param:
 - Text format for reaching base Param amount.
 - %1 - Needed, %2 - Progress, %3 - Param Name
   Reach XParam Amount:
   - Text format for reaching X Param amount.
   - %1 - Needed, %2 - Progress, %3 - XParam Name
   Reach SParam Amount:
   - Text format for reaching S Param amount.
   - %1 - Needed, %2 - Progress, %3 - SParam Name

---


Window Settings

EquipMedalSys Preview3.png

EquipMedalSys Params3.png

These settings let you adjust the windows displayed for this plugin.

---

Equip Medal List:

 Background Type:
 - Select background type for this window.
 Equipped Color:
 - Use #rrggbb for custom colors or regular numbers for text colors from
   the Window Skin.
 Show Capacity Costs?:
 - Shows capacity costs on Medals?
   Show 0 Costs?:
   - Shows capacity costs if they cost 0?
   Show 1 Costs?:
   - Shows capacity costs if they only cost 1?
   Show Cost Numbers?:
   - Shows capacity cost values?
   - If not, displays multiple icons instead.
     Cost Icon Limit:
     - If "Show Cost Numbers" is false, this is how many icons can be
       displayed max before showing number costs.
 Sort Style:
 - How do you wish to sort medals by?
 Show Unlearned?:
 - Shows unlearned medals in the list window?
   Separate Unlearned?:
   - Separate unlearned medals from learned medals?
   Mask Unlearned?:
   - Masks unlearned medals in list window?
     Mask Icon:
     - What is the icon used for masked medals?
     Mask Character:
     - Text used for masking per individual character.
     Italics?:
     - Use italics for masked names?
 Hide Former Evolved?:
 - Hide formerly evolved medals?
 Medal EXP Gauge Style:
 - Select the gauge style to use for medal EXP.
 - Requires VisuMZ_3_VisualGaugeStyles!
   EXP Gauge Color 1:
   - Use #rrggbb for custom colors or regular numbers for text colors from
     the Window Skin.
   EXP Gauge Color 2:
   - Use #rrggbb for custom colors or regular numbers for text colors from
     the Window Skin.
   Gauge Width Modifier:
   - Adjust the gauge width by this amount.
   EXP Text Offset X:
   - Offsets the Medal EXP Gauge Text X.
   - Negative: left. Positive: right.
   EXP Text Offset Y:
   - Offsets the Medal EXP Gauge Text Y.
   - Negative: up. Positive: down.

---

Medal Status Window:

 Show Window?:
 - Shows this window in the scene?
 Background Type:
 - Select background type for this window.
 Max Capacity Color:
 - Use text colors from the Window Skin only.

---



Terms of Use

1. These plugins may be used in free or commercial games provided that they have been acquired through legitimate means at VisuStella.com and/or any other official approved VisuStella sources. Exceptions and special circumstances that may prohibit usage will be listed on VisuStella.com.

2. All of the listed coders found in the Credits section of this plugin must be given credit in your games or credited as a collective under the name: "VisuStella".

3. You may edit the source code to suit your needs, so long as you do not claim the source code belongs to you. VisuStella also does not take responsibility for the plugin if any changes have been made to the plugin's code, nor does VisuStella take responsibility for user-provided custom code used for custom control effects including advanced JavaScript notetags and/or plugin parameters that allow custom JavaScript code.

4. You may NOT redistribute these plugins nor take code from this plugin to use as your own. These plugins and their code are only to be downloaded from VisuStella.com and other official/approved VisuStella sources. A list of official/approved sources can also be found on VisuStella.com.

5. VisuStella is not responsible for problems found in your game due to unintended usage, incompatibility problems with plugins outside of the VisuStella MZ library, plugin versions that aren't up to date, nor responsible for the proper working of compatibility patches made by any third parties. VisuStella is not responsible for errors caused by any user-provided custom code used for custom control effects including advanced JavaScript notetags and/or plugin parameters that allow JavaScript code.

6. If a compatibility patch needs to be made through a third party that is unaffiliated with VisuStella that involves using code from the VisuStella MZ library, contact must be made with a member from VisuStella and have it approved. The patch would be placed on VisuStella.com as a free download to the public. Such patches cannot be sold for monetary gain, including commissions, crowdfunding, and/or donations.

7. If this VisuStella MZ plugin is a paid product, all project team members must purchase their own individual copies of the paid product if they are to use it. Usage includes working on related game mechanics, managing related code, and/or using related Plugin Commands and features. Redistribution of the plugin and/or its code to other members of the team is NOT allowed unless they own the plugin itself as that conflicts with Article 4.

8. Any extensions and/or addendums made to this plugin's Terms of Use can be found on VisuStella.com and must be followed.

Terms of Use: Japanese


『VisuStella MZ』利用規約

1. これらのプラグインは、VisuStella.comおよび/または公式に承認されたVisuStellaのソースから合法的な手段で入手したものである限り、フリーゲームや商用ゲームに使用することができます。例外的に使用が禁止される場合については、VisuStella.comの記載をご確認ください。

2. 本プラグインの「クレジット」部分に記載されているすべてのコーダーの名前は、ゲーム内にクレジット表記を行うか、もしくは「VisuStella」という名前の下にまとめて表記する必要があります。

3. ソースコードを自分のものだと主張しない限りは、必要に応じて編集することが可能です。ただしプラグインのコードに変更が加えられた場合、VisuStellaはそのプラグインに対して一切の責任を負いません。高度なJavaScriptのノートタグやJavaScriptコードを許可するプラグインのパラメータを含む、カスタムコントロールエフェクトに使用される、ユーザー提供のカスタムコードについても、VisuStellaは一切の責任を負いません。

4. これらのプラグインやプラグイン内のコードを、「自分のもの」として再配布したり使用したりすることはできません。これらのプラグインとそのコードは、VisuStella.comおよび、その他の公式/承認済みVisuStellaソースからのみダウンロードすることができます。公式/承認済みのソースのリストは、VisuStella.comでご確認いただけます。

5. VisuStellaは、意図しない使用方法による問題、VisuStella MZライブラリ以外のプラグインとの非互換性の問題、プラグインのバージョンが最新でないことによる問題、第三者による互換性パッチが適切に動作していないことなどが原因でゲーム内で発生した問題については、一切の責任を負いません。VisuStellaは、高度なJavaScriptのノートタグやJavaScriptコードを許可するプラグインのパラメータを含む、カスタムコントロールエフェクトに使用される、ユーザー提供のカスタムコードに起因するエラーについても、一切の責任を負いません。

6. VisuStella MZライブラリのコードを使用した互換性パッチをVisuStellaとは関係のない第三者を通じて作成する必要がある場合は、まずVisuStellaのメンバーと連絡を取り、承認を得る必要があります。パッチはVisuStella.comに公開され、誰でも無料でダウンロードすることができるようになります。このようなパッチを、制作発注やクラウドファンディングの対象にしたり、寄付などの金銭的な利益を得るために販売することはできません。

7. このVisuStella MZプラグインが商用製品である場合、プロジェクトチームのすべてのメンバーは、それを使用するため、それぞれ製品を購入しなければなりません。使用方法には、関連するゲームメカニクスの作業、関連するコードの管理、および/または関連するプラグインコマンドや機能の使用、が含まれます。プラグインそのものやそのコードをチームの他のメンバーに再配布することは第4項に抵触するため、そのメンバーがプラグインそのものを所有していない限りは許可されません。

8. このプラグインの利用規約の追加項目や補足については、VisuStella.comに掲載されていますので、それを参照し従ってください。


Credits

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

Team VisuStella


Changelog

Version 1.03: May 16, 2024

  • Bug Fixes!
    • Fixed a bug where equipped medals did not play nicely when given MaxHP and MaxMP parameter related traits. Fix made by Irina.


Version 1.02: April 18, 2024

  • Bug Fixes!
    • Fixed a bug where switching to different actors while the medal menu is selected will cause a window stacking bug. Fix made by Irina.
    • Fixed a bug where using mouse controls to select Medals from the Equip menu is not optimal. Fix made by Irina.


Version 1.01: March 14, 2024

  • Bug Fixes!
    • Fixed a compatibility issue with Equip Set Bonuses where the set tooltip window would no disappear upon selecting the Medal command. Fix by Arisu.
    • Fixed a bug where hovering over the Medal command would stop making the hover change work for the other commands. Fix by Arisu.
    • Fixed a bug where pressing 'up' with Modern Controls would not return back to the command window. Fix by Arisu.
    • Fixed a bug where elemental damage, states, and stypes, taken and dealt was not making progress for learning new medals. Fix by Arisu.
    • Fixed a bug where <Equip Medal Evolves Into Next: exp> notetag was suppressed by the other notetag. Fix made by Arisu.
    • Fixed a bug where the <Equip Medal Evolves Into Next: exp> notetag does not require the proper amount of EXP. Fix made by Arisu.
  • Feature Update!
    • Added a fail safe where if both the optimize and clear commands are removed from the equip scene, the medal command can still be visible. Update made by Arisu.
    • If a medal becomes hidden, it is no longer considered equipped.
    • Inflict and Receive State effects no longer require the target to be unaffilicted by the state before to count.


Version 1.00 Official Release Date: March 27, 2024

  • Finished Plugin!

See Also


End of Helpfile