Message Keywords VisuStella MZ

From Yanfly.moe Wiki
Revision as of 15:33, 8 November 2021 by Irina (talk | contribs)
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

  • Product not ready yet.

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.



MessageKeywords Preview.gif

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

MessageKeywords Preview.gif

This plugin adds Keyword support for the Message Window and any others listed in the Plugin Parameters. By having Keyword support, the player can hover their mouse cursor over the Keyword and a tooltip window will appear, explaining further about the Keyword in question. This can be used in the Message Window to explain lore, in the Help Window to go into detail about more complex mechanics, and more!

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

  • Setup Keywords within the Plugin Parameters.
  • Keywords determine how the Keyword marker will be replaced and what kind of text will be displayed in the tooltip window.
  • Use Keywords to explain or remind the player about lore heavy topics.
  • Keywords can be used to explain indepth mechanics inside Help Window.
  • Alter the tooltip window's settings to your liking.

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.


Instructions

MessageKeywords Preview.gif

Here are the instructions on how to use this plugin.

---

Step 1:

- Open up the Plugin Parameters for this plugin.
- Open up the "Keyword List" Parameter list.
- Add your own or modify existing Keywords.
  - The "Keyword" is the Keyword Marker that will be referenced when using a
    Keyword inside of the Message Window or Help Window. Remember this.
  - The "Replacement Text" is the text that appears in place of the Keyword
    Marker. This can be used to color code or as a shortcut for Keywords.
    - Replacement text does not have to be exactly the same as the Keyword.
  - "Tooltip Text" is the text that appears inside the tooltip window when
    the player's mouse cursor hovers over the Keyword.
- Save your changes.

---

Step 2:

- Create a new "Show Message" event command or modify a database object's
  help "Description".
- Insert the Keyword Marker in the following format: ((Keyword))
  - Replace "Keyword" with the Keyword Marker mentioned in Step 1.
  - To use the default examples, you can type in ((Example)) or ((Ojima)).
- Save the changes.
- Go view them in game.
- Hover the mouse cursor over the specific Keywords and a tooltip window
  should appear.

---

Tooltip window text does not support Word Wrap. It is simply disabled from the very start so any Word Wrap text codes will not work with it.

---

Extra Features

MessageKeywords Preview.gif

There are some extra features found if other VisuStella MZ plugins are found present in the Plugin Manager list.

---

Elements and Status Menu Core VisuStella MZ

Items and Equips Core VisuStella MZ

Quest Journal System VisuStella MZ

Message Log VisuStella MZ

Visual Text Window VisuStella MZ

Custom windows provided by these plugins will have Keyword support as long as their respective window names are listed in the Plugin Parameters.

---

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.


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

Keyword-Related Text Codes

MessageKeywords Preview.gif

---

--------------------   -----------------------------------------------------
Text Code              Effect (Supported Message Windows)
--------------------   -----------------------------------------------------

((Keyword))            Replaces the "Keyword" Marker with the Replacement
                       Text found in the Message Keywords Plugin Parameters.
                       If the player hovers the mouse cursor over a Keyword,
                       a tooltip window will appear explaining about the
                       Keyword's lore and/or mechanics. The replacement text
                       and tooltip text can be modified inside the Message
                       Keywords Plugin Parameters.

---

Plugin Parameters

Keyword List

This array governs the Keywords that are used for the game.

---

Keyword List

 Keyword Marker:
 - This is the marker used to determine the tooltip and any associated text
 - To use this inside the Message Window or Help Description, type out the
   following:
   ((Keyword))
   Where "Keyword" would be the Keyword Marker used. Case does not matter.
 Replacement Text:
 - The text displayed as a replacement for the tooltip.
 - You may use text codes.
 Tooltip Text:
 - The text displayed for this tooltip.
 - You may use text codes.

---

Tooltip Settings

MessageKeywords Preview.gif

Settings for the Message Keyword Tooltips Window.

---

Appearance

 Scale:
 - What scale size do you want for the tooltip?
 - Use 1.0 for normal size.
 Skin Filename:
 - What window skin do you want to use for the tooltip?
 Skin Opacity:
 - What opacity setting is used for the tooltip?
 - Use a number between 0 and 255.

---

Offset

 Offset X:
 - Offset the tooltip X position from the mouse?
 - Negative: left. Positive: right.
 Offset Y:
 - Offset the tooltip Y position from the mouse?
 - Negative: up. Positive: down.

---

Supported Windows

Message Keyword support will be provided to these windows. Not every window is a valid candidate, however.

---

Supported Windows

 String:
 - Type in the constructor name of window you wish to add to the supported
   Window list.
 - Any windows not on the list will not support Keywords in the sense that
   tooltips will not appear. However, Keyword Markers can still be used to
   offer a quick shortcut to replacement text outside of tooltip windows.
 - Any of the windows listed here will have their refresh functions monkey
   patched via JavaScript to support Message Keywords.

---


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.00 Official Release Date: December 8, 2021

  • Finished Plugin!

End of File