Documentation
Quick InfoVersion: Alpha
Made for RPG Maker MZ 1.9.0
Quick Start GuideSet up your guide entries in the plugin parameters. The Discovered parameter determines if it will start your game discovered (shown to the player) or not. Other data is not saved, so you can edit it in the parameters and see any changes in your game.
To call the scene, use the Call Scene Plugin Command. You can also add the scene to the main menu using a plugin that can add custom menu commands such as [CGMZ] Menu Command Window. The JS to add this to the menu is:
SceneManager.push(CGMZ_Scene_GameManual);
Manual entries are created using images, text, and headers. Each entry parameter comes with sub-parameters for Texts, Images, and Headers. To show these, use the Display Info parameter to add a new display line item or drag+drop them to re-order. For example, if your guide entry has 2 text elements and an image and you want it to appear in the order of text, image, text, then you would add 3 line items to the guide Display Info parameter with the first being Text, the second being Image, and the third being Text. See below section for an explanation of what each line item does.
Display Line ItemsThis plugin has the following line items you can display in the display window:
Text - Shows a paragraph of text. Supports text codes.
Image - Shows an image.
Header - Shows a header element with 2 dividing gradient lines and some centered text in the middle. Supports text codes.
Blank Line - A standard line height worth of blank vertical space.
Custom Space - A custom amount of vertical space, amount determined by the plugin parameter of the same name.
JavaScriptTo call the scene using js, use the following code:
SceneManager.push(CGMZ_Scene_GameManual);
Plugin CommandsThis plugin supports the following plugin commands:
Call Scene
Calls the manual scene
Change Discover
Change the discover status of a manual entry
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_Manual.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.