More Currencies 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.



MoreCurrencies Preview1.png

MoreCurrencies Preview2.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.


Support VisuStella

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


Introduction

MoreCurrencies Preview1.png

This plugin expands the shop scene's functionality by allowing the game dev to create items that can be sold for items and/or variables instead of gold. Or you know what? Throw gold in there, too. Any combination of the them! By doing so, gold no longer becomes the default currency for every shop, as some special shops may require a different type of trade.

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

  • Items can be bought using items, weapons, armors, variables, gold, or any of the combinations listed.
  • Sell items this way, too!
  • Sold item listing window will now show the amount the player can get back per unit sold.
  • Shop scene's calculation window is now updated to show the transaction details from how much the player owns to how much will be spent to what kind of result there will be.
  • Proxy system support allows for shops to sell the same items but using different types of currencies.

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 2

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

MoreCurrencies Preview2.png

The visual contents of this window have been completely overhauled to show the details of what transactions are happening. This includes how much or many of a resource the player owns, how much will be involved in the actual transaction, and the net outcome after the transaction has taken place.

Naturally, this means that things will have to shift around in order for the space to make any sense.

---

Proxy Items

MoreCurrencies Preview1.png

Proxy Items are temporary substitutes for another. When they are acquired through shopping, they will turn into the item, weapon, or armor they are a proxy for. Only the icon, name, help description, and status details will match up. Everything else will remain separate such as the notetag data and the trading list. This allows you to effectively have multiple ways to trade the same item using different item combinations.

For more details, look inside of the Notetags section for Proxy items.

---

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.

---

Cost-Related Notetags

MoreCurrencies Preview2.png

---

<Item id Buy Cost: x>
<Item name Buy Cost: x>

<Item id Sell Cost: x>
<Item name Sell Cost: x>

<Item id Cost: x>
<Item name Cost: x>

- Used for: Item, Weapon, Armor Notetags
- The "buy" variant determines the item and quantity needed to purchase this
  object in the shop.
- The "sell" variant determines the item and quantity acquired when selling
  this object in the shop.
- The neither variant will determine both buy/sell transactions related to
  the item and quantities when selling.
  - Selling the object will yield a lower quantity determined by the sell
    rate found in Plugin Parameters > General > Automatic Sell Rate.
  - This variant cannot be used with the Buy/Sell notetag variants. If
    either the buy or sell notetag variants are detected, this doesn't work.
- Replace 'id' with a number representing the ID of the item to be taken
  (when bought) or acquired (when sold).
- Replace 'name' with the name of the item to be taken (when bought) or
  acquired (when sold).
- Replace 'x' with the quantity of the item that will be taken (when bought)
  or acquired (when sold).
- Insert multiple copies of these notetags to add more item costs.

---

<Weapon id Buy Cost: x>
<Weapon name Buy Cost: x>

<Weapon id Sell Cost: x>
<Weapon name Sell Cost: x>

<Weapon id Cost: x>
<Weapon name Cost: x>

- Used for: Item, Weapon, Armor Notetags
- The "buy" variant determines the weapon and quantity needed to purchase
  this object in the shop.
- The "sell" variant determines the weapon and quantity acquired when
  selling this object in the shop.
- The neither variant will determine both buy/sell transactions related to
  the weapon and quantities when selling.
  - Selling the object will yield a lower quantity determined by the sell
    rate found in Plugin Parameters > General > Automatic Sell Rate.
  - This variant cannot be used with the Buy/Sell notetag variants. If
    either the buy or sell notetag variants are detected, this doesn't work.
- Replace 'id' with a number representing the ID of the weapon to be taken
  (when bought) or acquired (when sold).
- Replace 'name' with the name of the weapon to be taken (when bought) or
  acquired (when sold).
- Replace 'x' with the quantity of the weapon that will be taken (when
  bought) or acquired (when sold).
- Insert multiple copies of these notetags to add more weapon costs.

---

<Armor id Buy Cost: x>
<Armor name Buy Cost: x>

<Armor id Sell Cost: x>
<Armor name Sell Cost: x>

<Armor id Cost: x>
<Armor name Cost: x>

- Used for: Item, Weapon, Armor Notetags
- The "buy" variant determines the armor and quantity needed to purchase
  this object in the shop.
- The "sell" variant determines the armor and quantity acquired when
  selling this object in the shop.
- The neither variant will determine both buy/sell transactions related to
  the armor and quantities when selling.
  - Selling the object will yield a lower quantity determined by the sell
    rate found in Plugin Parameters > General > Automatic Sell Rate.
  - This variant cannot be used with the Buy/Sell notetag variants. If
    either the buy or sell notetag variants are detected, this doesn't work.
- Replace 'id' with a number representing the ID of the armor to be taken
  (when bought) or acquired (when sold).
- Replace 'name' with the name of the armor to be taken (when bought) or
  acquired (when sold).
- Replace 'x' with the quantity of the armor that will be taken (when
  bought) or acquired (when sold).
- Insert multiple copies of these notetags to add more armor costs.

---

<Variable id Buy Cost: x>

<Variable id Sell Cost: x>

<Variable id Cost: x>

- Used for: Item, Weapon, Armor Notetags
- The "buy" variant determines the variable and quantity needed to purchase
  this object in the shop.
- The "sell" variant determines the variable and quantity acquired when
  selling this object in the shop.
- The neither variant will determine both buy/sell transactions related to
  the variable and quantities when selling.
  - Selling the object will yield a lower quantity determined by the sell
    rate found in Plugin Parameters > General > Automatic Sell Rate.
  - This variant cannot be used with the Buy/Sell notetag variants. If
    either the buy or sell notetag variants are detected, this doesn't work.
- Replace 'id' with a number representing the ID of the variable to be taken
  (when bought) or acquired (when sold).
- Replace 'name' with the name of the variable to be taken (when bought) or
  acquired (when sold).
- Replace 'x' with the quantity of the variable that will be taken (when
  bought) or acquired (when sold).
- Insert multiple copies of these notetags to add more variable costs.

---

Proxy Notetags

MoreCurrencies Preview1.png

---

<Proxy: id>
<Proxy: name>

- Used for: Item, Weapon, Armor Notetags
- REQUIRES the most up to date VisuMZ Items and Equips Core!
- Turns this item, weapon, or armor into a proxy for another item, allowing
  you to create trades with different components using the above notetag
  contents and yield the same item.
- The proxy item itself will take on the name, icon, and description of the
  original item it is supposed to represent.
- No other properties are carried over from the original.
- When viewed through the Window_ShopStatus window, the contents will
  reference the original item and not the proxy item.
- Proxy items themselves cannot be acquired. This includes event commands,
  item drops, or equips.
- When bought, the item yielded won't be the proxy item but the item it is
  a proxy for.
- Replace 'id' with a number representing the item, weapon, or armor ID of
  the same item type. If the proxy is an item, this will reference an item.
  If the proxy is a weapon, this will reference a weapon. Same for armors.
- Replace 'name' with text representing the item, weapon, or armor's name.
  The referenced item needs to be the same item type as the proxy. Item for
  item, weapon for weapon, armor for armor.
- Insert multiple copies of these notetags to add more variables costs.

---

Plugin Parameters

General Settings

MoreCurrencies Preview2.png

MoreCurrencies Params1.png

Default settings for More Currencies.

---

General

 Automatic Sell Rate:
 - When using the plain "Cost" notetags, use this sell rate.

---

Vocabulary

 Owned:
 - Text used for how much of an item is owned.
 Shift:
 - Text used for the change in value.
 Net:
 - Text used for the net result.

---

Listing Settings

MoreCurrencies Preview1.png

MoreCurrencies Params2.png

Settings for the currency listings.

---

Listing

 Listing Order:
 - Determines the order the trade components are listed.
 Show Sell Window:
 - Show listed items in the sell window?
 List Font Size:
 - Font size used for listed items.
 List Padding:
 - Pixel padding between listed items.

---

Text Format

 Item Format:
 Weapon Format:
 Armor Format:
 Variable Format:
 - Text format used for listed items.
 - %1 - Cost, %2 - Owned, %3 - Icon, %4 - Name

---


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: February 17, 2022

  • Bug Fixes!
    • Item, Weapon, Armor Cost Notetags should no work properly. Fix by Irina.
  • Documentation Update!
    • Added documentation for the following notetags:
      • <Variable id Buy Cost: x>
      • <Variable id Sell Cost: x>
      • <Variable id Cost: x>


Version 1.00 Official Release Date: March 7, 2022

  • Finished Plugin!

End of File