Difference between revisions of "Visual Gold Display VisuStella MZ"

From Yanfly.moe Wiki
Jump to navigation Jump to search
(Plugin Parameters)
Line 1: Line 1:
|preview = <youtube>link</youtube>
|preview = <youtube>link</youtube>
|link1 = <html>link</html>
|link1 = <html><iframe frameborder="0" src="https://itch.io/embed/1196396" width="552" height="167"><a href="https://visustellamz.itch.io/visual-gold-display">Visual Gold Display plugin for RPG Maker MZ by VisuStellaMZ</a></iframe></html>
|link2 = {{VisuStella Merchant Manager Vol 1}}
|link2 = {{VisuStella Merchant Manager Vol 1}}

Revision as of 17:10, 13 September 2021

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.



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.

VisualGoldDisplay Preview1.png

VisualGoldDisplay 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.


VisualGoldDisplay Preview1.png

If you ever wanted to make it look like 1 gold is equal to 100 pieces of silver, and 1 silver is equal to 100 pieces of copper, this plugin will allow that to happen. Want a diamond to represent the millions, you can do that. Want a gold bar to represent the thousands? This plugin changes how gold is displayed in game in the majority of scenes (though not all of them due to visible screen space limitations). Determine which icons appear where and how they're formed.

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

  • Determine the icon for each deonomination range. These go up to billions.
  • Determine how zeroes are padded in and/or out to make costs look more compact or full.
  • This plugin adds text codes that allow you to quickly transform numbers into the Visual Gold Display format.
  • Add exception rulings to how no cost items are displayed or how numbers will appear after exceeding a specific numeric range.
  • For some windows, auto-sizing will take place to reduce the size of the text in case it would normally overflow.


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.


Drawn Currency Unit

VisualGoldDisplay Preview2.png

The default Window_Base drawCurrencyValue has been overwritten for this function as long as the default gold current unit is being used. Any plugins that make changes to how gold is displayed will be incompatible with this plugin. You have been warned!


VisuStella MZ Compatibility

While this plugin is compatible with the majority of the VisuStella MZ plugin library, it is not compatible with specific plugins or specific features. This section will highlight the main plugins/features that will not be compatible with this plugin or put focus on how the make certain features compatible.


Skill Learn System VisuStella MZ

We have opted to display gold costs for skills normally here instead of via the Visual Gold Display format. This is because with the Visual Gold Display format, data becomes too cluttered and hard to read.


Steal Items VisuStella MZ

When stealing gold with both this plugin and Steal Items installed, the text format used for gold will be shifted to the regular item format instead of the currency format for consistency purposes.


Victory Aftermath VisuStella MZ

Gold acquired and shown through Victory Aftermath will be in the Visual Gold Display format. This is done automatically.


Text Codes


Text Codes are used in the Show Text event command. They are used to display things that text normally can't produce on its own, such as colors, get the name of a specific actor, change icons, and more.

RPG Maker MZ already comes with text codes of its own:

\V[n] Will be replaced with the value of the nth variable.
\N[n] Will be replaced with the name of the nth actor.
\P[n] Will be replaced by the name of the nth (arranged order) party member.
\G Will be replaced by the currency unit.
\C[n] Draw the subsequent text in the nth color. Text color conforms to the contents of the [Window.png] system image.
\I[n] Draws the nth icon.
\FS[n] Changes the text font size to 'n'.
\{ Increases the text by 1 step.
\} Decreases the text by 1 step.
\\ Replaced with the backslash character.
\$ Open the gold window.
\. Wait for 1/4 second.
\| Wait for 1 second.
\! Wait for button input.
\> Display remaining text on same line all at once.
\< Cancel the effect that displays text all at once.
\^ Do not wait for input after displaying the next.

The following are text codes that you may use with this plugin.

Display-Related Text Codes

VisualGoldDisplay Preview2.png


--------------------   -----------------------------------------------------
Text Code              Effect
--------------------   -----------------------------------------------------

\GoldFull[x]           Displays number 'x' in Visual Gold Display format
                       with padded zeroes.
\GoldPad[x]            Displays number 'x' in Visual Gold Display format
                       with padded zeroes.

\GoldShort[x]          Displays number 'x' in Visual Gold Display format
                       without padded zeroes.
\GoldOmit[x]           Displays number 'x' in Visual Gold Display format
                       without padded zeroes.


Plugin Parameters

Icon Settings

Settings used to display the different icons at different denomination digit ranges.


VisualGoldDisplay Preview2.png

VisualGoldDisplay Params1.png


 1,000,000,000 through 10:
 - What icon do you want to use for this place value?
 - Use 0 to bypass this digit slot.


Display Settings

VisualGoldDisplay Preview1.png

VisualGoldDisplay Params2.png

Settings to determine how certain aspects are shown regarding the Visual Gold Display.


Text Format

 Whole Format:
 - How the entire text display looks.
 - %1 - All Segments; %2 - Currency Icon; %3 - Currency Name
 Segment Format:
 - How individual segments look.
 - %1 - Segment Value; %2 - Segment Icon


Pad Zeroes

 General Windows:
 - Pad zeroes in general windows?
 Gold Window:
 - Pad zeroes in the Gold Window?



 General Windows:
 - Auto-size the currency value if it's too large for general windows?
 Gold Window:
 - Auto-size the currency value if it's too large for the Gold Window?


Special Cases

VisualGoldDisplay Preview1.png

VisualGoldDisplay Params3.png

These settings determine how the currency displays in special cases.


No Costs

 - Show different text when there's 0 gold costs?
 Text Format:
 - Text format used for display gold with 0 cost.
 - %1 - Currency Icon; %2 - Currency Name


Upper Limit

 Limit Value:
 - What is the upper limit before display different text?
 - Use 0 to disable this.
 - If auto-size is being used and the font size has become too small, the
   upper limit text will also be used.
 Text Format:
 - Text format used for display gold past upper limit.
 - %1 - Currency Icon; %2 - Currency 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に掲載されていますので、それを参照し従ってください。


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

Team VisuStella


Version 1.00 Official Release Date: October 6, 2021

  • Finished Plugin!

End of File