Documentation
Quick InfoVersion: Alpha R5
Made for RPG Maker MZ 1.9.0
Main FeaturesRECRUIT SCENE
Open a scene with actors that can be recruited to the party. See basic info in shop-like selectable window for each actor.
ACTOR SCENE
A separate part of the recruitment process, which asks the player to confirm they want to recruit a single actor. You can call this separately from the recruit scene in case you want a fancy way to accept/decline a party member who wants to join, outside of the recruitment process.
Plugin CommandsThis plugin supports the following plugin commands:
Call Scene - Opens the recruitment scene
Call Actor Scene - Opens the actor scene for a single actor's confirm/deny into the party.
Change Discover - Change an actor's discovered status for the scene. This will cause New! marker text to appear for the actor.
Change Availability - Change an actor's availability status for the scene. This does not cause New! marker text to appear for the actor.
IntegrationsThis plugin has special functionality when used with the following [CGMZ] plugins:
[CGMZ] Toast Manager
Show a brief toast window when an actor gets marked as discovered, available, or when they are recruited. In all of these toasts, you can use the text code %name to show the actor's name.
[CGMZ] Window Settings
Gives you full control over all of this plugin's windows properties, including being able to set windowskin, tone, opacity, style, and more.
[CGMZ] Window Backgrounds
Allows you to add an image as any window's background, including animated scrolling parallax images. This integration makes the above no-code via the preset id system.
[CGMZ] Controls Window
Show the player the keyboard or gamepad controls of the recruitment scenes, which will automatically switch based on the player's last input.
[CGMZ] Scene Backgrounds
Show a custom background image in any scene, including an animated scrolling parallax background and also including weather. This integration makes the above no-code via the preset id system.
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_RecruitmentBoard.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 AlphaR2
- Added more control over which actors appear in recruit select scene
- Added text control in select window
- Added text parameters for availability display
- Added integration with [CGMZ] Scene Backgrounds
- Added max party size to prevent recruiting too many actors
- Added integration with [CGMZ] Window Backgrounds
- Added integration with [CGMZ] Window Settings
- Added integration with [CGMZ] Controls Window
- Added variable actor option to plugin command
- Added custom space option for select and display windows
- Fix Bug when set to not show previously recruited actors
- Added option to bypass cost during single actor recruit scene
- Added [CGMZ] Toast Manager integration