Animated Pictures VisuStella MZ

From Yanfly.moe Wiki
Revision as of 14:16, 12 October 2020 by Yanfly (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

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.



AnimatedPictures.gif


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

This is a RPG Maker MZ plugin that gives functionality to Show Picture events to display animated pictures. Animated pictures are shown in a sprite sheet format. There are looping controls and speed controls that can be used with these animated pictures.

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

  • Functionality to make pictures animated as long as they follow the animated cell format.
  • Control the looping properties and speed of the animated picture through the usage of plugin commands.

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.


Instructions

AnimatedPictures.gif

Save your animated picture into your game project's img/pictures folder. The filename must be named with the following format:

filename[ANI][HxV]

Replace H in the filename with the number of horizontal cells it has. Replace V in the filename with the number of vertical cells it has. The number of total cells it has available is equal the multiplicative product of the horizontal and vertical cells.

For example:

"Parrot[ANI][3x2]" will have 3 horizontal cells and 2 vertical cells. This means there are a total of 6 cells that will be used for animating.

AnimatedPicExample.png

Animations will be played from left to right, then up to down so please arrange them as such. For example, 4x5 will play like this:

 1  2  3  4
 5  6  7  8
 9 10 11 12
13 14 15 16
17 18 19 20

Keep this in mind as you format your animated pictures.

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.

---

Animated Picture Plugin Command

---

AniPic Command1.png

Animated Picture: Change Properties
- Changes the properties used for the animated picture.

  Picture ID:
  - Select which Picture ID to affect.

  Loop?:
  - Animated pictures will loop back to beginning once it reaches the
    last frame.

  Wait Frames:
  - Number of frames to wait before moving to next picture cell.

---

Good Practices

AnimatedPictures.gif

Animated pictures, if used incorrectly, can bog down the game client. Here are some good practices that you can follow when making animated pictures to make them run more smoothly in-game.

---

1. Use animated pictures sparingly if possible. RPG Maker MZ's cache has a limited size to it, which means the more animated pictures you use, the faster it will fill up. And the faster it fills up, the more it needs to be emptied to allow other assets in your game to load at all.

---

2. If you do use animated pictures, trim down as much empty space as possible and keep picture cells to a minimum size to reduce bloating the cache.

---

3. If it is practical, make your sprite sheet cells work towards a power of 2 (ie: sizes of 32x32, 64x64, 128x128, 256x256, etc). Bitmaps render best when it works in this cell range. This is not necessary, but it is a thing to keep in mind.

---

4. Limit the amount of colors used in the animated picture to reduce the filesize of the image and reduce the strain on the cache. Use more flat colors instead of gradients. These work better for the engine.

---

5. When you are done using the animated picture, use the Erase Picture command to clear the picture from use. This will stop the animation frame calculating and reduce strain on your game.

---

Plugin Parameters

General Settings

AnimatedPictures.gif

These Plugin Parameters are the only ones available with this plugin. These adjust the default settings of animated pictures. If you wish to change how some animated pictures behave from others,

---

AniPic Params.png

Defaults

 Default Loop?:
 - Animated pictures will loop back to beginning by default once it reaches
   the last frame.
 Default Wait Frames:
 - Default number of frames to wait before moving to next picture cell.

---


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: October 30, 2020

  • Finished Plugin!

End of File