Challenge System 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.

Masterarbeit Writer

Required Plugins The following plugins are required in order to use this plugin. Place the following plugins above this plugin located in the Plugin Manager. Core Engine VisuStella MZ Battle Core VisuStella MZ Skills and States Core VisuStella MZ 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 The Challenge System allows the player to select their own challenges. These challenges can range from things like decreasing the party's MaxHP or raising the enemies' ATK power. These challenges can affect the whole game on a global scale or locally through specific maps. With the challenge system, subsequent playthroughs of specific dungeons can feel a whole lot less boring and more interesting with the challenges in play. The more challenges enabled, the more the player is rewarded, too. Features include all (but not limited to) the following: Challenge Sets can house a multitude of Challenge Entries that the player can select and turn on at their own choice. Design your own Challenge Entries. Such design choices include the ability to adjust the stats of allies and/or enemies in positive or negative ways. Challenge Entries can also affect units with passive states while enabled or temporarily by afflicting them with states at the start of battle. Challenge Entries can also turn ON certain switches while enabled (and OFF when they're disabled). This allows you, the game dev, to create custom challenge effects if desired. Some Challenge Entries can require Switches to be turned ON before they can be seen or enabled. This means Challenge Sets can grow over time as the player unlocks more Challenge Entries. Different Challenge Entries can have a different Challenge Level applied to them to indicate their difficulty. The higher the total Challenge Level, the more the player is rewarded with EXP multipliers, Gold multipliers, Drop Rate multipliers, and more. Assign the total Challenge Level to Variables to keep track of in case you want to do something custom with it as the game dev. Requirements This plugin is made for RPG Maker MZ. This will not work in other iterations of RPG Maker. Required Plugin List Core Engine VisuStella MZ Battle Core VisuStella MZ Skills and States Core VisuStella MZ This plugin requires the above listed plugins to be installed inside your game's Plugin Manager list in order to work. You cannot start your game with this plugin enabled without the listed plugins. Tier 2 This plugin is a Tier 2 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. Major Changes This plugin adds some new hard-coded features to RPG Maker MZ's functions. The following is a list of them. --- Switches Some challenge entries will require switches to be accessible. This will require them to be in the ON state. If the game dev has set the switch ON, and then the player has enabled that challenge entry, the game dev can no longer set the switch to OFF until the player has set the entry to off. This is to prevent the player from getting confused as to why the challenge entry is suddenly disabled without their knowledge. If the player sets the switch to OFF and then the game dev sets the required switch to OFF, then the effect can be turned off properly in the Challenge System menu and hidden from accessibility. --- 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. --- Class Change System VisuStella MZ Skill Learn System VisuStella MZ If you are using the VisuStella MZ Class Change System and/or Skill Learn System, then there will be some features that will be made available. The Challenge System plugin will allow the CP and JP gains for the Class Change System and the AP and SP gains for the Skill Learn System to be amplified through the reward multipliers. --- 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. --- Map-Related Notetags --- <Challenge Set: name> <Challenge Sets: name, name, name> - Used for: Map Notetags - Use this to define which local Challenge Sets will affect this map. - Replace 'name' with the named 'Challenge Set ID' found in the Challenge Set groups in the Plugin Parameters. - Insert multiple 'name' entries to allow more than one Challenge Set to affect this map. - The Global Challenge Set affects all maps except those marked with the <No Global Challenges> notetag. --- <No Global Challenges> - Used for: Map Notetags - Prevents this map from being affected by the Global Challenge Set found in the Plugin Parameters. - This map can still be affected by local Challenge Sets marked through the <Challenge Set: name> notetag. --- 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. --- Reset Plugin Commands --- Reset: Global Challenge Entries - Resets all global challenges and turns off all entries. --- Reset: Local Challenge Entries - Resets target local challenge set and turns off all enetries. Challenge Set Name: - What is the name of the Challenge Set that you want to reset? --- Scene Plugin Commands --- Scene: Open Challenge Menu - Global - Opens Challenge Menu settings for Global Challenge Set. - CANNOT be used inside of battle. --- Scene: Open Challenge Menu - Local Set - Opens Challenge Menu settings for a local Challenge Set. - CANNOT be used inside of battle. Challenge Set Name: - What is the name of the Challenge Set that you want the player to be able to modify challenges for? - This is the 'Challenge Set ID' found in the Challenge Set groups in the Plugin Parameters. --- Plugin Parameters Challenge Set Settings These Plugin Parameters are used for both the Global and Local Challenge Sets. There are no differences between them other than the Global Challenge Set is always active except for maps with the <No Global Challenges> notetag and the Local Challenge Sets are only active in maps with the notetag: <Challenge Set: name>. --- General Challenge Set ID: - What is the name ID of this Challenge Set? - This is used for <Challenge: name> notetag. - Ignore this for the Global Challenge Set as it will always be "Global". Display Title: - How does the Challenge Set title appear visually? - Text codes allowed. Title Background: - Filename of the background image displayed. - Image found in the game project's img/titles1/ folder. --- Challenges Challenge List: - A list of challenges that can be selected for this challenge set. - Look in the "Challenge Entry Settings" section for more details. Total Level Variable: - What variable is used to record the total challenge level? - Insert 0 to not use this feature. --- Rewards Per Level EXP% Per Level: Gold% Per Level: Drop% Per Level: AP% Per Level: CP% Per Level: JP% Per Level: SP% Per Level: - Reward multiplier given per challenge level? - AP and SP require VisuMZ_2_SkillLearnSystem! - CP and JP require VisuMZ_2_ClassChangeSystem! --- Challenge Entry Settings These Plugin Parameters are used Challenge Entries. Challenge Entries are the various challenges that players can pick from within each Challenge Set. They can be turned on or off at the player's decision. --- General Challenge Entry ID: - What is the name ID of this Challenge Entry? - This is used for "Not Used With" setting. Display Name: - How does the Challenge Entry title appear visually? - Text codes allowed. Display Icon: - What icon should this Challenge Entry use? Display Description: - A description of this Challenge Entry. - Appears under the Display Name. - Text codes allowed. Level Modifier: - How does this affect the total Challenge Level? - Positive: Danger. Negative: Safety. Not Used With: - A list of Challenge Entries found in the same set that cannot be used together with this Entry. Required Switch: - If a Switch ID is used, this Challenge Entry only appears if this Switch ID is ON. --- Effects Basic Parameters: - The basic parameter rates altered by this Entry. - The modifiers are multiplicative. - MaxHP Rate - MaxMP Rate - ATK Rate - DEF Rate - MAT Rate - MDF Rate - AGI Rate - LUK Rate X Parameters: - The X parameter rates altered by this Entry. - The modifiers are additive. - HIT Rate - EVA Rate - CRI Rate - CEV Rate - MEV Rate - MRF Rate - CNT Rate - HRG Rate - MRG Rate - TRG Rate S Parameters: - The S parameter rates altered by this Entry. - The modifiers are multiplicative. - TGR Rate - GRD Rate - REC Rate - PHA Rate - MCR Rate - TCR Rate - PDR Rate - MDR Rate - FDR Rate - EXR Rate Battle Start States: - A list of states that will be added onto the targets at the start of battle if this is used. - This does NOT bypass State Restrictions. Passive States: - A list of states that will be used as passives if this Challenge Entry is used. - As these are passives, they will behave as passives, too, which means no stacking unless specified otherwise (see VisuMZ_1_SkillsStatesCore help file). Effect Switch: - If Challenge Entry is enabled, turn ON this switch. - Otherwise, turn OFF this switch. --- Affected Targets All Actors?: - Affect all actors with this Challenge Entry? Specific Actors: - A list of actors that this Challenge Entry specifically affects. Specific Classes: - A list of classes that this Challenge Entry specifically affects. All Enemies?: - Affect all enemies with this Challenge Entry? Specific Enemies: - A list of enemies that this Challenge Entry specifically affects. --- Mechanics Settings These settings let you adjust the mechanics used for this plugin. --- Settings Adjust HP/MP: - Adjust HP/MP differences for changing Challenge Sets with MaxHP/MaxMP values. Allow Safety Level: - Allow levels to go into the negatives for Safety Levels? Negative Rewards Rate: - Reduce penalty changes to battle rewards for Safety Level by this multiplicative rate modifier. Lowest Reward Cap: - Absolute lowest reward cap that can be given out. --- Background Settings Background settings for Scene_Challenge. --- 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. --- Sound Settings These settings let you adjust the sound effects used for this plugin. --- Danger Sound Filename: - Filename of the sound effect played. Volume: - Volume of the sound effect played. Pitch: - Pitch of the sound effect played. Pan: - Pan of the sound effect played. --- Safety Sound Filename: - Filename of the sound effect played. Volume: - Volume of the sound effect played. Pitch: - Pitch of the sound effect played. Pan: - Pan of the sound effect played. --- Vocabulary Settings These settings let you adjust the text displayed for this plugin. --- Level Display Window Danger Level: - Text used for a positive level. Safety Level: - Text used for a negative level. --- Rewards Display Window Display Title: - Text used for this window's title. Drop Rate: - Text used to designate drop rate. --- List Entry Window Danger Level Change: - Indicate how much level change there is. - %1 - Level Safety Level Change: - Indicate how much level change there is. - %1 - Level --- Button Assist Window Reset: - Text used for a full Challenge Set reset. --- Window Settings These settings let you adjust the windows displayed for this plugin. --- Title Display Window Background Type: - Select background type for this window. Padding: - How much padding is used for this window? JS: X, Y, W, H: - Code used to determine the dimensions for this window. --- Level Display Window Background Type: - Select background type for this window. Level Number Settings: Base Font Size: - What is the base font size for the level number? New Size Per Level?: - Increase the size of the font per level? Level Modifier: - How much should font size increase per level? Max Font Size: - What is the maximum font size that can be reached? Use Numbers Font?: - Use the damage numbers font for the number display? Level Text Colors: Danger Color: Neutral Color: Safety Color: - Use #rrggbb for custom colors or regular numbers for text colors from the Window Skin. Update Frequency: - How often should this window update in frames? JS: X, Y, W, H: - Code used to determine the dimensions for this window. --- Rewards Display Window Background Type: - Select background type for this window. Rewards Order: - What order do you want the rewards to appear in? Reward EXP Icon: Reward Gold Icon: Reward Drops Icon: - Icon used for this reward. JS: X, Y, W, H: - Code used to determine the dimensions for this window. --- List Entry Window Background Type: - Select background type for this window. Icon Smoothing?: - Use a smooth icon for an extended icon size? Thickness: - How many lines thick is each Challenge Entry? Level Text Colors: Danger Color: Safety Color: - Use #rrggbb for custom colors or regular numbers for text colors from the Window Skin. List Name Color: Normal Entry: Excluded Entry: On Danger Entry: Safety Entry: - Use text colors from the Window Skin only. - This does NOT use #rrggbb format. 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 Arisu Irina Olivia Yanfly Changelog Version 1.01: September 14, 2023 Bug Fixes! Fixed a bug where a crash would occur upon trying to set the challenge level to a variable. Fix made by Irina. Documentation Update! Help file updated for new features. Added section: Major Changes > Switches: Some challenge entries will require switches to be accessible. This will require them to be in the ON state. If the game dev has set the switch ON, and then the player has enabled that challenge entry, the game dev can no longer set the switch to OFF until the player has set the entry to off. This is to prevent the player from getting confused as to why the challenge entry is suddenly disabled without their knowledge. If the player sets the switch to OFF and then the game dev sets the required switch to OFF, then the effect can be turned off properly in the Challenge System menu and hidden from accessibility. Feature Update! Changing Required Switch states to OFF will be locked out if a challenge entry is using it in order to prevent confusion. Update by Irina. New Features! New Plugin Commands added: Reset: Global Challenge Entries Reset: Local Challenge Entries Resets all global challenges/local challenge and turns off all related entries to that challenge set. Version 1.00 Official Release Date: September 27, 2023 Finished Plugin! See Also Inspiration Behind Dungeon Divers Volume 2 End of Helpfile