Battle Voices 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


VisuMZ.131.jpg

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.131.jpg

This plugin allows you to create battle voice sets and apply them to actors and enemies in your game. There are voice lines for various occassions in battle ranging from simple conditions like saying something at the start of battle to using specific hit types for skills and even going as far as having lines to say upon the adding and removing of states.

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

  • Create battle voice sets that you can apply to actors and enemies alike.
  • Voice sets are created in the Plugin Parameters and then, those voice sets are then bound to various battlers to help reduce the clutter found in the noteboxes of actors and enemies.
  • Enemies with different trait variations can have different voice sets.
  • Voice sets offer lines for a variety of situations such as the start of battle, victory, escaping, failing to escape, and starting action input.
  • Each situation can have multiple voice lines, which will be randomly picked upon meeting the situation. This helps reduce the monotony of each battle sounding the same.
  • Different types of actions can have different voice lines. These range from using basic attacks, basic guarding, to using skills that target allies and enemies for different hit types, or even using items.
  • Upon performing actions and attack motions, different sounds can be played in addition to extra sounds being played for landing a critical hit, defeating an enemy, or missing an attack.
  • Voice lines can differ upon receiving damage or healing, depending on the amount of damage or healing received, and/or whether or not the receiving battler is guarding.
  • Buffs, debuffs, and states all have voice lines for their applying and removal scenarios.
  • Unique voice lines can be played and called upon via Plugin Commands.
  • An option can be toggled to hear battle voices or not.


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.



Major Changes

This plugin adds some new hard-coded features to RPG Maker MZ's functions. The following is a list of them.

---

Voice Acting Control VisuStella MZ

If the VisuMZ Voice Acting Control plugin is installed in the same project, then any of the voice clips found in a voice set is played through the voice audio channel instead of the sound effect audio channel.

---

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

Enemies can have different voice sets, voice volumes, voice pitches, and voice panning depending on their trait sets. This way, you can do things like separate different voice sets for the same enemy species but of different gender traits, different element traits, different blessings, etc.

---

Skills and States Core VisuStella MZ

States will play battle voice lines when applied or removed. The VisuMZ Skills and States Core plugin allows states to be differentiated between positive and negative states using the <Positive State> and <Negative State> notetags. Different battle voice lines can be played depending on the type of state being added in addition to neutral states.

---

Victory Aftermath VisuStella MZ

An extra battle voice line can be played for if the Victory Aftermath is installed. It is a voice line that will appear for an actor upon level up.

---


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.

---

Voice Set-Related Notetags

---

<Voice Set: name>

- Used for: Actor, Enemy Notetags
- Declares a battle voice set for the target actor/enemy to use.
- Replace 'name' with the name of the battle voice set used in the Plugin
  Parameters to declare the contents of that battle voice set to be played.
  - If you are unsure which, it's the Plugin Parameter that says "Name" and
    in its decription will show "<Voice Set: name>".
- If nothing is declared, the actor/enemy will not use battle voice lines.
- This can be changed for actors via Plugin Commands.

---

<Language lang Voice Set: name>

- Used for: Actor, Enemy Notetags
- Requires VisuMZ_2_VoiceActControl and Voice Language Switching enabled.
- Declares a battle voice set for the target actor/enemy to use when using
  a certain voice language.
- Replace 'lang' with the language name this voice set is used for.
  - Bengali, Chinese, Czech, Danish, Dutch, English, Finnish, French,
    German, Greek, Hindi, Hungarian, Indonesian, Italian, Japanese, Korean,
    Norwegian, Polish, Portuguese, Romanian, Russian, Slovak, Spanish,
    Swedish, Tamil, Thai, Turkish
- Replace 'name' with the name of the battle voice set used in the Plugin
  Parameters to declare the contents of that battle voice set to be played.
  - If you are unsure which, it's the Plugin Parameter that says "Name" and
    in its decription will show "<Voice Set: name>".
- Insert multiple of these notetags to have different voice sets for
  different voiced languages.
- This can be changed for actors via Plugin Commands.

---

---

<Voice Set Volume: x>
<Voice Set Pitch: x>
<Voice Set Pan: x>

- Used for: Actor, Enemy Notetags
- Adjusts the battle voice set's volume, pitch, and panning.
- Replace 'x' with number values representing the setting you want used.
  - For volume, use a number between 0 and 100. 100 is full volume.
  - For pitch, use a number between 50 and 150. 100 is neutral.
  - For pan, use a number between -100 and 100. 0 is neutral.
- If these notetags are not used, the actor/enemy will use the settings
  found in the default Plugin Parameters instead.

---

<Trait Voice Sets>
 type Set: name
 type Volume: value
 type Pitch: value
 type Pan: value

 type Set: name
 type Volume: value
 type Pitch: value
 type Pan: value

 type Set: name
 type Volume: value
 type Pitch: value
 type Pan: value
</Trait Voice Sets>

- Used for: Enemy Notetags
- Requires VisuMZ_1_ElementStatusCore!
- Allows enemies that have different trait variants to have different battle
  voice sets, such as different voices for Male and Female, or different
  elements, blessings, etc.
- Replace 'type' with the name of an associated Trait Set type found in the
  Plugin Parameters. This can be for any Trait Set except 'SubElement'.
- Replace 'name' with the name of the battle voice set used in the Plugin
  Parameters to declare the contents of that battle voice set to be played.
  - If you are unsure which, it's the Plugin Parameter that says "Name" and
    in its decription will show "<Voice Set: name>".
- Replace 'value' with number values representing the setting you want used.
  - For volume, use a number between 0 and 100. 100 is full volume.
  - For pitch, use a number between 50 and 150. 100 is neutral.
  - For pan, use a number between -100 and 100. 0 is neutral.
- If none of these are used, then the enemy will not have any battle voices.

---


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 Command

VisuMZ.131.jpg

---

Actor: Change Battle Voice Set (Normal)
- Changes battle voice set data for target actor.

  Actor ID:
  - Select which Actor ID(s) to alter the voice data for.

  Voice Set Name:
  - What is the name of the voice set?

    Voice Set Volume:
    - Change the volume of the voice set sound effects played.

    Voice Set Pitch:
    - Change the pitch of the voice set sound effects played.

    Voice Set Pan:
    - Change the pan of the voice set sound effects played.

---

Actor: Change Battle Voice Set (Language)
- Changes battle voice set data for different languages to target actor.
- Requires VisuMZ_2_VoiceActControl and audio switching enabled!

  Actor ID:
  - Select which Actor ID(s) to alter the voice data for.

  Language Sets:
  - Determine which line is used based on which voice language the player
    has selected.

  Default Set Name:
  - What is the name of the default voice set?

  Voice Set Volume:
  - Change the volume of the voice set sound effects played.

  Voice Set Pitch:
  - Change the pitch of the voice set sound effects played.

  Voice Set Pan:
  - Change the pan of the voice set sound effects played.

---

Action Sequences - Voice

VisuMZ.131.jpg

---

VOICE: Common Line
- Plays a common voice line from target battler(s).
- Requires VisuMZ_3_BattleVoices!

  Speaker Target(s):
  - Select unit(s) to play voice lines from.

  Voice Line:
  - What voice line do you wish to play?

---

VOICE: Play Special Line
- Plays a special voice line from target battler(s).
- Requires VisuMZ_3_BattleVoices!

  Speaker Target(s):
  - Select unit(s) to play voice lines from.

  Voice Line Type:
  - What voice line type do you wish to play?
    - Action Name
    - Chant Line
    - Item Name
    - Skill Name
    - Spell Name
    - Unique Lines

  Name / Letter:
  - What voice letter/name do you want to play?

---

Plugin Parameters

General Settings

VisuMZ.131.jpg

BattleVoices Param1.png

These are the general settings for the Battle Voices Plugin Parameters.

---

For <Voice Set: name>

 Voice Sets:
 - A list of voice sets to choose from and apply to battlers with the
   <Voice Set: name> notetag.
 - For more information, look under the 'Voice Set Settings' section.
 - Using an already existing "Name" will link all these lines to that named
   battle voice set.

---

Voice Line Batches

 Action Name Sets:
 - A list of voice lines that are played when using skills with the
   <Voice Action Name: x> notetag.
 - Using an already existing "Name" will link all these lines to that named
   battle voice set.
 Chant Lines Sets:
 - A list of voice lines that are played when using skills with the
   <Voice Chant Line: x> notetag.
 - Using an already existing "Name" will link all these lines to that named
   battle voice set.
 Item Name Sets:
 - A list of voice lines that are played when using skills with the
   <Voice Item Name: x> notetag.
 - Using an already existing "Name" will link all these lines to that named
   battle voice set.
 Skill Name Sets:
 - A list of voice lines that are played when using skills with the
   <Voice Skill Name: x> notetag.
 - Using an already existing "Name" will link all these lines to that named
   battle voice set.
 Spell Name Sets:
 - A list of voice lines that are played when using skills with the
   <Voice Spell Name: x> notetag.
 - Using an already existing "Name" will link all these lines to that named
   battle voice set.
 Unique Line Sets:
 - A list of voice lines that are played when using Plugin Commands
   that call them.
 - Using an already existing "Name" will link all these lines to that named
   battle voice set.

---

Default Sound Settings

 Volume:
 - Default volume of the voice set sound effects played.
 Pitch:
 - Default pitch of the voice set sound effects played.
 Pan:
 - Default pan of the voice set sound effects played.

---

Options Settings

 Add Option?:
 - Add the 'Battle Voices' option to the Options menu?
 Adjust Window Height:
 - Automatically adjust the options window height?
 Option Name:
 - Command name of the option.
 Allow Self Response?:
 - Allow active battler to play response voice lines to his/her own
   actions?
 Override Last Sound:
 - Stops last clip made by battler to play a new one?

---


Voice Set Settings

VisuMZ.131.jpg

BattleVoices Param2.png

You can declare multiple battle voice sets here and what voice lines will be played under specific conditions and/or scenarios. If there are multiple filenames listed, then a random voice line will be picked from the batch. The volume, pitch, and pan will be the default value used or whatever specialized setting you made using notetags.

If a battle voice set has a "Name" that is later used in the "Voice Line Batches" lists, then those voice line batches will be added to this voice set to extend it.

---

MOST IMPORTANT

 Name:
 - Name of this Voice Set. The name will be used as the name for the
   <Voice Set: name> notetag.

---

Battle Phases

 On Battle Start:
 - Filename of the voice sound file for a random party member speaking at
   the start of battle.
 On Battle Input:
 - Filename of the voice sound file for a party member that is ready to
   input actions.
 On Battle Victory:
 - Filename of the voice sound file for a random party member speaking upon
   battle victory.
 Victory => Level Up:
 - Filename of the voice sound file for party members that level up in
   battle. Requires VisuMZ_3_VictoryAftermath!
 Escape => Success:
 - Filename of the voice sound file for a random party member speaking upon
   successfully escaping battle.
 Escape => Failure:
 - Filename of the voice sound file for a random party member speaking upon
   failing to escaping battle.

---

On Action Start

 Basic Action:
   Regular Attack:
   - Filename of the voice sound file for performing the start of a basic
     regular attack.
   Regular Guard:
   - Filename of the voice sound file for performing the start of a basic
     regular guard.
 Skill Usage > For Allies
   Certain Hit:
   - Filename of the voice sound file for performing the start of a skill-
     based certain hit action for allies.
   Physical:
   - Filename of the voice sound file for performing the start of a skill-
     based physical hit action for allies.
   Magical:
   - Filename of the voice sound file for performing the start of a skill-
     based magical hit action for allies.
 Skill Usage > For Enemies:
   Certain Hit:
   - Filename of the voice sound file for performing the start of a skill-
     based certain hit action for enemies.
   Physical:
   - Filename of the voice sound file for performing the start of a skill-
     based physical hit action for enemies.
   Magical:
   - Filename of the voice sound file for performing the start of a skill-
     based magical hit action for enemies.
 Item Usage:
   For Allies:
   - Filename of the voice sound file for performing the start of an item-
     based action for allies.
   For Enemies:
   - Filename of the voice sound file for performing the start of an item-
     based action for enemies.

---

Perform Action:

 Basic Action:
   Attack Motion:
   - Filename of the voice sound file for performing an attack's action.
   Critical Action:
   - Filename of the voice sound file for performing an action and landing
     a critical hit.
   Defeat Opponent:
   - Filename of the voice sound file for performing an action and
     defeating an opponent.
   Missed Action:
   - Filename of the voice sound file for performing an action but missing.
 Skill Usage:
   Certain Hit:
   - Filename of the voice sound file for performing the action of a
     Certain Hit type skill.
   Physical:
   - Filename of the voice sound file for performing the action of a
     physical hit type skill.
   Magical:
   - Filename of the voice sound file for performing the action of a
     magical hit type skill.

---

On HP Change:

 Life State:
   On Death:
   - Filename of the voice sound file when the battler receives enough
     damage to be fatal.
   On Revive:
   - Filename of the voice sound file when the battler receives healing and
     revives.
 On Damage:
   Damage <= 0%:
   - Filename of the voice sound file when the battler receives no damage
     whatsoever.
   Damage < 25%:
   - Filename of the voice sound file when the battler receives damage less
     than 25% of MaxHP.
   Damage < 50%:
   - Filename of the voice sound file when the battler receives damage less
     than 50% of MaxHP.
   Damage >= 50%:
   - Filename of the voice sound file when the battler receives damage more
     than 50% of MaxHP.
   Guarding Damage:
   - Filename of the voice sound file when the battler receives damage
     while guarding.
 On Recovery:
   Recovery < 25%:
   - Filename of the voice sound file when the battler receives healing
     more than 25% of MaxHP.
   Recovery < 50%:
   - Filename of the voice sound file when the battler receives healing
     more than 25% of MaxHP.
   Recovery >= 50%:
   - Filename of the voice sound file when the battler receives healing
     more than 25% of MaxHP.
 On Action Result:
   On Miss/Evasion:
   - Filename of the voice sound file when the battler evades a physical or
     certain hit action.
   On Magic Evasion:
   - Filename of the voice sound file when the battler evades a magical
     action.
   On Counter:
   - Filename of the voice sound file when the battler counters an action.
   On Reflection:
   - Filename of the voice sound file when the battler reflects an action.
   On Substitute:
   - Filename of the voice sound file when the battler substitutes for an
     action.

---

Buff/Debuff Related:

 On Buff Apply:
 - Filename of the voice sound file when the battler receives a buff or
   stacks a buff to a higher degree.
 On Buff Remove:
 - Filename of the voice sound file when the battler has a buff removed.
 On Debuff Apply:
 - Filename of the voice sound file when the battler receives a debuff or
   stacks a debuff to a higher degree.
 On Debuff Remove:
 - Filename of the voice sound file when the battler has a debuff
   removed.

---

State Related

 Positive States:
   On State Apply:
   - Filename of the voice sound file when the battler receives a positive
     state.
   - Requires VisuMZ_1_SkillsStatesCore!
   On State Remove:
   - Filename of the voice sound file when the battler loses a positive
     state.
   - Requires VisuMZ_1_SkillsStatesCore!
 Negative States:
   On State Apply:
   - Filename of the voice sound file when the battler receives a negative
     state.
   - Requires VisuMZ_1_SkillsStatesCore!
   On State Remove:
   - Filename of the voice sound file when the battler loses a negative
     state.
   - Requires VisuMZ_1_SkillsStatesCore!
 Neutral States:
   On State Apply:
   - Filename of the voice sound file when the battler receives a neutral
     state.
   On State Remove:
   - Filename of the voice sound file when the battler loses a neutral
     state.

---

Plugin Compatibility > VisuMZ_2_CharaCreationSys:

 Selectable?:
 - Is voice set selectable in the Character Creation System?
 - Requires VisuMZ_2_CharaCreationSys!
 Voice Preview:
 - Filename of the voice sound file to preview.
 - Requires VisuMZ_2_CharaCreationSys!

---



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.02: January 18, 2024

  • Compatibility Update!
    • Compatibility added for Voice Acting Control's new Voice Language Switch features. Updated by Irina.
  • Documentation Update!
    • Help file updated for new features.
  • New Features!
    • New notetag added by Irina:
      • <Language lang Voice Set: name>
        • Declares a battle voice set for the target actor/enemy to use when using a certain voice language.
    • New Plugin Command added by Irina:
      • Actor: Change Battle Voice Set (Language)
        • Changes battle voice set data for different languages to target actor.
        • Requires VisuMZ_2_VoiceActControl and audio switching enabled!


Version 1.01: August 17, 2023

  • Bug Fixes!
    • Fixed a problem where certain conditions wouldn't play voice lines. Fix made by Arisu.


Version 1.00 Official Release Date: August 30, 2023

  • Finished Plugin!

See Also

End of Helpfile