Recruiting Board VisuStella MZ

Welcome to the wiki! This is where you can find resources from Yanfly.moe, Ækashics.moe,
VisuStella, Caz Wolf, Fallen Angel Olivia, Atelier Irina, and other affiliated content creators.

Download
System This is a plugin created for RPG Maker MZ.
Click here for help on how to install plugins and an explanation on the Tier Hierarchy System.	Click here to learn how to update plugins.	Click here for how to troubleshoot plugins if you get an error.

VisuStella MZ This plugin is a part of the VisuStella MZ Plugin Library. Click here if you want to help support VisuStella on Patreon. Introduction This plugin allows you to create a recruiting board for actors that the player can add into their party for a sum of gold. Each recruiting board can have a different list of actors and even discount rates to go with it. Features include all (but not limited to) the following: Opens a new shop-like scene for the player to browse through and select actors to recruit into the party for a sum of gold. Display the basic information needed for each actor akin to how the main menu is displayed. When used with the VisuStella MZ Core Engine, each recruitable character's base parameters are also displayed. When used with the VisuStella MZ Main Menu Core, the face graphic will match the setting used to display the map sprite or sideview battler if needed. A small window displays the list of skills the actor has learned, too. Notetags allow you to apply different cost rates per level. Discount rates can be adjusted via the Plugin Command. Requirements This plugin is made for RPG Maker MZ. This will not work in other iterations of RPG Maker. Tier 4 This plugin is a Tier 4 plugin. Place it under other plugins of lower tier value on your Plugin Manager list (ie: 0, 1, 2, 3, 4, 5). This is to ensure that your plugins will have the best compatibility with the rest of the VisuStella MZ Plugin library. VisuStella MZ Compatibility While this plugin is compatible with the majority of the VisuStella MZ plugin library, it is not compatible with specific plugins or specific features. This section will highlight the main plugins/features that will not be compatible with this plugin or put focus on how the make certain features compatible. --- Core Engine VisuStella MZ When used in the same project with the Core Engine, the default Plugin Parameter "JS: Draw Actor Data" will include extra data showing off the player's base parameters. --- Main Menu Core VisuStella MZ When used in the same project with the Main Menu Core, the Recruiting Board scene will match the main menu graphic type to show faces, map sprites, or sideview battlers. --- Visual Gold Display VisuStella MZ The cost of skills will be shown in Visual Gold Display format. --- Notetags RPG Maker MZ's editor is unable to allow for custom traits/properties that a game dev may wish to associate with a database object, event, map, etc. Notetags are used to work around such limitations by allowing the game dev to tag certain traits/properties using specific Notetags declared by the related plugin. Here is a list of Notetag(s) that you may use. The following are notetags that have been added through this plugin. These notetags will not work with your game if this plugin is OFF or not present. --- Recruit-Related Notetags --- <Recruit Cost Per Level: x> - Used for: Actor Notetags - Adjusts how much this actor will cost to recruit by 'x' gold per level. - Replace 'x' with a number representing how much gold is needed per level in order for the player to recruit this actor. - If this notetag is not used, use the default setting found in the Plugin Parameters. --- <Fixed Recruit Cost: x> - Used for: Actor Notetags - Regardless of level, this actor can be recruited for 'x' gold. - Replace 'x' with a number representing the fixed gold cost needed for the player to recruit this actor. - This will take priority over <Recruit Cost Per Level: x>. --- Plugin Commands Plugin Commands are event commands that are used to call upon functions added by a plugin that aren't inherently a part of RPG Maker MZ. Here is a list of Plugin Command(s) that you may use: --- The following are Plugin Commands that come with this plugin. They can be accessed through the Plugin Command event command. --- Scene Plugin Commands --- Scene: Open Recruiting Boarding - Opens the recruiting board to hire new actors. - Cannot be used in battle. Actor ID(s): - Select which Actor ID(s) to be able to recruit. Discount Rate: - Determine the discount rate used for this shop. - You may use JavaScript code. --- Plugin Parameters General Settings General settings for this plugin. --- General Default Cost Per Level: - What is the default cost per level for actors that lack the <Recruit Cost Per Level: x> notetag? --- Background Settings Background settings for Scene_RecruitingBoard. --- Background Settings Snapshop Opacity: - Snapshot opacity for the scene. Background 1: - Filename used for the bottom background image. - Leave empty if you don't wish to use one. Background 2: - Filename used for the upper background image. - Leave empty if you don't wish to use one. --- Vocabulary Settings These settings let you adjust the text displayed for this plugin. --- Command Window Recruit Text: - Text used for this command. Icon: - Icon used for this command. Help Description: - Help window description used for this command. - Text codes allowed. Cancel Text: - Text used for this command. Icon: - Icon used for this command. Help Description: - Help window description used for this command. - Text codes allowed. --- List Window No Actors Available: - Text displayed when no actors are available to recruit. - Text codes allowed. Help Description: - Help window description used for no recruitables. - Text codes allowed. --- Skills Window Title Text: - Text used for the skills window title. And More Text: - Text used for the skills window subtitle. --- Window Settings These settings let you adjust the windows displayed for this plugin. --- Help Window Background Type: - Select background type for this window. --- Gold Window Background Type: - Select background type for this window. JS: X, Y, W, H: - Code used to determine the dimensions for this window. --- Command Window Background Type: - Select background type for this window. Style: - How do you wish to draw commands for this window? JS: X, Y, W, H: - Code used to determine the dimensions for this window. --- List Window Background Type: - Select background type for this window. JS: Draw Actor Data: - Code used to draw the data for each actor. JS: X, Y, W, H: - Code used to determine the dimensions for this window. --- Skills Window Background Type: - Select background type for this window. JS: X, Y, W, H: - Code used to determine the dimensions for this window. --- Terms of Use 1. These plugins may be used in free or commercial games provided that they have been acquired through legitimate means at VisuStella.com and/or any other official approved VisuStella sources. Exceptions and special circumstances that may prohibit usage will be listed on VisuStella.com. 2. All of the listed coders found in the Credits section of this plugin must be given credit in your games or credited as a collective under the name: "VisuStella". 3. You may edit the source code to suit your needs, so long as you do not claim the source code belongs to you. VisuStella also does not take responsibility for the plugin if any changes have been made to the plugin's code, nor does VisuStella take responsibility for user-provided custom code used for custom control effects including advanced JavaScript notetags and/or plugin parameters that allow custom JavaScript code. 4. You may NOT redistribute these plugins nor take code from this plugin to use as your own. These plugins and their code are only to be downloaded from VisuStella.com and other official/approved VisuStella sources. A list of official/approved sources can also be found on VisuStella.com. 5. VisuStella is not responsible for problems found in your game due to unintended usage, incompatibility problems with plugins outside of the VisuStella MZ library, plugin versions that aren't up to date, nor responsible for the proper working of compatibility patches made by any third parties. VisuStella is not responsible for errors caused by any user-provided custom code used for custom control effects including advanced JavaScript notetags and/or plugin parameters that allow JavaScript code. 6. If a compatibility patch needs to be made through a third party that is unaffiliated with VisuStella that involves using code from the VisuStella MZ library, contact must be made with a member from VisuStella and have it approved. The patch would be placed on VisuStella.com as a free download to the public. Such patches cannot be sold for monetary gain, including commissions, crowdfunding, and/or donations. 7. If this VisuStella MZ plugin is a paid product, all project team members must purchase their own individual copies of the paid product if they are to use it. Usage includes working on related game mechanics, managing related code, and/or using related Plugin Commands and features. Redistribution of the plugin and/or its code to other members of the team is NOT allowed unless they own the plugin itself as that conflicts with Article 4. 8. Any extensions and/or addendums made to this plugin's Terms of Use can be found on VisuStella.com and must be followed. Terms of Use: Japanese 『VisuStella MZ』利用規約 1. これらのプラグインは、VisuStella.comおよび/または公式に承認されたVisuStellaのソースから合法的な手段で入手したものである限り、フリーゲームや商用ゲームに使用することができます。例外的に使用が禁止される場合については、VisuStella.comの記載をご確認ください。 2. 本プラグインの「クレジット」部分に記載されているすべてのコーダーの名前は、ゲーム内にクレジット表記を行うか、もしくは「VisuStella」という名前の下にまとめて表記する必要があります。 3. ソースコードを自分のものだと主張しない限りは、必要に応じて編集することが可能です。ただしプラグインのコードに変更が加えられた場合、VisuStellaはそのプラグインに対して一切の責任を負いません。高度なJavaScriptのノートタグやJavaScriptコードを許可するプラグインのパラメータを含む、カスタムコントロールエフェクトに使用される、ユーザー提供のカスタムコードについても、VisuStellaは一切の責任を負いません。 4. これらのプラグインやプラグイン内のコードを、「自分のもの」として再配布したり使用したりすることはできません。これらのプラグインとそのコードは、VisuStella.comおよび、その他の公式/承認済みVisuStellaソースからのみダウンロードすることができます。公式/承認済みのソースのリストは、VisuStella.comでご確認いただけます。 5. VisuStellaは、意図しない使用方法による問題、VisuStella MZライブラリ以外のプラグインとの非互換性の問題、プラグインのバージョンが最新でないことによる問題、第三者による互換性パッチが適切に動作していないことなどが原因でゲーム内で発生した問題については、一切の責任を負いません。VisuStellaは、高度なJavaScriptのノートタグやJavaScriptコードを許可するプラグインのパラメータを含む、カスタムコントロールエフェクトに使用される、ユーザー提供のカスタムコードに起因するエラーについても、一切の責任を負いません。 6. VisuStella MZライブラリのコードを使用した互換性パッチをVisuStellaとは関係のない第三者を通じて作成する必要がある場合は、まずVisuStellaのメンバーと連絡を取り、承認を得る必要があります。パッチはVisuStella.comに公開され、誰でも無料でダウンロードすることができるようになります。このようなパッチを、制作発注やクラウドファンディングの対象にしたり、寄付などの金銭的な利益を得るために販売することはできません。 7. このVisuStella MZプラグインが商用製品である場合、プロジェクトチームのすべてのメンバーは、それを使用するため、それぞれ製品を購入しなければなりません。使用方法には、関連するゲームメカニクスの作業、関連するコードの管理、および/または関連するプラグインコマンドや機能の使用、が含まれます。プラグインそのものやそのコードをチームの他のメンバーに再配布することは第4項に抵触するため、そのメンバーがプラグインそのものを所有していない限りは許可されません。 8. このプラグインの利用規約の追加項目や補足については、VisuStella.comに掲載されていますので、それを参照し従ってください。 Credits If you are using this plugin, credit the following people in your game: Team VisuStella Irina Arisu Olivia Yanfly Changelog Version 1.02: August 17, 2023 Compatibility Update! Added compatibility functionality for future plugins. Version 1.01: May 18, 2023 Bug Fixes! Gold window did not update on recruitment. Should work properly now. Fix made by Arisu. Feature Update! If your screen resolution UI is too small, the class name and gauges will not be drawn. Update made by Arisu. Version 1.00 Official Release Date: May 24, 2023 Finished Plugin! See Also Inspiration Behind Merchant Manager Volume 3 Recruiting Board (Irina) End of Helpfile