Documentation
Quick InfoVersion: Alpha R5
Made for RPG Maker MZ 1.9.0
LicenseYou can find documentation and a demo on the additional filters at:
https://filters.pixijs.download/main/docs/index.html
These filters are licensed under MIT license and not made by Casper Gaming. [CGMZ] Pixi Filters only provides a user friendly way to access these filters within RPG Maker since they are not built-in for RPG Maker.
To install the filters, please also import the included pixi-filters.js into your plugin manager. The filters included are v5.3.0. If you run into issues with a filter, you can try downgrading to an older version of the filters.
Finding FiltersBecause there are a lot of filters added by this plugin, they have been organized in alphabetical order where possible. If you want to add a Godray Filter, look for the plugin command in the filters starting with G.
Filter TargetThe filter targets are explained below:
Scene - This target will affect the entire scene, which means it should cover everything on screen
Spriteset - This target affects the spriteset (map/battle scenes). This will target everything added to the spriteset such as pictures or the timer. This will not affect windows.
Base Sprite - This only targets the spriteset's base sprite, which is most things but will not affect pictures, the timer, windows, etc.
Performance Note: Using too many filters may lead to drops in FPS.
ScenesIf using "All" it will affect all scenes. You should not add other scenes manually to this parameter when using All.
If not using All, you can select which scenes you want the filter to affect. Please be careful because some scenes do not have things like a spriteset, in which case if you select to target the spriteset the filter will not have any effect.
To select custom scenes, you can switch to the Text tab at the top of the parameter and manually type in a custom scene's constructor. You would need to get that from the custom scene's plugin author or by reading the plugin code. Alternatively, some plugins may integrate with this one to add a filter using a preset setting by calling the id. Filter presets can be retrieved using the following JS:
$cgmzTemp.getPixiFilterSettings(id);
FiltersCurrently this plugin supports the following filters:
- Adjustment Filter
- Advanced Bloom Filter
- Ascii Filter
- Blur Filter
- CrossHatch Filter
- CRT Filter
- Dot Filter
- Emboss Filter
- Glitch Filter
- Godray Filter
- Grayscale Filter
- Kawase Blur Filter
- Noise Filter
- Old Film Filter
- Pixelate Filter
Additional filters will be added over time.
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_PixiFilters.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
- Filters can now affect the entire spriteset
- Added Blur Filter
- Added Noise Filter
- Added filter setting presets
- Added grayscale option to Dot Filter
- Added alpha option to Godray Filter
- Major re-write of code, plugin commands revamped
- You can now target the entire scene including windows
- Split actual filter code into separate file
- Added Alpha filter
- Added Bloom filter
- Added Color Replace filter
- Added Bulge Pinch Filter