Difference between revisions of "Message Log VisuStella MZ"
(→Plugin Parameters) |
(→Changelog) |
||
(10 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
{{MzPlugin | {{MzPlugin | ||
− | |preview = <youtube> | + | |preview = <youtube>https://www.youtube.com/watch?v=wXGaNo09Dbk</youtube> |
− | |link1 = <html> | + | |link1 = <html><iframe frameborder="0" src="https://itch.io/embed/1128398" width="552" height="167"><a href="https://visustellamz.itch.io/message-log">Message Log plugin for RPG Maker MZ by VisuStellaMZ</a></iframe></html> |
|link2 = {{VisuStella Visual Novel Vol 1}} | |link2 = {{VisuStella Visual Novel Vol 1}} | ||
Line 238: | Line 238: | ||
Show Faces? | Show Faces? | ||
- Show face graphics in the Message Log? | - Show face graphics in the Message Log? | ||
+ | |||
+ | Pad Sides? | ||
+ | - Pad the sides of the screen even without faces? | ||
+ | - Ignore if the screen is too small. | ||
--- | --- | ||
Line 425: | Line 429: | ||
== Changelog == | == Changelog == | ||
+ | |||
+ | Version 1.07: April 18, 2024 | ||
+ | * Compatibility Update! | ||
+ | ** Added extra compatibility for Voice Acting Control's version update. | ||
+ | |||
+ | |||
+ | |||
+ | Version 1.06: January 18, 2024 | ||
+ | * Bug Fixes! | ||
+ | ** Fixed a bug where text from battle transitions would merge into the Message Log. Fix made by Olivia. | ||
+ | |||
+ | |||
+ | |||
+ | Version 1.05: September 14, 2023 | ||
+ | * Bug Fixes! | ||
+ | ** Fixed a bug where text macros from VisuMZ Message Core did not convert properly into the Message Log. Fix made by Irina. | ||
+ | * Documentation Update! | ||
+ | ** Help file updated for new features. | ||
+ | * New Features! | ||
+ | ** New Plugin Parameter added by Irina. | ||
+ | ** Plugin Parameters > General > Pad Sides? | ||
+ | *** Pad the sides of the screen even without faces? | ||
+ | *** Ignore if the screen is too small. | ||
+ | |||
+ | |||
+ | |||
+ | Version 1.04: March 16, 2023 | ||
+ | * Compatibility Update! | ||
+ | ** Added compatibility for the recent Message Core additions. | ||
+ | ** Added compatibility functionality for future plugins. | ||
+ | |||
+ | |||
+ | |||
+ | Version 1.03: October 7, 2021 | ||
+ | * Bug Fixes! | ||
+ | ** Message Log should now work with automatic word wrap. Fix by Irina. | ||
+ | |||
+ | |||
+ | |||
+ | Version 1.02: September 3, 2021 | ||
+ | * Bug Fixes! | ||
+ | ** Fixed a crash pertaining to specific message windows that haven't declared a speaker name from an older RPG Maker version. Fix by Irina. | ||
+ | |||
+ | |||
+ | |||
+ | Version 1.01: August 6, 2021 | ||
+ | * Documentation Update! | ||
+ | ** Plugin URL now updated to most recent one. | ||
+ | |||
+ | |||
Version 1.00 Official Release Date: August 4, 2021 | Version 1.00 Official Release Date: August 4, 2021 | ||
* Finished Plugin! | * Finished Plugin! | ||
+ | |||
+ | == See Also == | ||
+ | |||
+ | * [[Inspiration Behind Visual Novel Volume 1]] | ||
+ | * [[Message Backlog (YEP)]] | ||
+ | |||
== End of File == | == End of File == |
Latest revision as of 03:25, 17 April 2024
VisuStella, Caz Wolf, Fallen Angel Olivia, Atelier Irina, and other affiliated content creators.
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. IntroductionThe Message Log plugin will take and record any Show Message entries played on the map screen so that players can go back to them and review them at a later point in time when needed. This is helpful for players who may have missed important information that would have been displayed or those who would like to review what was said previously. The Message Log will not record any of the text displayed in the battle scene in order to preserve the data to one specific scene. 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 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 ChangesThis plugin adds some new hard-coded features to RPG Maker MZ's functions. The following is a list of them. --- Replaced Message Text CodesSome text codes are not compatible with the Message Log when viewed such as wait commands, showing the gold window, etc. When that happens, those text codes will be removed from visibility in the Message Log in order to prevent any problems. The following is a list of the Message Text Codes that will not appear in the Message Log: -------------------- Default RPG Maker MZ -------------------- \$ \. \| \! \> \< \^ -------------------- VisuMZ_1_MessageCore -------------------- \Picture<x> \CenterPicture<x> \CommonEvent[x] \Wait[x] \NormalBG \DimBG \TransparentBG \WindowMoveTo: ?> \WindowMoveBy: ?> \WindowReset \TroopMember[x] \TroopNameMember[x] \ChangeFace<?> \FaceIndex[x] <Auto> <Auto Width> <Auto Height> <Auto Actor: x> <Auto Party: x> <Auto Enemy: x> <Auto Event: x> <Auto Player> <Show> <Show Switch: x> <Show All Switches: x,x,x> <Show Any Switches: x,x,x> <Hide> <Hide Switch: x> <Hide All Switches: x,x,x> <Hide Any Switches: x,x,x> <Enable> <Enable Switch: x> <Enable All Switches: x,x,x> <Enable Any Switches: x,x,x> <Disable> <Disable Switch: x> <Disable All Switches: x,x,x> <Disable Any Switches: x,x,x> <Position: ?> <Coordinates: ?> <Dimensions: ?> ----------------------- VisuMZ_2_ExtMessageFunc ----------------------- <Hide Buttons> ----------------------- VisuMZ_2_PictureChoices ----------------------- <Bind Picture: id> <Hide Choice Window> ---------------------- VisuMZ_3_ChoiceCmnEvts ---------------------- <Choice Common Event: id> ------------------- VisuMZ_3_MessageLog ------------------- <Bypass Message Log> ---------------------- VisuMZ_3_MessageSounds ---------------------- <Letter Sound On> <Letter Sound Off> \LetterSoundName<filename> \LetterSoundVolume[x] \LetterSoundPitch[x] \LetterSoundPan[x] \LetterSoundVolumeVar[x] \LetterSoundPitchVar[x] \LetterSoundPanVar[x] \LSON \LSOFF \LSN<filename> \LSV[x] \LSPI[x] \LSPA[x] \LSVV[x] \LSPIV[x] \LSPAV[x] ------------------------ VisuMZ_4_EventTitleScene ------------------------ <Continue> --- 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. --- Extended Message Functionality VisuStella MZ The Extended Message Functionality 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. --- 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:
Log-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: ---
--- Bypass Plugin Commands--- Bypass: Message Logging? - Bypass message logging until turned off. Bypass?: - Bypasses Message Logging until turned off. --- System Plugin Commands--- System: Enable Message Log in Menu? - Enables/disables Message Log menu inside the main menu. Enable/Disable?: - Enables/disables Message Log menu inside the main menu. --- System: Show Message Log in Menu? - Shows/hides Message Log menu inside the main menu. Show/Hide?: - Shows/hides Message Log menu inside the main menu. --- Plugin ParametersGeneral SettingsGeneral Settings for the Message Log. --- Settings Entry Limit: - How many message entries will be stored before the game will start trimming them? Shortcut Key: - This is the key used for opening the Message Log scene. - Does not work in battle! Show Faces? - Show face graphics in the Message Log? Pad Sides? - Pad the sides of the screen even without faces? - Ignore if the screen is too small. --- Main Menu SettingsMain Menu settings for Message Log. --- Settings Command Name: - Name of the 'Message Log' option in the Main Menu. Show in Main Menu?: - Add the 'Message Log' option to the Main Menu by default? Enable in Main Menu?: - Enable the 'Message Log' option to the Main Menu by default? - This will be automatically disabled if there are no entries available. --- Background SettingsBackground settings for Scene_MessageLog. --- Settings Snapshop Opacity: - Snapshot opacity for the scene. Background 1: - Filename used for the bottom background image. - Leave empty if you don't wish to use one. Background 2: - Filename used for the upper background image. - Leave empty if you don't wish to use one. --- Vocabulary SettingsThese settings let you adjust the text displayed for this plugin. --- ExtMessageFunc Button Name: - How is this option's text displayed in-game? - Requires VisuMZ_2_ExtMessageFunc! --- Button Assist Window Slow Scroll: - Text used for slow scrolling. Fast Scroll: - Text used for fast scrolling. --- Choice Window Logging Text Format: - Text format for logging the selected choice text. - %1 - Selected Choice Text Cancel: - Text used when cancel branch is selected. --- Number Input Logging Text Format: - Text format for logging the inputted number value. - %1 - Number Value --- Event Item Logging Text Format: - Text format for logging the selected event Item. - %1 - Selected Event Item Text Name Format: - Text format for how item names are displayed. - %1 - Item Icon, %2 - Item Name No Item: - Text used when no item is selected. --- Window SettingsWindow settings for Scene_MessageLog. --- Message Log Window Background Type: - Select background type for this window. JS: X, Y, W, H: - Code used to determine the dimensions for this window. --- Appearance Speaker Name X: - What X coordinate do you want the speaker name to appear at? --- Color Lock Choices: - Color lock the logged choices? Number Inputs: - Color lock the logged Number Inputs? Event Item: - Color lock the logged selected Event Item? --- Scrolling > Slow Scroll Speed: - What speed will Up/Down scroll the window at? - Lower is slower. Higher is faster. Sound Frequency: - How frequent will Up/Down scrolling make sounds? - Lower is quicker. Higher is later. --- Scrolling > Fast Scroll Speed: - What speed will PageUp/PageDn scroll the window at? - Lower is slower. Higher is faster. Sound Frequency: - How frequent will PageUp/PageDn scrolling make sounds? - Lower is quicker. Higher is later. ---
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.07: April 18, 2024
Version 1.06: January 18, 2024
Version 1.05: September 14, 2023
Version 1.04: March 16, 2023
Version 1.03: October 7, 2021
Version 1.02: September 3, 2021
Version 1.01: August 6, 2021
Version 1.00 Official Release Date: August 4, 2021
See Also
End of File |