Difference between revisions of "Voice Acting Control VisuStella MZ"
(→Changelog) |
|||
Line 425: | Line 425: | ||
== Changelog == | == Changelog == | ||
+ | |||
+ | Version 1.04: March 14, 2024 | ||
+ | * Optimization Update! | ||
+ | ** Plugin should run more optimized. | ||
+ | |||
+ | |||
Version 1.03: January 18, 2024 | Version 1.03: January 18, 2024 |
Revision as of 11:15, 13 March 2024
VisuStella, Caz Wolf, Fallen Angel Olivia, Atelier Irina, and other affiliated content creators.
Contents
Download | ||
SystemThis 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 PluginsThe following plugins are required in order to use this plugin. Place the following plugins above this plugin located in the Plugin Manager.
VisuStella MZThis plugin is a part of the VisuStella MZ Plugin Library. Click here if you want to help support VisuStella on Patreon. IntroductionDo 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:
RequirementsThis plugin is made for RPG Maker MZ. This will not work in other iterations of RPG Maker. Required Plugin ListThis 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.
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 ChangesThis plugin adds some new hard-coded features to RPG Maker MZ's functions. The following is a list of them. --- Play Sound EffectsNaturally, 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 ButtonThe 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 CompatibilityWhile 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 MZThe 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). ---
Voice Language Switching InformationAs of Voice Acting Control version 1.03, Voice Language has been added. The "Voice Language" feature allows your players to switch between different languages for your game to allow people from around the globe to enjoy what story you have to tell. Disclaimers: This is not an automatic translation tool. Translations made through the "Voice Language" feature of the VisuStella MZ Voice Acting Control will require manual input by the game developer. --- How to Enable SwitchingVoice Language is NOT enabled by default. Here's what you have to do:
--- How to Play Different Voice LinesNow, to play different voice lines based on what language the player has selected, we have to use a newly added Plugin Command.
---
Text CodesText 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:
Type-Related Text Codes---
---
Plugin CommandsPlugin 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: ---
--- Sound Plugin Commands--- 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: - Filename of the sound effect played. Volume: - Volume of the sound effect played. Pitch: - Pitch of the sound effect played. pan: - Pan of the sound effect played. --- Sound: Play As Voice Line (Language) - Plays a voice line based on target audio language. - Uses volume channel and not SE volume channel. Language Lines: - Determine which line is used based on which voice language the player has selected. Default Line: - Default voice line played when no language-based voice line is found. Volume: - Volume of the voice line played. Pitch: - Pitch of the voice line played. pan: - Pan of the voice line played. --- Sound: Stop All Voice Lines - Stops all currently playing Voice Lines. --- 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 ParametersGeneral SettingsThese are general settings used for this plugin. There is no specific type of category they belong to. --- Settings 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 SettingsSettings that adjust the Replay Voice Sprite Button. --- Settings Show Sprite: - Shows the Replay Voice Sprite on the Message Window? --- Icons No Hover: - What icon is used when there is no mouse cursor hovering over it. Hovering: - What icon is used when there is a mouse cursor hovering over it. Parameter: - Description Parameter: - Description --- Positioning Positioning: - 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 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? ---
Language Switching SettingsSettings used to adjust audio changes for different languages. --- Main Settings: Enable Switching?: - Enable language switching settings for this plugin? --- Options: Add Option?: - Add the 'Language' option to the Options menu? Adjust Window Height: - Automatically adjust the options window height? Option Name: - Command name of the option. --- Languages: Default Language: - What is the default language used for this game? Supported Languages: - What are all the supported languages supported by this game's script? - Remove any that aren't translated. --- Language Names: 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: ---
Automatic Voice Acting SettingsThese 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. --- Filters 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 Use1. 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. 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. 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は一切の責任を負いません。 5. VisuStellaは、意図しない使用方法による問題、VisuStella MZライブラリ以外のプラグインとの非互換性の問題、プラグインのバージョンが最新でないことによる問題、第三者による互換性パッチが適切に動作していないことなどが原因でゲーム内で発生した問題については、一切の責任を負いません。VisuStellaは、高度なJavaScriptのノートタグやJavaScriptコードを許可するプラグインのパラメータを含む、カスタムコントロールエフェクトに使用される、ユーザー提供のカスタムコードに起因するエラーについても、一切の責任を負いません。 8. このプラグインの利用規約の追加項目や補足については、VisuStella.comに掲載されていますので、それを参照し従ってください。 CreditsIf you are using this plugin, credit the following people in your game: Team VisuStella
ChangelogVersion 1.04: March 14, 2024
Version 1.03: January 18, 2024
Version 1.02: December 14, 2023
Version 1.01: August 17, 2023
Version 1.00 Official Release Date: August 28, 2023
See AlsoEnd of Helpfile |