Welcome to PGMZ! My goal is to make it easy for everyone to find and share great plugins for creating amazing games. As a plugin developer myself, I'm excited to grow this community with all of you.
Scene Glossary - SceneGlossary.js
Plugin desc : In-game glossary plugin
License : MIT License
Author : Triacontane
Website : https://triacontane.blogspot.com
Desc page : https://github.com/triacontane/RPGMakerMV/tree/mz_master/SceneGlossary.js
Download Page : https://raw.githubusercontent.com/munokura/triacontane-MZ-plugins/refs/heads/main/SceneGlossary.js
File name : SceneGlossary.js
Help of plugin :
@target MZ
@url https://github.com/triacontane/RPGMakerMV/tree/mz_master/SceneGlossary.js
@plugindesc In-game glossary plugin
@author Triacontane
@license MIT License
@help
English Help Translator: munokura
This is an unofficial English translation of the plugin help,
created to support global RPG Maker users.
Feedback is welcome to improve translation quality
(see: https://github.com/munokura/triacontane-MZ-plugins ).
Original plugin by Triacontane.
Please check the latest official version at:
https://triacontane.blogspot.com
-----
This adds a screen where you can view terms that appear in the game.
Images and text descriptions explaining the terms are displayed in the window.
- How to Use
1. Register the items you want to use as terms from the database.
For detailed registration instructions， see ”Data Registration Method” below.
2. Set the ”Term Information” parameter (double-click the item).
Please note that launching the glossary from a plugin command without setting
this parameter will result in an error.
Terms can be viewed by acquiring the target item， and there is also a function
to automatically register them if the same word appears in a text display
command.
(You can also exclude specific terms from automatic registration.)
You can choose to display all terms in a single window or by category.
Select the display method from the parameters.
To display by category， specify ”<SG Category:XXX>” in the memo field.
You can assign terms to multiple categories by separating them with commas.
Example: <SG Category:XXX，YYY>
You can access the glossary screen from the menu screen or plugin command.
・Data Registration Method
1. Register new data in the item database.
Set ”Item Type” to ”Hidden Item A” or ”Hidden Item B”
2. Enter the term’s name in ”Name”
3. Enter the following information in the ”Memo” field (unnecessary fields can
be omitted):
<SG Description: Description> // Term description (※1)
<SG Common Description: Description> // Term common description (for reuse)
<SG Unobtained Description: Description> // Description of unobtained term
<SG Category: Category Name> // Name of the category to which the term belongs
<SG Manual> // Exclude the term from automatic registration
<SG Picture: File Name> // File name of the term’s picture
<SG Enemy Character: Enemy Character ID> // Display an enemy character image
instead of a picture (※2)
<SG Picture Position: Text> // Picture display position
<SG Picture X: 100> // X-coordinate offset for the term’s picture
<SG Picture Y: 100> // Y-coordinate offset for the term picture
<SG Text Position: 100> // Text display position
top: Top of window
bottom: Bottom of window
text: Bottom of text
<SG Picture Priority: top> // Picture display priority
top: Top of text
bottom: Bottom of text
<SG Picture Magnification: 0.5> // Picture magnification
<SG Picture Alignment: right> // Picture alignment
left: Left-aligned
center: Center-aligned
right: Right-aligned
<SG Exclude> // Exclude the term from collection rate calculation
<SG Text Color Change: 1，10> // Change text color to [10] when switch [1] is
ON
*1 The following special control characters can be used:
￥COMMON[1] // Replaced with <SG Common Description: aaa> for the item with ID
[1].
￥mhp[3] // Target enemy’s maximum HP (3 digits， zero-filled)
￥mmp[3] // Target enemy’s maximum MP (3 digits， zero-filled)
￥atk[3] // Target enemy’s attack power (3 digits， zero-filled)
￥def[3] // Target enemy’s defense power (3 digits， zero-filled)
￥mag[3] // Target enemy’s magic power (3 digits， zero-filled)
￥mdf[3] // Target enemy’s magic defense (3 digits， zero-filled)
￥agi[3] // Target enemy’s agility (3 digits， zero-filled)
￥luk[3] // Target enemy’s luck (3 digits， zero-filled)
￥exp[3] // Target enemy’s experience points (3 digits， zero-filled)
￥money[3] // Target enemy’s gold (3 digits， zero-filled)
￥drop[1] // Target enemy’s [1]th drop item
※2 If you omit the enemy character ID， an enemy character with the same name
as the term item will automatically be set.
￥DATA[prop] // Replaced with the ”prop” property of the target data. (See
below)
￥DATA[description] // Description of the target data
￥DATA[price] // Price of the target data
￥EFFECT_TYPE[0] // Type of effect used for the [0th]th use of the target data
￥SCRIPT{aaa} // Result of evaluating script [aaa].
// The target data can be referenced using the local variable [data].
・Usage Example 1 (Effect Amount (%) of the 0th use of the effect)
￥SCRIPT{data.effects[0].value1 * 100 + ’%’}
・Usage Example 2 (Effect Amount of the 0th use of the effect)
￥SCRIPT{data.effects[0].value2}
Furthermore， you can use multiple pages for a single term.
Use the left and right directional pad to switch between pages.
<SG Description 2: Description> // Description of the term on page 2
<SG Picture 2: Filename> // Filename of the picture for the term on page 2
<SG Picture Position 2: Text> // Display position of the picture on page 2
<SG Display Switch 2: 1> // Display pages 2 and beyond only when switch [1] is
ON. (*)
* Hiding page 2 automatically hides pages 3 and beyond.
The same applies to pages 3 and beyond， up to a maximum of 99 pages can be
specified.
When displaying multiple pages， do not specify ”1” for the first page.
NG:<SG Description 1: Description>
The following tag is required when displaying terms in different glossaries.
<SG Type: 2> // Type number to which the term belongs
To control command display in conjunction with ”YEP_MainMenuManager.js，”
leave the ”Command Name” field empty and set the ”YEP_MainMenuManager.js”
parameters as follows: Menu X Name: ’Glossary 1’
Menu X Symbol: glossary1
Menu X Main Bind: this.commandGlossary.bind(this， 1)
- Additional Feature 1
Non-hidden ”items，” ”weapons，” and ”armor” can now be displayed on the
dictionary screen. Enter the same information as the hidden item in the memo
field.
You can also create item， weapon， and armor encyclopedias.
To use this feature， enable the ”Use Acquisition History” parameter.
- Additional Feature 2
By default， the glossary is displayed in item ID order.
However， you can individually set the display order using the following tag.
If the same display order is used multiple times， the item with the lowest ID
will be displayed first.
<SG Display Order: 5> // Displayed in the same order as ID[5].
<SGOrder: 5> // Same as above.
- Additional Feature 3
Supports the creation of monster dictionaries.
1. Use the ”Auto-Register Enemy Character” parameter to retrieve terms with
the same name as the enemy character you fought.
2. Display the target enemy character’s image in the <SG Enemy Character> memo
field.
3. Display the target enemy character’s parameters using control characters
such as ￥mhp[3].
- Additional Feature 4
You can display multiple pictures for a single term.
Enter the following tag in the memo field and specify the file name， X
coordinate， and Y coordinate， separated by commas.
<SG Additional 1 Picture: aaa，1，2> // Display picture ”aaa” at X[1] Y[2].
To display additional pictures， use the following:
<SG Additional 2 Picture: bbb，2，3>
- Additional Feature 5
You can assign page numbers to the glossary. Enable this setting from the
parameter.
If you don’t want to display page numbers for individual terms， use the memo
field below.
<SG Page Number Not Required>
<SGNoPageNum>
- Additional Feature 6
You can turn on any switch when opening a term page.
<SG Glossary Viewing Switch: 1>
<SGViewingSwitch: 1>
Script Details
Returns true if the itemId is usable as a glossary item.
$gameParty.isUsableGlossaryItem(itemId);
Returns the collection rate for the specified category name and term type
name.
If the term type is omitted， [1] is set.
$gameParty.getCompleteRate(categoryName， typeName);
This plugin requires the base plugin ”PluginCommonBase.js.”
”PluginCommonBase.js” is located in the following folder under the RPG Maker
MZ installation folder:
dlc/BasicResources/plugins/official
Terms of Use:
You may modify and redistribute this plugin without permission， and there are
no restrictions on its use (commercial， 18+， etc.).
This plugin is now yours.
@param GlossaryInfo
@text Terminology information (required)
@desc Glossary information. You can add any glossary. Be sure to register at least one term.
@type struct<GlossaryData>[]
@default [”{￥”GlossaryType￥”:￥”1￥”，￥”CommandName￥”:￥”Glossary￥”，￥”UseCategory￥”:￥”false￥”，￥”CommandSwitchId￥”:￥”0￥”，￥”BackPicture￥”:￥”￥”，￥”SelectAction￥”:￥”0￥”，￥”SelectSwitchId￥”:￥”0￥”，￥”SelectVariableId￥”:￥”0￥”，￥”ConfirmMessage￥”:￥”false￥”，￥”ConfirmUse￥”:￥”use￥”，￥”ConfirmNoUse￥”:￥”no use￥”，￥”GlossaryHelp￥”:￥”Explains terms that appear in the game.￥”，￥”CategoryHelp￥”:￥”Please select a category.￥”，￥”ConfirmHelp￥”:￥”￥”，￥”UsingHelp￥”:￥”￥”，￥”CompleteView￥”:￥”false￥”，￥”CompleteMessage￥”:￥”Collection rate ￥￥￥￥c[2]%1￥￥￥￥c[0] %￥”，￥”ShowingItemNumber￥”:￥”false￥”，￥”UsableDefault￥”:￥”true￥”，￥”UseItemHistory￥”:￥”false￥”，￥”GlossaryListWidth￥”:￥”240￥”，￥”VisibleItemNotYet￥”:￥”￥”}”]
@param Layout
@desc This is a layout setting related item. Please do not enter anything here as this is a summary item.
@param FontSize
@text Font size
@desc The font size for the glossary.
@type number
@default 22
@parent Layout
@param WindowSkin
@text Window Skin
@desc The window skin for each window.
@type file
@dir img/system
@parent Layout
@param AutoResizePicture
@text Automatic image reduction
@desc When displaying a picture in a window， it will be automatically reduced to fit the picture. This is invalid if you specify a text position.
@type boolean
@default true
@parent Layout
@param PicturePosition
@text Image display position
@desc The display position of the image. (top: top of the window bottom: bottom of the window text: end of the text)
@type select
@default top
@option top
@option bottom
@option text
@parent Layout
@param TextPosition
@text Text display position
@desc The Y coordinate of the text. If 0， it will be automatically set based on the image display position.
@type number
@default 0
@param PictureAlign
@text Image Alignment
@desc Image alignment. (left: left alignment center: center alignment right: right alignment)
@type select
@default center
@option left
@option center
@option right
@parent Layout
@param PicturePriority
@text Image Priority
@desc Image display priority (top: above the text bottom: below the text)
@type select
@default top
@option top
@option bottom
@parent Layout
@param ThroughBackPicture
@text Background picture transparency
@desc Displays the normal background (map screen) behind the background picture.
@type boolean
@default false
@parent Layout
@param FramelessDesign
@text Frameless design
@desc Hides the borders and backgrounds of various windows.
@type boolean
@default false
@parent Layout
@param NewGlossaryColor
@text New term color
@desc This is the color used to indicate new terms. Please select from the system colors.
@type number
@default 2
@parent Layout
@param PageWrap
@text Page wrapping
@desc If there are multiple pages， if you have reached the last page， return to the first page.
@type boolean
@default true
@parent Layout
@param BottomHelpMode
@text Help position at bottom
@desc A help window will appear at the bottom.
@type boolean
@default true
@parent Layout
@param AutoAddition
@text Automatic Registration
@desc Automatically registers when the same word appears in a command to display a sentence. (ON/OFF)
@type boolean
@default false
@param AutoAdditionEnemy
@text Automatic enemy character registration
@desc When you defeat an enemy character， the word with the same name as the enemy character will be automatically registered. (ON/OFF)
@type boolean
@default false
@param SwitchAutoAdd
@text Auto-Register ID Switch
@desc When a term item is automatically registered， the switch with the specified number will be turned ON. Specify this if you want to send some kind of notification.
@type switch
@default 0
@parent AutoAddition
@param VariableAutoAdd
@text Auto-enrollment ID variable
@desc When a term item is automatically registered， the item ID is set to the variable with the specified number.
@type variable
@default 0
@parent AutoAddition
@param CategoryOrder
@text Category sort order
@desc If you want to change the category order， specify the category name.
@type string[]
@param CategoryUnusable
@text Prohibited Categories
@desc The categories specified here will not be usable even if ”Item Use” is enabled.
@type string[]
@param ShowPageNumber
@text Page Number Display
@desc For multi-page terms， display the page number at the bottom of the glossary.
@type boolean
@default true
@command GLOSSARY_CALL
@text Calling the glossary screen
@desc Calls up the glossary screen.
@arg type
@text type
@desc Term type. If omitted， it will automatically be set to ”1”.
@default 1
@arg category
@text category
@desc If specified， the glossary will open with the category selected.
@arg listIndex
@text List Number
@desc If specified， the glossary will open with the list number selected. If specified， it is mandatory to specify a category.
@type number
@default 0
@command GLOSSARY_GAIN_ALL
@text Get the complete glossary
@desc All terms registered in the database will be retrieved.
@command GLOSSARY_LOSE_ALL
@text Completely discarded glossary
@desc All term items registered in the database will be lost.
@command GLOSSARY_BACK
@text Return to glossary screen
@desc The glossary screen will be called with the last selected item reselected.
@command GLOSSARY_ITEM_CHANGE_CATEGORY
@text Change category of term item
@desc Changes the category of the item with the specified ID to another one. Only items can be changed. Weapons and armor cannot be changed.
@arg itemId
@text Item ID
@desc The ID of the item whose category you want to change.
@type item
@default 1
@arg category
@text category
@desc The name of the new category.
@command GLOSSARY_ITEM_CHANGE_USABLE
@text Prohibition of use of term items
@desc Changes the prohibition on the item with the specified ID.
@arg itemId
@text Item ID
@desc The item ID to be disabled.
@type item
@default 1
@arg enable
@text Availability
@desc Set whether the item can be used.
@type boolean
@default true