Shop Bust Style UI 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


ShopBustStyleUI Preview1.png

ShopBustStyleUI Preview2.png

ShopBustStyleUI Preview3.png

ShopBustStyleUI Preview4.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.

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

Introduction

VisuMZ.141.jpg

This plugin allows you to modify the shop scene to showcase a dynamic background and character. The character will speak via messages and can even change expressions depending on what the player does inside the shop. The backgrounds and characters, along with their messages, can vary from shop to shop by simply changing Plugin Commands.

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

  • Plugin Commands that can change the appearance of backgrounds and character bust graphics to vary from shop to shop.
  • Custom text is displayed based on the types of interactions the player does within the shop.
  • Characters can change their bust graphics based on interactions, too.
  • With VisuMZ_2_VoiceActControl, voice acting support is added to the Shop Bust Style UI, too.
  • Additional compatibility with other VisuStella MZ shop-related plugins to allow them to utilize the Shop Bust Style UI, too.


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.



Major Changes

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

---

Window Layouts

ShopBustStyleUI Preview1.png

As this is a UI altering plugin, the window positioning functions will be altered and overwritten. However, when the Shop Bust Style UI is off, then the usual window positions will be used.

---


Extra Features

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

---

Voice Acting Control VisuStella MZ

ShopBustStyleUI Preview1.png

If you are using VisuMZ_2_VoiceActControl, this plugin's voice acting support will become enabled and you can add voice lines to various messages as long as they are available.

---

Hospital Shop VisuStella MZ

ShopBustStyleUI Preview2.png

If you are using VisuMZ_4_HospitalShop, then this plugin has extra features that can be used together with it. There are Plugin Commands and Plugin Parameters that can be used to change up the Hospital scene's UI to match that of a Shop Bust Style UI.

---

Recruiting Board VisuStella MZ

ShopBustStyleUI Preview3.png

If you are using VisuMZ_4_RecruitBoard, then this plugin has extra features that can be used together with it. There are Plugin Commands and Plugin Parameters that can be used to change up the Recruiting Board scene's UI to match that of a Shop Bust Style UI.

---

Skill Shop VisuStella MZ

ShopBustStyleUI Preview4.png

If you are using VisuMZ_4_SkillShop, then this plugin has extra features that can be used together with it. There are Plugin Commands and Plugin Parameters that can be used to change up the Skill Shop scene's UI to match that of a Shop Bust Style UI.

---


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.

---

General Shop Plugin Commands

ShopBustStyleUI Preview1.png

---

General Shop: Clear UI Settings
- Clear Bust Style UI settings for general shops.

---

General Shop: Setup UI Settings
- Setup Bust Style UI settings for general shops.
- Use this before a "Shop Processing" event command.

  Background Graphic:
  - What background image do you wish to use?

  Bust Graphic:
  - What character bust image do you wish to use?

    Bust Settings:
    - These settings adjust the bust settings and how they visually appear
      in-game for the general shop.
    - Look in the Plugin Parameters for the identical settings.
    - If this is left empty or at {}, then use the defaults found in the
      Plugin Parameters.

  Messages:
  - What messages would you like to use for this shop?
  - Look in the Plugin Parameters for the identical settings.
  - If this is left empty or at {}, then use the defaults found in the
    Plugin Parameters.

---

Hospital Shop Plugin Commands

ShopBustStyleUI Preview2.png

---

Hospital: Clear UI Settings
- Clear Bust Style UI settings for Scene_Hospital.
- Requires VisuMZ_4_HospitalShop!

---

Hospital: Setup UI Settings
- Setup Bust Style UI settings for Scene_Hospital.
- Requires VisuMZ_4_HospitalShop!

  Background Graphic:
  - What background image do you wish to use?

  Bust Graphic:
  - What character bust image do you wish to use?

    Bust Settings:
    - These settings adjust the bust settings and how they visually appear
      in-game for the hospital.
    - Look in the Plugin Parameters for the identical settings.
    - If this is left empty or at {}, then use the defaults found in the
      Plugin Parameters.

  Messages:
  - What messages would you like to use for this hospital?
  - Look in the Plugin Parameters for the identical settings.
  - If this is left empty or at {}, then use the defaults found in the
    Plugin Parameters.

---

Recruiting Board Plugin Commands

ShopBustStyleUI Preview3.png

---

Recruiting Board: Clear UI Settings
- Clear Bust Style UI settings for Scene_RecruitBoard.
- Requires VisuMZ_4_RecruitingBoard!

---

Recruiting Board: Setup UI Settings
- Setup Bust Style UI settings for Scene_RecruitBoard.
- Requires VisuMZ_4_RecruitingBoard!

  Background Graphic:
  - What background image do you wish to use?

  Bust Graphic:
  - What character bust image do you wish to use?

    Bust Settings:
    - These settings adjust the bust settings and how they visually appear
      in-game for the recruiting board.
    - Look in the Plugin Parameters for the identical settings.
    - If this is left empty or at {}, then use the defaults found in the
      Plugin Parameters.

  Messages:
  - What messages would you like to use for this recruiting board?
  - Look in the Plugin Parameters for the identical settings.
  - If this is left empty or at {}, then use the defaults found in the
    Plugin Parameters.

---

Skill Shop Plugin Commands

ShopBustStyleUI Preview4.png

---

Skill Shop: Clear UI Settings
- Clear Bust Style UI settings for Scene_SkillShop.
- Requires VisuMZ_4_SkillShop!

---

Skill Shop: Setup UI Settings
- Setup Bust Style UI settings for Scene_SkillShop.
- Requires VisuMZ_4_SkillShop!

  Background Graphic:
  - What background image do you wish to use?

  Bust Graphic:
  - What character bust image do you wish to use?

    Bust Settings:
    - These settings adjust the bust settings and how they visually appear
      in-game for the skill shop.
    - Look in the Plugin Parameters for the identical settings.
    - If this is left empty or at {}, then use the defaults found in the
      Plugin Parameters.

  Messages:
  - What messages would you like to use for the skill shop?
  - Look in the Plugin Parameters for the identical settings.
  - If this is left empty or at {}, then use the defaults found in the
    Plugin Parameters.

---


Plugin Parameters

Default Bust Settings

ShopBustStyleUI Preview1.png

ShopBustStyleUI Param1.png

Default bust settings if you don't adjust the "Bust Settings" in the Plugin Command or if you leave it at {}.

---

Settings

 Anchor X:
 - Anchor value X. Use a number between 0 and 1.
 - 0.0 - Left; 0.5 - Center; 1.0 - Right
 Anchor Y:
 - Anchor value Y. Use a number between 0 and 1.
 - 0.0 - Top; 0.5 - Middle; 1.0 - Bottom
 Position X:
 - Bust position X value. Use a number between 0 and 1.
 - 0.0 - Left; 0.5 - Center; 1.0 - Right
 Position Y:
 - Bust position Y value. Use a number between 0 and 1.
 - 0.0 - Top; 0.5 - Middle; 1.0 - Bottom

---


Voice Line Settings

ShopBustStyleUI Preview1.png

ShopBustStyleUI Param2.png

Voice line settings for ALL shop messages with voice lines.

Requires VisuMZ_2_VoiceActControl!

---

Settings

 Delay MS:
 - Delay the playing of voice lines to not conflict with any shop sound
   effects.
 - 1000 milliseconds = 1 second.
 Volume:
 - Volume of the voice line played.
 Pitch:
 - Pitch of the voice line played.
 Pan:
 - Pan of the voice line played.

---


Scene_Shop > Scene Settings

ShopBustStyleUI Preview1.png

ShopBustStyleUI Param3.png

Bust Style UI settings applied to Scene_Shop.

Includes all of the window settings, too.

---

General Settings

 Max Rows:
 - What is the maximum number of rows for stylized shop lists?
 Fade In/Out?:
 - Allow fade in/out for stylized general shops?

---

Exit Shop

 Exit Delay MS:
 - What is the delay after exiting the shop scene in milliseconds?
 - 1000 milliseconds = 1 second.

---

Scaling

 General Window Scale:
 Status Window Scale:
 - What is the scale used for most general/status windows?
 - 0.0 - 0%; 0.5 - 50%; 1.0 - 100%

---

Window Settings

 Command Window:
 Gold Window:
 Number Window:
 Status Window:
 Buy List Window:
 Sell Category Window:
 Sell List Window:
 Message Window:
   JS: X, Y, W, H:
   - Code used to determine the dimensions for this window.

---


Scene_Shop > Default Messages

ShopBustStyleUI Preview1.png

ShopBustStyleUI Param4.png

Default messages used if you don't adjust the "Message Settings" in the Plugin Command. This will apply only for Scene_Shop

---

Messages

 Welcome Message:
 Leave Message:
 Buy Command:
 About to Buy:
 Cancel Buying:
 Buy Complete:
 Sell Command:
 About to Sell:
 Cancel Selling:
 Sell Complete:
   Message:
   - Message used for this shop situation.
   - Text codes allowed.
   Bust Change:
   - Changes bust graphic when this message is displayed.
   - Leave empty to not use.
   Voice Line:
   - Voice line used for this message text.
   - Requires VisuMZ_2_VoiceActControl!
   - Leave empty to not use.

---


Compatibility

ShopBustStyleUI Preview2.png

ShopBustStyleUI Preview3.png

ShopBustStyleUI Preview4.png

ShopBustStyleUI Param5.png

The are Plugin Parameters for VisuStella MZ's Hospital Shop plugin, Recruiting Board plugin, and Skill Shop Plugin. Each one contains similar data to Scene_Shop along with their messages. Adjust them accordingly.

---

Scene Data > General Settings

 Max Rows:
 - What is the maximum number of rows for stylized shop lists?
 Fade In/Out?:
 - Allow fade in/out for stylized general shops?

---

Scene Data > Exit Shop

 Exit Delay MS:
 - What is the delay after exiting the shop scene in milliseconds?
 - 1000 milliseconds = 1 second.

---

Scene Data > Scaling

 General Window Scale:
 Skill Window Scale:
 - What is the scale used for most general/status windows?
 - 0.0 - 0%; 0.5 - 50%; 1.0 - 100%

---

Scene Data > Window Settings

 Various Windows:
   JS: X, Y, W, H:
   - Code used to determine the dimensions for this window.

---

ShopBustStyleUI Param6.png

Default Messages

 Various Messages:
   Message:
   - Message used for this shop situation.
   - Text codes allowed.
   Bust Change:
   - Changes bust graphic when this message is displayed.
   - Leave empty to not use.
   Voice Line:
   - Voice line used for this message text.
   - Requires VisuMZ_2_VoiceActControl!
   - Leave empty to not use.

---



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 1, 2023

  • Finished Plugin!


See Also


End of Helpfile