Documentation
Quick InfoVersion: 1.7.0
Made for RPG Maker MZ 1.9.0
The BasicsColors support either hex format (ex. #ffffff) or rgb format (ex. rgb(255, 255, 255))
NotetagsTemporary Buff Note Tag (Items):
<cgmzprofbuff:profName,buffAmount,frameCount,stackable>
- profName should be the profession's name (case sensitive)
- buffAmount should be a number that will be added to the profession's level
- frameCount should be a number which is how many frames the buff will last (60f = 1 sec)
- stackable should be either "true" or "false" and determines if the buff will stack with other buffs or not
You can also combine multiple buffs using the & character.
Permanent buff (while equipped) note tag (Weapon, Armor):
<cgmzprofbuff:profName,buffAmount>
- profName should be the profession's name (case sensitive)
- buffAmount should be a number that will be added to the profession's level
You can also combine multiple buffs using the & character.
These buffs on Weapon & Armor are permanent while equipped, and stack.
Note for actor-specific professions: add -actorId onto the profession name. For example, if your profession has name Mining and is for Actor ID 2, you would put Mining-2 as the profession name.
IntegrationsYou can easily add the Profession scene to the main menu using [CGMZ] Menu Command Window and the JavaScript code:
SceneManager.push(CGMZ_Scene_Professions);
This plugin also has special functionality when used with certain other CGMZ plugins:[CGMZ] Crafting
CGMZ Professions comes with the option to display known recipes from CGMZ Crafting in the Profession Display window.
[CGMZ] Toast Manager
CGMZ Professions has the option to display toasts via CGMZ Toast Manager when certain actions occur. These actions are when leveling up, and when discovering a profession. In the toast preset, you can use the following text codes:
%name - Will be replaced with the profession name
%color - Will be replaced with the profession color index
%actor - Will be replaced with the profession actor name (if any)
%level - Will be replaced with the profession level (level up toast only)
[CGMZ] Screenshots
CGMZ Professions comes with the option to take a screenshot of the game screen upon level up. You can also set the filename of the screenshot. When changing the filename, please do not use any spaces in the filename.
[CGMZ] Infinite Colors
If you would like to use custom colors not present on the windowskin for your professions, you can set the custom color up via [CGMZ] Infinite Colors and then input the color id into the profession color tab. To do so, click the text tab to turn the color parameter into a text field instead of the built-in color select ui which is limited to windowskin colors.
[CGMZ] Scene Backgrounds
Set up a scene background preset and then enter the preset id into the background image parameter here. This allows you to have a lot more options when setting up your background image, including scrolling backgrounds.
[CGMZ] Controls Window
Set up a controls window preset and then enter the preset id into the controls window parameter here. This allows you to easily show keyboard or gamepad controls for the Profession scene, depending on player's last input type.
Plugin CommandsThis plugin supports the following plugin commands:
Call Scene - Calls the profession scene
Discover Profession - This will discover (or undiscover) a given profession
Change Description - Allows you to set a profession's description
Change Exp - Allows you to set, add, or subtract experience from the provided profession
Change Level - Allows you to set, add, or subtract levels from the provided profession
Get Profession Level - Allows you to store the profession's level in a variable
Get Buffed Level - Allows you to store the profession's level + any buffs in a variable
Add Buff - Use this to add a temporary buff to a profession's level
Remove Buff - Usually buffs expire automatically, but if you need to manually remove one you can use this plugin command
Reinitialize - This will reinitialize all profession data as if you had started a new game. Use for saved game testing.
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 professions will not work in saved games. The saved game will act as if the profession had not been modified or deleted.
✓ Remove the plugin with no issue to save data.
Filename
The filename for this plugin MUST remain CGMZ_Professions.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.0.1
- Added a plugin command to get the profession level
- Added option to display a toast window on discovery of profession
- Added temporary buffs (or debuffs) when using items or plugin command
- Added ability to use text codes in profession descriptions
- Added ability to use custom icon image in place of big icon in display window
- Added option to change label text color
- Added option to use transparent windows
- Added option to use a custom scene background image
- Added plugin command to change description
- New professions are now loaded automatically in saved games without needing to use reinitialize plugin command
- Change to profession buffs to make them more efficient for other plugins
- Fix bug with level up toast having an extra ":" in the string
- Added customization option for display window, now you can drag + drop a parameter to determine what displays and what order it displays in
- Added ability for worn equipment to provide a buff to profession levels
- Documentation update
- Added option to display known recipes from CGMZ Crafting
- Added option to take a screenshot on level up if using CGMZ Screenshots
- Added option to fill space where touch UI buttons would be
- Added option to use different windowskin for each profession window
- Added option to set the list window width
- Added option to display the list window on the right
- Added Spanish Language support
- Professions can now be actor-specific
- Added more control over profession toast sound effects
- Added option to change the alignment of text in the total window
- Toast sound effect data is no longer part of save data
- This plugin no longer crashes when parsing invalid JSON. Instead, it warns you in the dev tool console if it encounters invalid JSON
- Bug fix for actor-specific profession plugin command crash
- Added parameters to change the line gradient color in headers
- Bug fix for discover profession plugin command when actor set to 0
- Icon parameters now use plugin manager icon select ui
- Color parameters now use plugin manager color select ui where possible
- Added option to display custom lines of info and custom headers
- Added option to display undiscovered recipes from [CGMZ] Crafting
- Fix bug with profession image remaining after cancel to category window
- Fix bug with Level Up toast first line not being centered
- Fix bug with invalid JSON in Call Scene default parameters
- Moved some previously saved data out of save data (such as prof icon)
- Added option for floating text on map when receiving exp
- Added balloon icon on level up (map scene only)
- Added animation on level up (map scene only)
- Added window tone, padding, back opacity options for each window
- Added header divider options
- Added [CGMZ] Controls Window integration
- Background image parameter now uses [CGMZ] Scene Backgrounds
- Color converted to text code parameter
- Order with [CGMZ] Toast Manager no longer important
- All text should now support text codes
- Added custom space option for display window
- Added category column parameter
- Display window should now respond to font size changes
- Fix bug with extra quotation mark in total string
- Fix bug with scroll being slightly off with custom padding
- Added [CGMZ] Window Backgrounds integration
- Added [CGMZ] Window Settings integration
- Fix bug with calling profession scene with only 1 actor visible
- Custom picture now supports any image folder
- Toast Manager integration now uses preset system
- Description parameter changed to multiline_string type