Documentation
Quick InfoVersion: 1.14.0
Made for RPG Maker MZ 1.9.0
List OrderYou can use the List Order parameters for the default categories to change the display order of those entries in the encyclopedia. Entries not listed in the List Order parameter will display in the default order (how they are in the database).
Large Icon Multiplier OptionThis option changes the size of the icon displayed by default for items, armors, weapons, states, and skills. It displaces text to the right based on its height. Here are some common multiplier sizes that play nice with text:
Lines displaced: 1, use multiplier size: 1.1
Lines displaced: 2, use multiplier size: 2.2
Lines displaced: 3, use multiplier size: 3.3
Text CodesIn a custom entry description, you can use the encyclopedia text code: \cgmzencdescimg[x] to display the x numbered sketch belonging to the same entry mixed in with the text of the description. Begins at 0 for the first sketch.
NotetagsThis plugin uses the following notetags:
<cgmzdesc:[description]> - Puts a "note" in the encyclopedia display page
<cgmzencyclopediahide> - Does not include the item in the encyclopedia
Custom CategoriesCustom categories must be manually tracked. Default categories (bestiary, item, weapon, armor, skill, state) will all be automatically tracked if included except for some uncommon circumstances.
SubcategoriesSubcategories are optional. To set up a subcategory, provide the main category id and then a unique id for the subcategory. There will also be an "all" subcategory, so do not use "all" for the subcategory id. From there, you can choose the entry ids to include in the subcategory.
You could use this to split the bestiary up between normal and boss enemies, weapons between axes, maces, and swords, and many more uses.
Default main category ids are: bestiary, items, armors, weapons, skills, states, actors.
Category BackgroundsTo show a background image in the Encyclopedia Scene for a specific category, set the symbol to the category symbol and the preset to match a [CGMZ] Scene Backgrounds preset id.
The symbols for the default categories are: bestiary, items, armors, weapons, skills, states, actors.
Adding To BattleTo easily call the encyclopedia from the battle, use [CGMZ] Battle Command Window and use the following script in its parameters if in a party command:
this.showCGMZEncyclopedia(true);
If you are instead calling it from an actor command, use the js:
this.showCGMZEncyclopedia(false);
Adding To MenuTo easily call the encyclopedia from the main menu, use [CGMZ] Menu Command Window and use the following script in its parameters:
SceneManager.push(CGMZ_Scene_Encyclopedia);
If you want to have a specific category selected, you can add the following JS after the above JS:SceneManager.prepareNextScene(category);
where category will be something like "items" including the quotationsIntegrationThis plugin has additional functionalities when used with the following plugins:
[CGMZ] Scene Backgrounds - Show custom backgrounds for each category, including scrolling backgrounds or weather in the background.
[CGMZ] Scan - Require using a scan skill on an enemy to discover it in the bestiary.
[CGMZ] Difficulty - Change enemy stats by difficulty and have those stats reflected in the bestiary.
[CGMZ] Achievements - Add achievements for completing the encyclopedia or its various categories.
Date FormatsThe following numbers correspond to the following date formats:
0, 1, 2: Numeric day, month, year
3, 4: Numeric day, long month, numeric year
5, 6: Numeric day, short month, numeric year
7, 8: Numeric day, month
Date formats will take the user's locale into account.
Plugin CommandsThis plugin supports the following plugin commands:
Discover Enemy - Discovers the enemy with the ID provided
Discover Item - Discovers the item with the ID provided
Discover Weapon - Discovers the weapon with the ID provided
Discover Armor - Discovers the armor with the ID provided
Discover Skill - Discovers the skill with the ID provided
Discover State - Discovers the state with the ID provided
Discover Actor - Discovers the actor with the ID provided
Discover Custom - Discovers the custom entry with the ID and symbol provided
Discover Batch - Discovers multiple enemies/items/weapons/armors/skills/states/actors
Discover Custom Batch - Discovers multiple custom entries
Discover Range - Discovers a range of entries
Check Discovered - Turns a game switch ON/OFF if a given entry is discovered/undiscovered
Call Scene - Calls the encyclopedia scene. Optionally select the category which should begin selected.
Get Completion - Stores completion percentage of a category (or all if using total) in a game variable.
Reinitialize - Reinitializes ALL encyclopedia data as if you had started a new game
Saved GamesThis plugin is partially compatible with saved games. This means you can:
✓ Add this plugin to a saved game and it will work as expected.
✘ Modifying plugin parameters is not fully supported. The following will not work correctly in previously saved games: Modifying or deleting entries will not work in saved games, the saved game will act as if the entry was not modified or deleted.
✓ Remove the plugin with no issue to save data.
Filename
The filename for this plugin MUST remain CGMZ_Encyclopedia.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 1.1.0
- Added additional checks during battle to discover enemies
- Fixed totals window being too large in some cases
- Fixed list window items having no padding
- Fixed bug with the list window not scrolling up after cancel
- This plugin now initiates a check for CGMZ Achievements after discovery
- New entries and custom data are now automatically recognized in saved games
- Added ability to use text codes in descriptions, categories, and item lists
- Added option to change label text color
- Added option to change text alignment of totals window
- Added option to customize category window height and column count
- Added plugin command to discover multiple entries at once
- Fixed bug with custom image size being incorrect for first draw
- Fixed display bug for items with learn skill effects
- Fixed display bug with Drop Item Double party effects
- Compatibility for VS Core (fix for weird window spacing)
- Fixed bug with columns for other horizontal command windows
- Fixed bug with Include Categories (when set to OFF only) behaving weirdly
- Added ability to choose which info to display for every category
- Added ability to re-order information shown for every category
- Added custom batch discovery plugin command
- Added ability to turn off auto-discovery
- Increased max height of display window
- Fixed bug with custom entries that didn't have descriptions
- Fixed bug with uppercase symbols for custom categories
- Documentation no longer horizontally scrolls
- Documentation update to be easier to read/explain more
- You can now choose which category begins selected when the scene opens
- Added plugin command to store completion % in a variable
- Added plugin command to change custom entry description
- Added option to display different name in list and display windows for custom entries
- Custom entries now support multiple images instead of just one
- Added plugin command to change custom entry sketch
- Fixed issue with adding this plugin into a saved game that did not previously have the encyclopedia
- Added option to hide undiscovered entries from the list window
- Added option to customize the sort order in the list window
- Added text code for displaying sketch images mixed in with description for custom entries
- Updated color parameters to use new text color selector
- Bugfix for missing parameters if using Chinese language
- Added new built in category: Actors
- Added option to center large icons
- Added option to show list window on right
- Added option to disable Touch UI space at top
- Added ability to change window padding for each window
- Added ability to change windowskin for each window
- Added ability to change the list window width
- Added Spanish language support
- Bugfix for incorrect states being included in some cases
- Bugfix for font not resetting when drawing a new entry
- Bugfix for certain cases where touch UI could cause list window scroll to be incorrect
- Bugfix for crash when drawing actors with center icons option on
- Bugfix for actor entries resetting after first save
- Added ability to play BGMs while viewing enemies in bestiary
- Added option to display the date an entry was discovered
- Added option to autodiscover skills when they are used
- This plugin can now integrate with CGMZ Difficulty to show enemy stats/gold/exp based on the current difficulty
- This plugin now reports JSON parameter errors instead of crashing. If something isn't working right, please check dev tool console before reporting a bug
- Added option to display the skills an enemy can use
- Added option to have a custom scene background image for each category
- Added option to change header line gradient colors
- Added option to have windows be transparent
- Added plugin command to check if an entry has been discovered
- Added option to automatically hide entries that have no name or a user defined string in their name
- Added option to make entries in the encyclopedia opt-in
- Fixed crash when selecting empty enemy entry (all entries hidden)
- Fix bug with empty entry showing last selected non-empty entry info
- Added subcategories
- Custom entries can now display main-category object data
- Added custom headers and info lines to custom entries
- Added option to change category window alignment
- Added a way to purchase encyclopedia entries for gold + numerous options related to this new functionality
- Added option to use custom images for enemies
- Added option to use custom icon image for item/wep/armor/skill/state
- Added plugin command to discover entries by a range
- Added option to sort encyclopedia entries by discover date
- Added option to display TP costs in skills
- Fix potential crash when changing categories really quickly
- Now automatically discovers actors in starting party
- Converted deprecated cgmz temp calls to cgmz utils calls
- Added custom headers and info for all default categories
- Added option to draw walk, battle sprite for actors
- Added option to open encyclopedia by using an item
- Added options for windowskin, padding, back opacity, tone to all windows
- Added Center Face as its own option
- Fixed bug with actor face image not always being drawn
- Fixed bug with trying to draw blank actor nickname
- All text should now support text codes
- Removed List Window Text Code option
- Removed some unused Text params leftover from old versions
- Compatibility for [CGMZ] Scene Backgrounds
- Added encyclopedia to battle scene
- Added custom image list property for default categories
- Added integration with [CGMZ] Extra Stats for bestiary kill count
- Added a custom space amount option for blank space in display window
- Added option to prevent selecting list items
- Added [CGMZ] Scene Backgrounds integration
- Font size changes should now work better with encyclopedia
- Fixed bug with scroll being slightly off with custom padding
- Added bestiary trait display options
- Fixed bug with actor name in list window not updating with name change
- Added [CGMZ] Window Settings integration
- Added [CGMZ] Window Backgrounds integration
- Added New marker text for new entries
- Added option to hide the total window
- Added plugin command to change custom entry name
- Added integration with [CGMZ] Currency System
- Added integration with [CGMZ] Toast Manager
- Change Description now supports appending text
- Discovering custom entries now possible by name