Visual Text Window 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.



VisualTextWindow Preview1.png

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

VisualTextWindow Preview1.png

Ever wanted to create an instruction window on the screen while the player is exploring or an informative window detailing what the player needs to do while on certain parts of the map or during a particular phase of battle?

This plugin grants you the ability to create a text-filled window and put it on the screen without the need for a "Show Text" event. The Visual Text Window will linger on the screen. It will update and/or remove itself when commanded.

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

  • Place an unlimited amount of custom text Visual Text Windows anywhere on the screen for the battle and map scenes.
  • Supports text codes.
  • Autosize the width and height of the Visual Text Windows to fit the text you've inserted into them to make them appear clean and polished.
  • Alter and refresh them midway through gameplay when needed.
  • Remove them instantly or wait until after they've closed on demand.

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.


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.

---

Text Window Plugin Commands

VisualTextWindow Preview1.png

---

VisualTextWindow Command1.png

Text Window: Add/Change Settings
- Adds a newly created visual text window to the scene.
- Or changes an existing one with new settings.

  Required:

    ID:
    - What is the ID of this Visual Text Window to be added/changed?

    Text:
    - What text would you like to display here?
    - Text codes can be used.

    Customized Settings:

      Coordinates:

        X:
        Y:
        - What is the X/Y coordinates of this window?
        - You may use JavaScript code.

        Width:
        Height:
        - What is the width/height of this window?
        - You may use JavaScript code. Type 'auto' to auto-size it.

      Alignment:

        Horizontal:
        - Window alignment based on the X coordinate?
        - This is NOT text alignment.
          - left
          - center
          - right

        Vertical:
        - Window alignment based on the Y coordinate?
        - This is NOT text alignment.
          - top
          - middle
          - bottom

      Appear:

        Auto-Color?
        - Enable Auto-Color for this Visual Text Window?

        Type:
        - How does this window appear on the screen if it was closed before?
          - Instant - Window appears instantly
          - Open - Window opens up

      Background:

        Type:
        - Select background type for this window.
          - Window
          - Dim
          - Transparent

        Opacity:
        - What is this window's background opacity level?
        - You may use JavaScript code.

---

VisualTextWindow Command2.png

Text Window: Refresh
- Refreshes target Visual Text Window(s) on the screen.

  ID(s):
  - Refresh which Visual Text Window(s)?

---

VisualTextWindow Command3.png

Text Window: Remove
- Remove target Visual Text Window(s) and its settings.

  ID(s):
  - Remove which Visual Text Window(s)?

  Removal Type:
  - How does this window disappear from the screen upon removal?
    - Instant - Window disappears instantly
    - Close - Window closes, then removes itself

---

Plugin Parameters

General Settings

VisualTextWindow Preview1.png

VisualTextWindow Param1.png

There is only one Plugin Parameter setting for this plugin. The Layer Position plugin parameter determines whether the Visual Text Windows appear below the main scene's windows or above them.

The recommended setting is to have them appear below the main scene's windows as to not obscure any important information.

If you decide to change them to the above position, be wary of how you position your Visual Text Windows.

---

Settings

 Layer Position:
 - Position the Visual Text Window layer above the scene's main windows or
   below them?

---


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.01: March 29, 2021

  • Documentation Update!
    • Help file updated for new features.
  • New Features!
    • New Plugin Command option added by Yanfly:
      • "Text Window: Add/Change Settings" Customize Settings command now has a new option: Auto-Color?
        • This option allows you to enable/disable auto-color for this specific Visual Text Window.


Version 1.00 Official Release Date: March 3, 2021

  • Finished Plugin!

End of File