Casper Gaming Developer Corner
Casper Gaming Developer Corner

Documentation

Back to Plugin

Terms of Use
Become a Patron
Discuss / Support
Quick InfoVersion: Alpha
Made for RPG Maker MZ 1.10.0
REQUIRED: All [CGMZ] Plugins require [CGMZ] Core placed above them in the Plugin Manager.
Quick Start GuideTo get started using this plugin, follow the below steps:

1. Set up your lore books and lore pages in the plugin parameters.

2. Use plugin command to find pages or books as needed.

3. Call the Lore Scene via plugin command, or add it to the menu using something like [CGMZ] Menu Command Window.
Display Line ItemsEach lore page is created from multiple line items. These are as follows:

Text
Shows a paragraph of text. Supports text codes.

Image
Shows an image. Can either be inline (alongside text) or block (reserves entire horizontal space).

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.
Plugin CommandsThis plugin supports the following plugin commands:

Call Scene
Calls the lore scene

Discover Book
Change the discovered status of a book

Call Scene
Change the discovered status of an individual page
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_Lore.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.

Back to Plugin