Documentation
Quick InfoVersion: Beta R3
Made for RPG Maker MZ 1.9.0
The BasicsSo you've downloaded a bunch of icon packs from itch.io or elsewhere, only to find out that they contain individual icon files while RPG Maker expects one image file with every icon placed in it in a specific way. This plugin solves that problem for you.
You can use this plugin to automatically create an RPG Maker IconSet from multiple individual icon files. Simply turn the plugin on in the plugin manager and then call the plugin command to generate an iconset.
CautionThis plugin is a developer tool. It is not meant to be included in the final export of the game. The plugin command will crash on web hosted games and possibly mobile exports since these places do not allow direct writing of files to the user's local files. Simply having the plugin present in exported games will not cause any issues, but is still not recommended.
Upscaling and DownscalingThis plugin can upscale or downscale icons. If you have a bunch of 24x24 icons from VX Ace or earlier and want to make them work in MZ, you can! Set the output width/height to MZs 32x32px and your 24x24 icons will be scaled up to 32x32 on the final IconSet output. The same can work with downscaling.
Please note that upscaling/downscaling inherently need to add or remove pixels, so the final output will not look exactly like the original. For best results, it is always recommended to redraw icons in the size you want.
AppendingAppending makes the assumption that the icons you are appending will be the same size as the existing icons in the IconSet you are appending to, this plugin will not resize the existing icons on the IconSet.
Plugin CommandsThis plugin supports the following plugin commands:
Create IconSet - Will create a new IconSet file with the name "IconSet" and in PNG format from multiple individual icon files. By Default, RPG Maker expects 16 icons per row, and for icons to be 32x32 (MZ and MV) or 24x24 for older versions of RPG Maker.
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_IconSetGenerator.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 Beta
- Added the ability to also parse icons from subfolders
- Fixed bug where append was not able to find the iconset
- Added option to automatically create hue rotated versions of icons
- Added option to change filename of output image
- Removed deprecated Core functions