Extended Message Functionality VisuStella MZ
- 1 Download
- 2 System
- 3 Required Plugins
- 4 VisuStella MZ
- 5 Introduction
- 6 Requirements
- 7 Extra Features
- 8 Text Codes
- 9 Plugin Commands
- 10 Plugin Parameters
- 12 Credits
- 13 Changelog
- 14 See Also
- 15 End of File
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.
The following plugins are required in order to use this plugin.
Place the following plugins above this plugin located in the Plugin Manager.
This plugin is a part of the VisuStella MZ Plugin Library.
The Extended Message Function plugin adds onto RPG Maker MZ's Message Window and adds in various features you would normally see found in modern RPG's. Things like automatically moving the text forward after a set amount of time or fast forward are available. Saving and loading during a message is also possible as well as going to the Options menu or returning back to the title screen. These options are only available to the Message Window on the map scene and do not work in battle.
Features include all (but not limited to) the following:
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.
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.
There are some extra features found if other VisuStella MZ plugins are found present in the Plugin Manager list.
The Options Core is a required plugin in order to make use of the "Options" (aka "Config") button found in the Button Console.
The Options Core is a required plugin in order to make use of the "Save" and "Load" buttons found in the Button Console.
The Message Log plugin enables the "Log" button found in the Button Console to let the player go and review the text that has been displayed in the map scene. This does not include the text found in battle to avoid conflicting logged messages across different situations.
The Message Visibility plugin enables the "Hide" button found in the Button Console to make the Message Window visible or invisible.
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:
Button Console-Related Text Codes
-------------------- ----------------------------------------------------- Text Code Effect (Message Window Only) -------------------- ----------------------------------------------------- <Hide Buttons> Hides the Button Console from this current Message Window's text assuming that nothing else is hiding the Button Console from view.
Message Tail-Related Text Codes
-------------------- ----------------------------------------------------- Text Code Effect (Message Window Only) -------------------- ----------------------------------------------------- <Tail Bottom Left: x> Creates a message tail at x coordinate pointing to the bottom left. <Tail Bottom Right: x> Creates a message tail at x coordinate pointing to the bottom right. <Tail Upper Left: x> Creates a message tail at x coordinate pointing to the upper left. <Tail Upper Right: x> Creates a message tail at x coordinate pointing to the upper right.
Here is a list of Plugin Command(s) that you may use:
Fast Forward Plugin Commands
Fast Forward: Allow/Disallow - Change whether or not Fast Forward is allowed/disallowed. - Must be enabled by the Plugin Parameters. Allow?: - Allow or disallow the Extended Fast Forward feature? - Must be enabled by the Plugin Parameters.
Message Button Console Plugin Commands
Message Button Console: Show/Hide - Determine if the Message Button Console is visible or hidden. - Only appears on the map. - Does not appear in battle. Visible?: - Show or hide the Message Button Console feature? - Only appears on the map. - Does not appear in battle.
Message Cursor Plugin Commands
Message Cursor: Change Settings - Change the Message Cursor settings used. Change Settings: - Change the Message Cursor settings. - Settings are the same as the ones found in the Plugin Parameters.
Message Tail Plugin Commands
Message Tail: Change Settings - Change the Message Tail settings. Message Tail Settings: - Message Tail settings used for Message Windows. - Requires images and text codes to appear. - See Plugin Parameters. They have the same parameters.
Auto-Forward settings used for this game. Auto-Forward is a feature that once enabled, the game will automatically move the "Show Text" event commands forward after a certain amount of time. The amount of time will be determined by how many characters are displayed on the screen. There is a lower boundary, where if the wait time does not meet the amount, the timer will be set to the minimum wait value instead.
Settings Wait per Character: - How many frames should the game wait per character? - Average: 60 frames per second. Minimum Wait: - What is the minimum amount of frames to wait? - Average: 60 frames per second.
Fast Forward (Extended) Settings
Extended Fast Forward settings used for this game. If enabled, this will replace the Message Core's Fast Forward functionality. The Extended Fast Forward feature will not only fast forward through messages but any running events that are not found in a parallel event.
It can also be activated the Message Core's Fast Forward shortcut key.
Settings Enable?: - Enable or disable the Extended Fast Forward feature? Speed: - What is the speed at which Extended Fast Forward works at? - Higher numbers are faster. Reset on Scene Change?: - Reset Fast Forward setting on scene changes (ie battle, menu, or map transfers)?
Message Button Console Settings
Message Button Console settings used for this game.
It will only appear in the Message Window on the map scene. It will NOT appear in battle. The reason it won't appear in battle is because many of the functions there will clash with how the battle scene behaves.
The Button Console will add extra padding to the Message Window and appear at either the top of bottom of the Message Window (your choice). A row of buttons will appear each with a different functionality.
These Plugin Parameters also allow you to customize the appearance of how the buttons look in-game. Adjust them accordingly.
General Show by Default?: - Show or hide the Message Button Console by default? Position: - Where do you wish to display the Message Button Console? - Top of Message Window - Bottom of Message Window Auto-Size Hide?: - Hide the button console when using auto-size text codes?
Appearance Window Skin: - What is the window skin used for the buttons? Font Name: - What font do you wish to use for the Message Button Console? Font Size: - What font size do you wish to use for the Message Button Console? Text Colors: Normal Color: - Use #rrggbb for custom colors or regular numbers for text colors from the Window Skin. Toggled Color: - Use #rrggbb for custom colors or regular numbers for text colors from the Window Skin. Disabled Color: - Use #rrggbb for custom colors or regular numbers for text colors from the Window Skin. Visuals: Width: - What is the width of each button? Height: - What is the height of each button? Buffer: - What is the buffer between each button? Background Images: Disabled Image: Enabled Image: Toggled Image: - Filename of the background image when the button is disabled, enabled, or toggled. - This will hide the window skin for this button. Offset X: - Offsets the X position of this image. - Negative: left; Positive: right Offset Y: - Offsets the Y position of this image. - Negative: up; Positive: down
Settings for which buttons appear and how they appear. These settings will determine which buttons appear (provided that their required plugins are available), what shortcut keys are applied to them, and what kind of text will be displayed to represent them.
In case you are wondering where the Fast Forward shortcut key is, that setting is found in the Message Core.
General List: - Which buttons appear and in what order? - Some commands require certain plugins installed.
Shortcut Keys Auto-Forward Key: - This is the key used for auto-forwarding messages. Save Key: - This is the key used for quick saving. - Requires VisuMZ_1_SaveCore! Load Key: - This is the key used for quick load. - Requires VisuMZ_1_SaveCore! Options Key: - This is the key used for opening options. - Requires VisuMZ_1_OptionsCore! Game End Key: - This is the key used for ending the game.
Vocabulary Auto-Forward: - How is this option's text displayed in-game? Fast Forward: - How is this option's text displayed in-game? Save Game: - How is this option's text displayed in-game? - Requires VisuMZ_1_SaveCore! Load Game: - How is this option's text displayed in-game? - Requires VisuMZ_1_SaveCore! Options: - How is this option's text displayed in-game? - Requires VisuMZ_1_OptionsCore! Game End: - How is this option's text displayed in-game?
Message Cursor Settings
Message Cursor settings used for this game. The cursor, if enabled, will appear where the text is currently displayed at and adds a new type of aesthetic to the game.
General Enable?: - Enable or disable the message cursor? Graphic Type: - What is the cursor's graphic type? - Icon - From img/system/IconSet.png - Image - An animated image from img/system/ - Window Skin - Use the default Window Skin cursor
Icon Icon Index: - This is icon used for the Message Cursor. Flip Speed Multiplier: - What is the flip speed multiplier for the Message Cursor? - Use 0 for no flipping.
Image Filename: - Filename of the image found inside the img/system/ folder. Image Rows: - How many rows are there for the image? Image Columns: - How many columns are there for the image? Frame Delay: - How many frames delayed are there per animated cell?
Appearance Anchor X: Anchor Y: - Determine the Message Cursor's X/Y position. - Use a number between 0 and 1 for best results. Offset X: Offset Y: - Offset the Message Cursor's X/Y position by how many pixels?
Message Tail Settings
Message Tails can be made to appear from the Message Window and point towards the speaker, similar to how speech bubbles in comics point towards their speakers. The Message Tails do not appear on their own, and only come out when using auto-position text codes (if enabled) such as <Auto Player> or when text codes are used to make them appear such as <Tail Upper Left: x> and <Tail Lower Right: x>.
These settings require custom graphics that this plugin does not come with. You will need to add them on your own or else they will not appear.
Enable?: - Show Message Tails with Auto-Position text codes? - Message Tails will appear when using the following text codes: - <Auto Actor: x> - <Auto Party: x> - <Auto Player> - <Auto Event: x> - <Auto Enemy: x>
Face Left?: - Which direction does the Message Tail point to? - Left or right?
Offset X: Offset Y: - Message Window's X offset with auto-position. - X: Negative: left. Positive: right. - Y: Negative: up. Positive: down.
Tail Directions Tail Directions > Bottom Left Tail Directions > Bottom Right Tail Directions > Upper Left Tail Directions > Upper Right
Filename: - Filename of the Message Tail graphic going towards the specified direction.
Anchor X: - Anchor value X. Use a number between 0 and 1. - 0.0 - Left; 0.5 - Center; 1.0 - Right
Anchor Y: - Anchor value Y. Use a number between 0 and 1. - 0.0 - Top; 0.5 - Middle; 1.0 - Bottom
Offset X: - Offset the Message Tail's X position. - Negative: left. Positive: right.
Offset Y: - Offset the Message Tail's Y position. - Negative: left. Positive: right.
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".
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.
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.
6. VisuStella MZライブラリのコードを使用した互換性パッチをVisuStellaとは関係のない第三者を通じて作成する必要がある場合は、まずVisuStellaのメンバーと連絡を取り、承認を得る必要があります。パッチはVisuStella.comに公開され、誰でも無料でダウンロードすることができるようになります。このようなパッチを、制作発注やクラウドファンディングの対象にしたり、寄付などの金銭的な利益を得るために販売することはできません。
7. このVisuStella MZプラグインが商用製品である場合、プロジェクトチームのすべてのメンバーは、それを使用するため、それぞれ製品を購入しなければなりません。使用方法には、関連するゲームメカニクスの作業、関連するコードの管理、および/または関連するプラグインコマンドや機能の使用、が含まれます。プラグインそのものやそのコードをチームの他のメンバーに再配布することは第4項に抵触するため、そのメンバーがプラグインそのものを所有していない限りは許可されません。
If you are using this plugin, credit the following people in your game:
Version 1.14: May 18, 2023
Version 1.13: February 16, 2023
Version 1.12: December 15, 2022
Version 1.11: November 10, 2022
Version 1.10: August 11, 2022
Version 1.09: April 7, 2022
Version 1.08: March 17, 2022
Version 1.07: March 3, 2022
Version 1.06: November 18, 2021
Version 1.05: November 4, 2021
Version 1.04: October 14, 2021
Version 1.03: September 3, 2021
Version 1.02: August 6, 2021
Version 1.01: July 30, 2021
Version 1.00 Official Release Date: August 2, 2021
End of File