Voice Acting Control 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.



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.

Click here to learn how to update plugins.

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


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.



Do you have voice acting in your game to add that extra bit of immersion? If you do, you have probably realized that RPG Maker MZ is not equipped with all the necessities that come with games that have voice acting in them. Some of these necessities include a different audio volume channel for voices alone, control for stopping specific voices that are playing, adding replayable voice tracks for the message window, etc.

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

  • Adds a separate audio volume channel for voice acting specifically.
  • This volume channel can be adjusted in the Options screen. This is useful for players who might want to turn down the volume for sound effects but not voices or vice versa.
  • Use Plugin Commands to play specific sound files as a voice track.
  • Plugin Parameters can be used to automatically set up certain sound files as voice tracks so that they play in the voice audio channel when even using PlaySE event command.
  • Text Codes can be used to make the Message Window play specific voice sounds when new pages appear.
  • These page-related voice lines can be replayed if the player presses the replay button added to the Message Window.
  • Optionally, game devs can have Message Windows track whatever voice lines were playing before the Message Window appears and add that as its replay voice track.


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.

Major Changes

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


Play Sound Effects

VoiceActingControl VoiceFiles.png

Naturally, if you are using the automatic filename voice line detection features of plugin, then there will be some function redirecting happening between regular sound effects and voice sounds. The AudioManager.playSe function is changed to redirect detected voice sounds to the voice audio channel instead of the sound effect audio channel.


Replay Voice Button

VoiceActingControl ReplayIcon.png

The replay voice button is an icon button added through this plugin. It does not overwrite anything but depending on the position it uses, it may or may not change how the text displayed in the Message Window looks

For instance, if the button is on the left side of the Message Window, then the text will be shifted over to the right a bit more if there is no face graphic shown. If there is a face graphic shown, it will be displayed on top of the face graphic.

If the button is shown on the right, then the Message Core's Word Wrap will end a bit early to give the button enough room for itself as well as not have any potential text covering it.


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.


Message Log VisuStella MZ

The Message Log is updated so that it will display replay voice buttons on the upper left side of each logged entry (to the upper right side of the face graphic).


Text Codes


Text Codes are used in the Show Text event command. They are used to display things that text normally can't produce on its own, such as colors, get the name of a specific actor, change icons, and more.

RPG Maker MZ already comes with text codes of its own:

\V[n] Will be replaced with the value of the nth variable.
\N[n] Will be replaced with the name of the nth actor.
\P[n] Will be replaced by the name of the nth (arranged order) party member.
\G Will be replaced by the currency unit.
\C[n] Draw the subsequent text in the nth color. Text color conforms to the contents of the [Window.png] system image.
\I[n] Draws the nth icon.
\FS[n] Changes the text font size to 'n'.
\{ Increases the text by 1 step.
\} Decreases the text by 1 step.
\\ Replaced with the backslash character.
\$ Open the gold window.
\. Wait for 1/4 second.
\| Wait for 1 second.
\! Wait for button input.
\> Display remaining text on same line all at once.
\< Cancel the effect that displays text all at once.
\^ Do not wait for input after displaying the next.

The following are text codes that you may use with this plugin.

Type-Related Text Codes

VoiceActingControl ReplayIcon.png


--------------------   -----------------------------------------------------
Text Code              Effect (Message Window Only)
--------------------   -----------------------------------------------------

<Voice: filename>      Plays the 'filename' sound file found in /audio/se/
                       through the voice audio channel.


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.


Sound Plugin Commands


VoiceActingControl Command1.png


Sound: Play As Voice Line
- Plays target SE as a Voice Line using the Voice Line volume channel.
  This is unaffected by SE volume channel.

  - Filename of the sound effect played.

  - Volume of the sound effect played.

  - Pitch of the sound effect played.

  - Pan of the sound effect played.


VoiceActingControl Command2.png

Sound: Stop All Voice Lines
- Stops all currently playing Voice Lines.


VoiceActingControl Command3.png

Sound: Stop Target Voice Lines
- Stops target Voice Lines if they are currently playing.

  Specific Filenames:
  - Filenames of sound files that should be stopped as a Voice Line.
  - Case sensitive.

  Filename Text Markers:
  - Text markers used to automatically mark filenames (not folders) as
    a Voice Line.
  - Case sensitive.

  Specific Folders:
  - Anything that contains these folder names will be stopped as a
    Voice Line.
  - These can be main or sub folders.
  - Case sensitive.

  Folder Text Markers:
  - Text markers used to automatically mark folders (not filenames) for
    Voice Line playing.
  - Case sensitive.


Plugin Parameters

General Settings


VoiceActingControl Param1.png

These are general settings used for this plugin. There is no specific type of category they belong to.



 New Page > Register Voice:
 - If there is a PlaySE event command that places a voice sound before a
   new Message page, register it for replay?
 - Does not apply for sounds that aren't played through voice channel.
 End Page > Stop Voice:
 - Stop voices from playing whenever ending Message Window pages?
 - Does not apply to opening a new page for the first time.
 Option Name:
 - Command name of the option.


Replace Voice Sprite Settings

VoiceActingControl ReplayIcon.png

VoiceActingControl Param2.png

Settings that adjust the Replay Voice Sprite Button.



 Show Sprite:
 - Shows the Replay Voice Sprite on the Message Window?



 No Hover:
 - What icon is used when there is no mouse cursor hovering over it.
 - What icon is used when there is a mouse cursor hovering over it.
 - Description
 - Description



 - Where do you wish to position the Replay Voice Sprite?
   - Upper Left
   - Face Upper Right
   - Upper Right
   - Middle Left
   - Face Middle Right
   - Middle Right
   - Lower Left
   - Face Lower Right
   - Lower Right
 Offset X:
 - Offsets the sprite x position.
 - Negative: left. Positive: right.
 Offset Y:
 - Offsets the sprite y position.
 - Negative: up. Positive: down.



 Buffer Left:
 - Buffer the left positions unless there is a face image.
 - Does not apply if there is no face graphic.
 Buffer Right:
 - Buffer the right positions for word wrap to not overlap.
 - Non-word wrap can still overlap.
 Buffer Width:
 - What is the extra pixel width used for a buffer in addition to the
   icon width?


Automatic Voice Acting Settings


VoiceActingControl Param3.png

These plugin parameters allow you to automatically assign specific sound filenames as voice lines to be played in the voice audio channel as opposed to the sound effect channel.

Specific filenames and folders will pertain to those exact filenames (case sensitive). If they match exactly, they will be placed in the voice channel.

Text Markers will check to see if the sound filenames or folder names have the text markers inside them (case sensitive) to be played in voice channel.



 Specific Filenames:
 - Filenames of sound files that should be played as a Voice Line.
 - Case sensitive.
 Filename Text Markers:
 - Text markers used to automatically mark filenames (not folders) as
   a Voice Line.
 - Case sensitive.
 Specific Folders:
 - Anything that contains these folder names will be played as
   a Voice Line.
 - These can be main or sub folders.
 - Case sensitive.
 Folder Text Markers:
 - Text markers used to automatically mark folders (not filenames)
   for Voice Line playing.
 - Case sensitive.


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に掲載されていますので、それを参照し従ってください。


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

Team VisuStella


Version 1.01: August 17, 2023

  • Bug Fixes!
    • Fixed a bug that caused a crash when trying to change the x position of the replay voice button. Fix made by Irina.

Version 1.00 Official Release Date: August 28, 2023

  • Finished Plugin!

See Also

End of Helpfile