Side Chatter 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.

InstallPluginsMz.png

UpdatePlugins.png

Troubleshooting.jpg

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.


Masterarbeit Writer


SideChatter Preview1.gif


VisuStella MZ

This plugin is a part of the VisuStella MZ Plugin Library.

Click here if you want to help support VisuStella on Patreon.

Introduction

VisuMZ.132.jpg

This plugin allows you to create dialogue that appears on the side of the screen without interrupting gameplay. These can be accompanied by sound (and thus, voice acting if desired). After a while, the side chatter that appears on the side will fade out.

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

  • Add in desired text to the side chatter you want displayed.
  • Insert face graphics for the side chatter entries.
  • Play sound effects (which also means voice acting) to side chatter.
  • Side chatter can be delayed before appearing on the screen, giving a sense of timing without needing to setup wait commands.
  • You can select which side of the screen the side chatter will appear on. Both are always available.


Requirements

This plugin is made for RPG Maker MZ. This will not work in other iterations of RPG Maker.


Tier 4

This plugin is a Tier 4 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

PluginCommandsMZ.png

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.

---

Side Chatter Plugin Commands

SideChatter Preview1.gif

SideChatter Command1.png

---

Side Chatter: Add Entry
- Adds a side chatter entry.

  Text:
  - What text do you wish to add to the side chatter?
  - Text codes are allowed.

  Face Filename:
  - What face graphic do you wish to display in the side chatter?
  - Leave empty to not use.

    Face Index:
    - What is the index of the face graphic you wish to display?
    - Index values start at 0.

  Sound Effect:
  - Filename of the sound effect played.
  - Leave empty for no sound effect.

    Volume:
    - Volume of the sound effect played.

    Pitch:
    - Pitch of the sound effect played.

    Pan:
    - Pan of the sound effect played.

  Delay:
  - Delay this side chatter from appearing in this many frames.
  - 60 frames = 1 second.
  - 0 for instant.

  Screen Side:
  - Which side of the screen do you wish to add the Side Chatter to?
  - If Plugin Command is using "default" as its value, refer to whatever
    the setting is found in the Plugin Parameters.

---

SideChatter Command2.png

Side Chatter: Clear
- Clears Side Chatter.

  Screen Side:
  - Which side of the screen do you wish to clear the Side Chatter from?

---


Plugin Parameters

General Settings

SideChatter Preview1.gif

SideChatter Param1.png

These are the general settings related to the side chatter effects found in this plugin. Adjust them to best fit your game.

---

General Settings

 Default Side:
 - Which side of the screen do you wish to add the Side Chatter to?
 - Only applies when the Plugin Command selects "default".
 Auto-Clear:
   On Battle End:
   - Automatically clear battle-related side chatter at the end of battle?
   On Map Change:
   - Automatically clear battle-related side chatter when changing maps?
 Duration:
   Fade In Duration:
   - How many frames does a side chatter entry fade in?
   - 60 frames = 1 second.
   Fade Out Duration:
   - How many frames does a side chatter entry fade out?
   - 60 frames = 1 second.
   Stay Duration:
   - How many frames does a side chatter entry stay?
   - 60 frames = 1 second.
 Left-Side:
   Offset X:
   - Offsets the graphics x alignment from left side.
   - Negative: left. Positive: right.
   Offset Y:
   - Offsets the graphics y position from bottom.
   - Negative: up. Positive: down.
   Scale:
   - What scale will left-side chatter boxes be?
   - 0.0 = 0%, 0.5 = 50%, 1.0 = 100%
   Spacing:
   - How many pixels of spacing are there between side chatter entries?
 Right-Side:
   Offset X:
   - Offsets the graphics x alignment from right side.
   - Negative: left. Positive: right.
   Offset Y:
   - Offsets the graphics y position from bottom.
   - Negative: up. Positive: down.
   Scale:
   - What scale will right-side chatter boxes be?
   - 0.0 = 0%, 0.5 = 50%, 1.0 = 100%
   Spacing:
   - How many pixels of spacing are there between side chatter entries?

---



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: September 14, 2023

  • Documentation Update!
    • Help file updated for new features.
    • Updated Plugin Command help description.
  • New Features!
    • New Plugin Parameter added by Arisu:
      • Plugin Parameters > Default Side
      • Which side of the screen do you wish to add the Side Chatter to?
  • Feature Update!
    • Plugin Command "Side Chatter: Add Entry" now has the "Screen Side" parameter defaulted to the "default" value, referencing the value used by the new Plugin Parameter.


Version 1.00 Official Release Date: September 1, 2023

  • Finished Plugin!

See Also

End of Helpfile