Visual Item Inventory 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.



VisualItemInv Animated.gif

VisualItemInv Equip.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

VisualItemInv Animated.gif

This plugin changes the item list displayed in-game to become more visual and show bigger images, either as icons or pictures. The enlarged item, weapon, and armor images will show their item quantities next to them while a tooltip window appears above their selected cell to show the item's name.

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

  • Changes the item inventory windows to become more visual.
  • Enlarged item images can be either icons or picture images.
  • Alter how large you want the images to appear with the Plugin Parameters.
  • Add different color backgrounds for different items.

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.


Major Changes

This plugin adds some new hard-coded features to RPG Maker MZ's functions. The following is a list of them.

---

Window Columns and Spacing

VisualItemInv Animated.gif

It should come off as no surprise that these windows will have their usual column counts changed to adjust for the item images shown. The columns will be based on how many of the item icons can fit inside of the window.

---

Item Quantity Positioning

The item quantity will now be positioned to show in the lower right of any window cell with an enlarged icon. Due to this being a much smaller area than what is usually provided, some plugins may have incredibly squished appearances when it comes to displaying item quantity in some areas.

This needs to be adjusted in those plugins individually.

---

Items and Equips Core

VisualItemInv Equip.gif

For the Equip Menu, the remove item entry has been changed to show only the enlarged icon. This is to keep consistency with the rest of the plugin.

---

Notetags

RPG Maker MZ's editor is unable to allow for custom traits/properties that a game dev may wish to associate with a database object, event, map, etc. Notetags are used to work around such limitations by allowing the game dev to tag certain traits/properties using specific Notetags declared by the related plugin.

Here is a list of Notetag(s) that you may use.


The following are notetags that have been added through this plugin. These notetags will not work with your game if this plugin is OFF or not present.

---

Picture-Related Notetags

VisualItemInv Equip.gif

---

<Visual Item Picture: filename>
<Picture: filename>

- Used for: Item, Weapon, Armor Notetags
- Uses a picture from your project's /img/pictures/ folder instead of the
  item's icon inside the item windows instead.
- Replace 'filename' with the filename of the image.
  - Do not include the file extension.
- Scaling will not apply to the picture.
- Use the <Picture: filename> version for any other plugins that may be
  using this as an image outside of this plugin, too.
- The size used for the image will vary based on the icon size settings.

---

Background Colors-Related Notetags

---

<Visual Item BG Color 1: x>
<Visual Item BG Color 2: x>

- Used for: Item, Weapon, Armor Notetags
- Changes the background color(s) for the item to text color 'x'.
- Replace 'x' with a number from 0 to 31 to represent a text color.

---

<Visual Item BG Color 1: #rrggbb>
<Visual Item BG Color 2: #rrggbb>

- Used for: Item, Weapon, Armor Notetags
- Changes the background color(s) for the item to a hex color.
- Use #rrggbb for custom colors.
- You can find out what hex codes belong to which color from this website:
  https://htmlcolorcodes.com/

---

Plugin Parameters

Visual Item Inventory Settings

VisualItemInv Animated.gif

VisualItemInv Param1.png

These settings allow you to adjust how the Visual Item Inventory windows appear and which ones they appear in.

---

General

 Applied Windows:
 - Insert the name of their constructors here to apply them.
 - Only works with windows made from Window_ItemList.
 Icon Size:
 - The icon size used for the Visual Item windows.
 Icon Smoothing?:
 - Do you wish to smooth out the icons or pixelate them?

---

Item Quantity Outline

 Outline Color:
 - Colors with a bit of alpha settings.
 - Format rgba(0-255, 0-255, 0-255, 0-1)
 Outline Size:
 - How thick are the outlines for the item quantity?

---

Tooltip Window

 Show Tooltip Window?:
 - Show the tooltip window?
 Background Type:
 - Select background type for this window.
 Buffer Width:
 - How much to buffer this window's width by?
 Font Size:
 - What should this window's font size be?
 Offset X:
 Offset Y:
 - How much to offset this window's X/Y position by?

---


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.02: July 16, 2021

  • Bug Fixes!
    • Visual glitch fixed that would make item quantity not appear. Fix made by Arisu.


Version 1.01: February 19, 2021

  • Feature Update!
    • No longer requires VisuStella MZ Items and Equips Core dependency.


Version 1.00 Official Release Date: February 26, 2021

  • Finished Plugin!

End of File