Documentation
Quick InfoVersion: 1.0.2
Made for RPG Maker MZ 1.9.0
Mandatory SetupYou must set up the plugin parameters before this plugin will work.
The username parameter should be your itch IO username as seen in your URL.
The domain parameter should probably be itch.io.
The game name parameter should be your games name as seen in the game URL
If your game uses a secret (not public yet), you can fill that parameter in but it is recommended only for testing purposes since anyone can view it.
Example of how to find what to set plugin parameters:
casper-gaming.itch.io/example-game-name?secret=85pXFixTXzDnGPpVyaC82vGRP1Y
|..username..|domain.|....game name....|......|..........Secret..........|
Calling the APIThis plugin will automatically call the API for you when the game loads, and it will store the data temporarily while the game is playing. If this first API call returns unsuccessfully, Itch IO data will not be able to be displayed. You can optionally set the plugin to retry the API if previous calls have failed when exiting the Itch IO scene. However, once a call has succeeded, this plugin will no longer make API calls.
Integrations[CGMZ] Title Command Window
If you would like to add an option to view the itch.io buy link scene to the title window, you can use CGMZ Title Command Window with the following JavaScript parameter:
SceneManager.push(CGMZ_Scene_ItchIO);
Plugin CommandsThis plugin supports the following plugin commands:
Call Scene - This will call the itch IO buy link scene
Saved GamesThis plugin is fully compatible with saved games. This means you can:
✓ Add this plugin to a saved game and it will work as expected.
✓ Change any plugin params and changes will be reflected in saved games.
✓ Remove the plugin with no issue to save data.
Filename
The filename for this plugin MUST remain CGMZ_ItchIOBuyLink.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 1.0.1
- Added window padding, back opacity, tone options to windows
- Added [CGMZ] Scene Backgrounds integration
- Added [CGMZ] Controls Window Integration
- Added [CGMZ] Window Settings integration
- Added [CGMZ] Window Backgrounds integration