Message Letter Sounds 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.

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.



MsgLetterSounds Preview1.png

Source

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

MsgLetterSounds Preview1.png

Source

This plugin enables your messages to play sound effects per letter (or at certain intervals of letters) whenever they appear in a message window. Letter sounds can be used to add emotion, character, and feeling to scenes and provide audio feedback to the activity going on in the screen.

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

  • Declare which message letter sounds, their volume, pitch, and pan.
  • Add variance to the volume, pitch, and pan to produce more speech-like behaviors.
  • Blacklist certain letters from having any sounds played at all.
  • Change the sounds through Plugin Commands and/or text codes to alter the feeling of a message.

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.

---

Options Core VisuStella MZ

An added option to the Audio category of the default Options Core settings allow players to turn on/off the Message Letter Sounds in case they may find them to be unpleasing.

---

Text Codes

ShowTextWindowMZ.png

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.


MsgLetterSounds Preview1.png

Source

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

---

Full Length Text Codes

--------------------------   -----------------------------------------------
Text Code                    Effect (Message Window Only)
--------------------------   -----------------------------------------------
<Letter Sound On>            Turns on the Message Letter Sounds.
<Letter Sound Off>           Turns off the Message letter Sounds.

\LetterSoundName<filename>   Changes SFX played to 'filename'. Do not use or
                             insert the file extension. Case sensitive.
\LetterSoundVolume[x]        Changes SFX volume to x value.
\LetterSoundPitch[x]         Changes SFX pitch to x value.
\LetterSoundPan[x]           Changes SFX pan to x value.
\LetterSoundVolumeVar[x]     Changes SFX volume variance to x value.
\LetterSoundPitchVar[x]      Changes SFX pitch variance to x value.
\LetterSoundPanVar[x]        Changes SFX pan variance to x value.

---

For those who want to use shorter text codes:

---

Abbreviated Text Codes

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

\LSON           Turns on the Message Letter Sounds.
\LSOFF          Turns off the Message letter Sounds.

\LSN<filename>  Changes SFX played to 'filename'. Do not use or insert the
                file extension. Case sensitive.
\LSV[x]         Changes SFX volume to x value.
\LSPI[x]        Changes SFX pitch to x value.
\LSPA[x]        Changes SFX pan to x value.
\LSVV[x]        Changes SFX volume variance to x value.
\LSPIV[x]       Changes SFX pitch variance to x value.
\LSPAV[x]       Changes SFX pan variance to x value.

---

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.

---

Message Sound Plugin Commands

MsgLetterSounds Preview1.png

Source

---

MsgLetterSounds Command1.png

Message Sound: Change
- Change the settings to the Message Sound settings below.

  Filename:
  - Filename of the sound effect played.

  Interval:
  - Interval the sound effect from being played between how many characters?

  Volume:
  - Volume of the sound effect played.

    Variance:
    - When playing the sound effect, vary the volume by how much?

  Pitch:
  - Pitch of the sound effect played.

    Variance:
    - When playing the sound effect, vary the pitch by how much?

  Pan:
  - Pan of the sound effect played.

    Variance:
    - When playing the sound effect, vary the pan by how much?

---

MsgLetterSounds Command2.png

Message Sound: Reset
- Resets the settings to the Plugin Parameters settings.

---

System Plugin Commands

---

MsgLetterSounds Command3.png

System: Enable/Disable Letter Sounds
- Enables/disables Message Letter Sounds for the game.

  Enable/Disable?:
  - Enables/disables Message Letter Sounds for the game.

---

Plugin Parameters

General Settings

MsgLetterSounds Preview1.png

Source

MsgLetterSounds Params1.png

These are the settings that determine the default settings for the letter sound as well as default enabling of the sounds. There is also a blacklist here to let you decide which letter characters will not play sounds.

---

Enable

 Default Enable?:
 - Enable Letter Sounds by default?
 Blacklisted Letters:
 - This is a list of individual characters that are blacklisted from having
   sounds play.

---

Default Sound Settings

 Filename:
 - Filename of the sound effect played.
 Interval:
 - Interval the sound effect from being played between how many characters?
 Volume:
 - Volume of the sound effect played.
   Variance:
   - When playing the sound effect, vary the volume by how much?
 Pitch:
 - Pitch of the sound effect played.
   Variance:
   - When playing the sound effect, vary the pitch by how much?
 Pan:
 - Pan of the sound effect played.
   Variance:
   - When playing the sound effect, vary the pan by how much?

---


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: May 14, 2021

  • Optimization Update!
    • Plugin should run more optimized.


Version 1.01: December 25, 2020

  • Bug Fixes!
    • Empty text won't prompt a message sound effect to play. Fixed by Yanfly.


Version 1.00: January 6, 2021

  • Finished Plugin!

End of File