Shop Listing Unlock VisuStella MZ

From Wiki
Jump to navigation Jump to search

Welcome to the wiki! This is where you can find resources from, Æ,
VisuStella, Caz Wolf, Fallen Angel Olivia, Atelier Irina, and other affiliated content creators.



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.

Click here to learn how to update plugins.

Click here for how to troubleshoot plugins if you get an error.

Masterarbeit Writer

ShopListingUnlock Preview.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.



This plugin allows shop listings to unlock via buying and selling items in any shop. Ever wanted to make a Super Potion that unlocks after buying 10 regular Potions, now you can. Ever wanted to make a Monster Mana Potion unlock after selling enough Slime Cores? Now you can.

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

  • Create lists of items needed to be sold or bought before an item, weapon, or piece of armor can be unlocked via notetags.
  • Items that have not yet been unlocked but have some progress made to them can become visible in the shop listings, but are unable to be bought.
  • When these "in-progress" items are selected, a list of the necessary items needed to be bought/sold through any shop is shown in the status window.
  • When these requirements are fulfilled, the shop item becomes available for purchase like normal.
  • This can be used to create tier like systems of shop progression based on what the player purchases
  • This can also create more player interactivity by allowing certain items to become available based on what players sell back to the shop.
  • Visible but not yet unlocked item listings in shops can have different rulings for when their visibility conditions become available via notetag.


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.


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.


Shop Unlock-Related Notetags

ShopListingUnlock Preview.png


<Shop Unlock Requirements>
</Shop Unlock Requirements>

- Used for: Item, Weapon, Armor Notetags
- Creates a list of requirements before the listed item, weapon, or armor
  will appear in the shop.
  - These items still have to be listed normally inside of "Shop Processing"
    event. They just don't become available until the unlock requirements
    have been met.
- Replace 'requirement' with any of the requirement types found below.

    Buy Item id: quantity
    Buy Item name: quantity
    Buy Weapon id: quantity
    Buy Weapon name: quantity
    Buy Armor id: quantity
    Buy Armor name: quantity
    Buy Gold: quantity

    Sell Item id: quantity
    Sell Item name: quantity
    Sell Weapon id: quantity
    Sell Weapon name: quantity
    Sell Armor id: quantity
    Sell Armor name: quantity
    Sell Gold: quantity

  - Replace 'id' with a number representing the ID of the item, weapon, or
    armor that is required to be bought or sold.
  - Replace 'name' with the associated item, weapon, or armor's name.
  - Replace 'quantity' with a number representing the number of items,
    weapons, or armors bought or sold.
  - For gold, "Buy Gold" refers to the amount of gold spent when buying
    items of any sort. "Sell Gold" refers to the amount of gold earned after
    selling items of any sort.
  - Insert multiple lines to add more shop unlock requirements.



  <Shop Unlock Requirements>
   Buy Item Potion: 5
   Buy Gold: 2000
  </Shop Unlock Requirements>

  - This makes the item with this notetag require at least 5 Potions to be
    bought and at least 2000 gold has to be spent inside any shop for this
    item to become unlocked for the player to purchase.


  <Shop Unlock Requirements>
   Sell Item Tiger Fang: 10
   Sell Item Tiger Claw: 5
  </Shop Unlock Requirements>

  - This makes the item with this notetag require at least 10 Tiger Fangs
    and at least 5 Tiger Claws to be sold to any shop before this item
    becomes unlocked for the player to purchase.



<Shop Unlock Visible: Always>
<Shop Unlock Visible: Progress>
<Shop Unlock Visible: Never>

- Used for: Item, Weapon, Armor Notetags
- Requires <Shop Unlock Requirements> notetag present, too.
- An item, weapon, or armor with this notetag will change the shop listing
  unlock visibility requirements to something else.
  - Always - Always show unlockable items regardless of progress.
  - Progress - Show unlockable items as long as there is progress.
  - Never - Don't show items until fully unlocked.
- If this notetag is not used, refer to the default ruling set up in the
  Plugin Parameters.


Plugin Parameters

Vocabulary Settings

ShopListingUnlock Preview.png

ShopListingUnlock Param1.png

These settings let you adjust the text displayed for this plugin.


Buy Window:

 Price Text:
 - This is the text that appears in place of the price for items that have
   yet to be unlocked. Text codes allowed.


Status Window:

 Title Text:
 - Text that appears in the title for unlocks in progress.
 - Text codes allowed.
 Item Entries:
   Buy Item Format:
   - Text label for items that need to be bought.
   - %1 - Item Name.
   - Text codes allowed.
   Sell Item Format:
   - Text label for items that need to be sold.
   - %1 - Item Name.
   - Text codes allowed.
   Item Name Format:
   - Text format used for item names.
   - %1 - Item Name. %2 - Item Icon.
   - Text codes allowed.
 Gold Entries:
   Buy Gold Format:
   - Text label for gold spent on buying items.
   - %1 - Currency Name.
   - Text codes allowed.
   Sell Gold Format:
   - Text label for gold gained from selling items.
   - %1 - Currency Name.
   - Text codes allowed.
 Number Display Format:
 - Text format used for quantity required.
 - %1 - Current Amount. %2 - Target Amount.
 - Text codes allowed.


Window Settings

ShopListingUnlock Preview.png

ShopListingUnlock Param2.png

These settings let you adjust the windows displayed for this plugin. For the shop status window, if you decide to display unlock requirements, the contents will be automatically generated for the unlock requirements list. If an entry's item name and text is too large to fit together in one line, they will form multiple lines.


Buy Window:

 In-Progress Rulings:
 - What rulings do you want unlockable items to have?
   - Always - Always show unlockable items regardless of progress.
   - Progress - Show unlockable items as long as there is progress.
   - Never - Don't show items until fully unlocked.
 Change Price Text?:
 - Change the price text for items that have not been unlocked?
 Change BG Color?:
 - Change the background color of item listings that have not been
   BG Color 1:
   BG Color 2:
   - Use #rrggbb for custom colors or regular numbers for text colors from
     the Window Skin.


Status Window:

 Show Requirements?:
 - Show the requirements needed to fully unlock an item listing?
 Conditions Met Color:
 - Use text colors from the Window Skin. Does not work with #rrggbb


Terms of Use

1. These plugins may be used in free or commercial games provided that they have been acquired through legitimate means at and/or any other official approved VisuStella sources. Exceptions and special circumstances that may prohibit usage will be listed on

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 and other official/approved VisuStella sources. A list of official/approved sources can also be found on

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 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 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に掲載されていますので、それを参照し従ってください。


If you are using this plugin, credit the following people in your game:

Team VisuStella


Version 1.00 Official Release Date: November 27, 2023

  • Finished Plugin!

See Also

End of Helpfile