Documentation
Quick InfoVersion: Alpha R6
Made for RPG Maker MZ 1.9.0
Main CurrencyThe main currency controls which currency is displayed in the gold window, which is typically shown in the main menu or with the \$ text code.
Currency IDThe currency ID is just a unique way to refer to the currency. It does not have to be a number, just unique (no currencies can have the same ID). The ID "default" is reserved for the built-in currency and should not be used for a custom currency.
Text CodesText used in the descriptions support most text codes such as those used in the Show Text event command, including colors, icons, variables, etc. It should also support most custom text codes depending on the custom code implementation.
Default CurrencyThe default currency set up via the database is not affected by this plugin. Some options not available through the database are provided, such as the description parameter, but the options used in the database will be used for the default currency.
NotetagsTo set up enemies that drop custom currencies, use the notetag:
<cgmzcurrencyrewards:id:amount>
For example, if your currency id was "gems" and you wanted to drop 15, the note tag would be:
<cgmzcurrencyrewards:gems:15>
You can also separate multiple currencies via a comma. If you wanted the enemy to drop 15 gems AND 100 crystals, you could do:
<cgmzcurrencyrewards:gems:15,crystals:100>
You can drop as many currencies as you want via chaining them together with commas, there is no limit.
You can add a notetag to equip items that can grant the party the currency double effect for custom currencies. To do so, use the notetag:
<cgmzcurrencydouble:gems>
Similarly to above, you can add commas between currency types to double, for example:
<cgmzcurrencydouble:gems,crystals>
Script CallsThe following are script calls you may find useful:
SceneManager.push(CGMZ_Scene_CurrencyBag); - Calls the currency scene
Plugin CommandsThis plugin supports the following plugin commands:
Call Scene - Calls the currency scene
Gain Currency - Gain a specified amount of a currency
Lose Currency - Lose a specified amount of a currency
Discover Currency - Change discovered status of a currency
Set Main Currency - Designate a currency as the "main" currency. "default" = database currency
Get Currency Amount - Store the amount of currency a player has in a variable for use in conditionals
Check Main Currency - Store whether the main currency matches the id provided in a switch for use in conditionals
FAQQ: I just added the plugin without setting anything up and now my game is crashing?
A: This plugin adds unlimited new currencies, which is the main function of the plugin. It assumes you will set at least one currency up before using it and could have problems if none are set up.
Saved GamesThis plugin is partially compatible with saved games. This means you can:
✓ Add this plugin to a saved game and it will work as expected.
✘ Modifying plugin parameters is not fully supported. The following will not work correctly in previously saved games: Adding new currencies should work, but modifying or deleting existing currencies will most likely not work. Saved games will act as if the currency has not been modified or deleted.
✓ Remove the plugin with no issue to save data.
Filename
The filename for this plugin MUST remain CGMZ_CurrencySystem.js. This is what it comes as when downloaded. The filename is used to load parameters and execute plugin commands. If you change it, things will begin behaving incorrectly and your game will probably crash. Please do not rename the js file.
Known Issues
This plugin currently has no known issues that need to be fixed. If you believe you have encountered a bug, please report it to Casper Gaming.
Compatibility
This plugin currently has no known compatibility issues with other RMMZ plugins. If you believe you have encountered a conflict, please report it to Casper Gaming.
Version HistoryVersion AlphaR2
- Added option to make currency double equip effects for custom currencies
- Added window windowskin, padding, back opacity, tone options
- Optimized currency description handling
- Fixed bug with Currency Help window not following transparency option
- Compatibility for [CGMZ] Drop Tables to make plugin order not matter
- Compatibility for drawing currency values with third party plugins
- Now warns instead of crash on invalid json
- Added custom buy / sell prices for items, weapons, armors
- Added option to disable touch ui space if touch ui disabled
- Fixed issue with currency max 0 not being infinite
- Added currency exchange scene
- Added [CGMZ] Scene Backgrounds integration
- Added [CGMZ] Controls Window integration
- Transparent Windows parameter changed to include Dim and set per window
- Icon parameter type changed to icon select
- Color parameter type changed to color select
- Added column option for currency bag
- Added help window position option for currency bag
- Added left and right text parameters for currency bag
- Added background image parameters for currencies in currency bag
- Added [CGMZ] Window Backgrounds integration
- Fix bug with currency max of 0 not being infinite in the exchange scene
- Added [CGMZ] Window Backgrounds integration
- Added [CGMZ] Window Settings integration
- Fix bug with exchange window too small when Touch UI off