Victory Aftermath VisuStella MZ

From Yanfly.moe Wiki
Revision as of 19:34, 17 October 2020 by Yanfly (talk | contribs) (General Settings)
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.

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


UpdatePlugins.png

Click here to learn how to update plugins.


Troubleshooting.jpg

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



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


Support VisuStella

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


Introduction

The Victory Aftermath plugin consolidates the rewards granted upon finishing a battle successfully into one screen (or more if there are level ups). This helps reduce the amount of button presses needed to display similar information by default. The level up screens will also display parameter changes and new skills acquired in addition to victory quotes.

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

  • Consolidates EXP, Gold, and Items acquired through battle rewards into one battle screen.
  • EXP gauges for currently active battle party will be displayed on the same screen to indicate progress.
  • Upon leveling up, individual screens can be shown (optionally) to display parameter changes, new skills acquired, and level up quotes.
  • Plugin Commands can be used to clear/add new quotes at any time.
  • Plugin Commands can be used by bypass certain parts of the Victory Aftermath segments or the entire thing completely.

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 3

This plugin is a Tier 3 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.


Extra Features

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

---

VictoryAftermathScreenshotNew.png

Core Engine VisuStella MZ

The EXP gauge colors will match the color settings found in the Core Engine's Plugin Parameters instead of defaulting to specific colors.

The continue message will display any changed input keys designated by the Core Engine's Plugin Parameters.

---

VictoryAftermathLevelUpNew.png

Main Menu Core VisuStella MZ

Upon leveling up, the Menu Image will show up (optional) as a bust during the quote segment.

---

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.

---

VictoryAftermathLevelUpNew.png

<Level Up Quotes>
 text
 text
 text
 text
 <New Quote>
 text
 text
 text
 text
 <New Quote>
 text
 text
 text
 text
</Level Up Quotes>

- Used for: Actor Notetags
- Description
- Replace 'text' with the text you'd want the actor to say when leveling up.
- The <New Quote> tag is used between the <Level Up Quotes> notetags to
  separate quotes.
- If an actor has multiple quotes (due to the <New Quote> notetag), then a
  random quote will be selected upon level up.
- If this notetag is not found inside an actor's notebox, a random level up
  quote will be selected from the Plugin Parameters => Level Up => Quotes =>
  Level Up Quotes plugin parameter.

---

VictoryAftermathSkillLearnNew.png

<New Skill Quotes>
 text
 text
 text
 text
 <New Quote>
 text
 text
 text
 text
 <New Quote>
 text
 text
 text
 text
</New Skill Quotes>

- Used for: Actor Notetags
- Description
- Replace 'text' with the text you'd want the actor to say when leveling up
  in addition to learning a new skill upon leveling up.
- The <New Quote> tag is used between the <New Skill Quotes> notetags to
  separate quotes.
- If an actor has multiple quotes (due to the <New Quote> notetag), then a
  random quote will be selected upon level up and learning a new skill.
- If this notetag is not found inside an actor's notebox, a random new skill
  quote will be selected from the Plugin Parameters => Level Up => Quotes =>
  New Skill Quotes plugin parameter.

Plugin Commands

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

---

VictoryAftermathLevelUpNew.png

VictoryAftermathPluginCommand1.png

Actor: Add Level Up Quotes
- Add new entries target actor's level up quotes.

  Actor ID:
  - Select ID of target actor to add quotes for.

  New Quotes:
  - Add new entries to actor's level up quotes.
  - Text codes allowed. %1 - Actor's Name

---

VictoryAftermathSkillLearnNew.png

VictoryAftermathPluginCommand2.png

Actor: Add New Skill Quotes
- Add new entries target actor's new skill quotes.

  Actor ID:
  - Select ID of target actor to add quotes for.

  New Quotes:
  - Add new entries to actor's new skill quotes.
  - Text codes allowed. %1 - Actor's Name

---

VictoryAftermathPluginCommand3.png

Actor: Clear Level Up Quotes
- Clear target actor's level up quotes.

  Actor ID:
  - Select ID of target actor to clear quotes for.

---

VictoryAftermathPluginCommand4.png

Actor: Clear New Skill Quotes
- Clear target actor's new skill quotes.

  Actor ID:
  - Select ID of target actor to clear quotes for.

---

System Plugin Commands

---

VictoryAftermathScreenshotNew.png

VictoryAftermathPluginCommand5.png

System: Bypass Victory Motion
- Bypass actors performing their victory motion?

  Bypass?:
  - Bypass actors performing their victory motion?

---

VictoryAftermathPluginCommand6.png

System: Bypass Victory Music
- Bypass playing the victory music?

  Bypass?:
  - Bypass playing the victory music?

---

VictoryAftermathPluginCommand7.png

System: Bypass Victory Phase
- Bypass the entire victory phase and all aspects about it?

  Bypass?:
  - Bypass the entire victory phase and all aspects about it?

---

Plugin Parameters

General Settings

VictoryAftermathScreenshotNew.png

VictoryAftermath Update9 Params1.png

The general settings Plugin Parameters control the overall settings found within the main aspects of the Victory Aftermath sequence.

---

General Settings

 Fade In Speed:
 - Fade in speed for the victory window.
 Hide Delay (MS):
 - Delay in milliseconds before hiding the UI Windows.
 Show Delay (MS):
 - Delay in milliseconds before showing the Victory Windows.
 Update Duration:
 - Duration in frames on updating actor EXP gauges.
 Auto Skip Auto Battle?:
 - Skip the Victory Aftermath sequence if the player has decided to use
   the party Auto Battle command?

---

Collapse Effect

 Normal Collapse Wait?:
 - Wait for the normal collapse effect to finish?
 Boss Collapse Wait?:
 - Wait for the boss collapse effect to finish?

---

Victory Music

 Victory BGM:
 - Background music to play during the victory sequence.
 Volume:
 - Volume of the sound effect played.
 Pitch:
 - Pitch of the sound effect played.
 Pan:
 - Pan of the sound effect played.

---

Level Up Settings

VictoryAftermathLevelUpNew.png

VictoryAftermathParams2.png

When actors level up, extra screens will be displayed in the Victory Aftermath sequence. Alter these settings to best fit your game.

---

General

 Enable?:
 - Enable the Level Up portion of the Victory Aftermath phase?
 Show Face?:
 - Show the actor's face?
 Show Param Change?:
 - Show an extra column for parameter value differences?
 Shown Max Skills:
 - The maximum amount of skills that are displayed.
 - This is due to limited screen space.

---

Quotes

 Level Up Quotes:
 - A list of generic level up quotes for those who don't have the
   <Level Up Quote> notetags.
 - %1 - Actor Name
 New Skill Quotes:
 - A list of generic level up quotes for those who don't have the
   <New Skill Quote> notetags.
 - %1 - Actor Name

---

VisuMZ_1_MainMenuCore - The following Plugin Parameters require VisuMZ_1_MainMenuCore.

 Show Bust?:
 - Show the actor's menu image as a bust?
 Bust Position X:
 - Positon to center the actor's menu image bust.
 - You may use JavaScript code.
 Bust Position Y:
 - Positon to anchor the actor's menu image bust.
 - You may use JavaScript code.
 Bust Scale:
 - The amount to scale the actor's menu image bust.

---

Vocabulary Settings

VictoryAftermathParams3.png

There's certain diction used in the Victory Aftermath plugin that's not set anywhere else in the game. Change the settings to make it fit your game.

---

Vocabulary

 Continue Format:
 - Text format for continue message.
 - %1 - OK key, %2 - Cancel key
 OK Button:
 - Text used to represent the OK button.
 - If VisuMZ_0_CoreEngine is present, ignore this.
 Cancel Button:
 - Text used to represent the Cancel button.
 - If VisuMZ_0_CoreEngine is present, ignore this.
 Level Format:
 - Text format for actor level.
 - %1 - Level
 Level Up:
 - Text format for reaching a level up.
 Sound Effect:
 - Sound effect played when a level up occurs.
 Text Color:
 - Use #rrggbb for custom colors or regular numbers for text colors
   from the Window Skin.
 New Skill Format:
 - Text format describing that a new skill has been learned.
 - %1 - Actor Name
 Reward Items:
 - Text displayed for items rewarded.
 Victory Title:
 - Text displayed at the top of the victory screen.

---


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: October 18, 2020

  • Documentation Update!
    • Help file updated for new features.
  • Feature Update!
    • Bounce SFX pitch plugin parameter is now uncapped.
  • New Features!
    • New plugin parameters added by Yanfly.
      • Plugin Parameters > General > Collapse Effect > Normal Collapse Wait?
      • Plugin Parameters > General > Collapse Effect > Boss Collapse Wait?
        • These settings enable you to decide if you want the Victory Aftermath to wait until collapse effects are finished before continuing.
      • Plugin Parameters > General > Music > Volume
      • Plugin Parameters > General > Music > Pitch
      • Plugin Parameters > General > Music > Pan
        • Adjusts the volume, pitch, and pan of the victory music.


Version 1.02: September 13, 2020

  • Feature Update!
    • Victory Aftermath windows now wait until all boss collapse effects are done before showing. Update added by Olivia.
  • New Features!
    • New Plugin Parameter under General Settings: Auto Skip Auto Battle?
      • Skip the Victory Aftermath sequence if the player has decided to use the party Auto Battle command?
      • Feature added by Olivia

Version 1.01: September 6, 2020

  • New Features!
    • New Plugin Parameters added in Level Up Settings for disabling the back rectangles and/or changing their colors.

Version 1.00

  • Plugin released!

Help File