Documentation
Quick InfoVersion: Alpha
Made for RPG Maker MZ 1.9.0
Babylon JSAs you may know, RPG Maker uses Pixi JS which is a 2D engine. For showing 3D models, this plugin uses Babylon JS. You will need to also install the babylon js engine and loaders to display and load 3d model files into your game. Due to licensing requirements, these come separate bundled in the .zip file you downloaded this plugin with. You need to install both the babylon js engine as well as the loaders file. There is no setup in those, you just make sure they are ON in your Plugin Manager. If you are using a different plugin that adds 3D via Babylon JS, you may already have them, in which case you should not add them again.
File TypesCurrently, this plugin supports glb files. You should place these in the base models folder as set up in your plugin parameters (default: models).
If your 3d object references other files, such as a colormap, you should also place these in the root model folder in the structure your file expects.
LicensePlease see the Babylon.js or loader's JS plugin for the respective licenses required for babylon js.
The full license can be found (at the time this documentation was made) at their github page.
Plugin CommandsThis plugin supports the following plugin commands:
Call Scene - Calls the 3d model viewer 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_ModelViewer.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.