Debugger VisuStella MZ

From Yanfly.moe Wiki
Revision as of 18:26, 7 October 2020 by Yanfly (talk | contribs)
Jump to navigation Jump to search

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.


UpdatePlugins.png

Click here to learn how to update plugins.


Troubleshooting.jpg

Click here for how to troubleshoot plugins if you get an error.



DebuggerMain.png DebuggerTeleporter.png
DebuggerItem.png DebuggerQuick.png


VisuStella MZ

This plugin is a part of the VisuStella MZ Plugin Library.


Support VisuStella

Click here if you want to help support VisuStella on Patreon.


Introduction

The RPG Maker MZ default debug menu (accessible through the F9 key during a play test session) only has switch and variable manipulation options, which might not be enough for some game developers. This plugin adds in a new debug menu with access to launching Common Events on the go, teleporting to any desired map, quick options, initiating battles, modifying quantities for items, weapons, armors, altering self switches, and applying buffs, debuffs, and states. Furthermore, this plugin also makes the debug menu accessible from anywhere.

Features include all (but not limited to) the following:

  • Access the Debug Menu (F9 key) from anywhere instead of just from the map scene.
  • Switches and Variables are color-coded to make it easier to spot which ones are on, off, unnamed, and on while unnamed.
  • Debug Menu's Common Event option allows you to launch any desired Common Event while on the map or in battle.
  • The "Teleport" option lets you traverse through the game's various maps with ease.
  • The "Quick" command lets you access a variety of options that may come in handy during play testing.
  • "Battle" option allows you to initiate a battle with preemptive modifiers, surprise attack, or neither.
  • The item, weapon, and armor menus allow you to adjust their quantities held by the party easily.
  • Adjust Self Switches A, B, C, D through the "Map Events" command.
  • "Buffs & States" command allows you to apply or remove buffs, debuffs, and states while also altering their turns, stacks, and more.

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.


Major Changes

This plugin adds some new hard-coded features to RPG Maker MZ's functions. The following is a list of them.

---

F9 Button

DebuggerMain.png

The F9 button will now call the new debug menu. It's now accessible from any scene. The old debug menu still exists but is now unaccessible normally through the F9 button as it's been reassigned.

---

Debugger Menu

Switches

DebuggerSwitches.png

This is the standard Switch adjustment menu you're used to in default RPG Maker MZ. Use this menu to turn specific switches ON or OFF mid-game.

  • The main differences here are that the menu is color-coded to show [ON] and [OFF] states better.
  • Unnamed switches that are turned [ON] will have their names displayed as "! ATTENTION !" to draw attention. This is in case you may have been using a specific switch that you've forgotten to name, and you wouldn't want to override its properties in a future event.

Variables

DebuggerVariables.png

This is the standard Variables adjustment menu you're used to in default RPG Maker MZ. Use this menu to change the value stored inside variables.

  • Unlike the default RPG Maker MZ Debug Menu's variable controller, here you can alter the variable values in larger increments than 1 or 10.
  • You can even select the variable and type in the number you want it to be to allow for quicker adjustments.
  • Unnamed variables that have non-0 values will have their names displayed as "! ATTENTION !" to draw attention. This is in case you may have been using a specific variable that you've forgotten to name, and you wouldn't want to override its properties in a future event.

Common Events

DebuggerCommonEvents.png

This is a new menu added by this plugin that was not originally available in the default RPG Maker MZ Debug Menu.

  • This option accessible from the map scene only.
  • This menu allows you to launch specific common events.
  • TIP: You can use this to create your own debug commands that involve eventing.

Teleport

DebuggerTeleporter.png

DebuggerTeleporter2.png

This is a new menu added by this plugin that was not originally available in the default RPG Maker MZ Debug Menu.

  • This option accessible from the map scene only.
  • Select a map to teleport to, then select the place to put down the player character on that map.
  • The left column lists the maps in the order shown in the MZ editor.
  • The right column lists the maps in numeric order by Map ID.

Quick

DebuggerQuick.png

This is a new menu added by this plugin that was not originally available in the default RPG Maker MZ Debug Menu.

  • Options found in this menu will vary depending on which scene you're currently located in.
  • Select from a variety of JavaScript coded commands that enable faster testing for your game.
  • Commands can be added/removed/altered from the Plugin Parameters.

Battle

DebuggerBattle.png

This is a new menu added by this plugin that was not originally available in the default RPG Maker MZ Debug Menu.

  • This option accessible from the map scene only.
  • Enter a battle with the selected Troop.
  • You can choose to start the battle with a Preemptive bonus, a Surprise Attack penalty, or neither.

Items, Weapons, Armors

DebuggerItem.png

DebuggerWeapon.png

DebuggerArmor.png

These new menus added by this plugin that were not originally available in the default RPG Maker MZ Debug Menu.

  • Adjust the quantity of items, weapons, and/or armors found in the game project.
  • Unnamed items and items with ----- in their names are automatically filtered from the list to reduce bloat.
  • You can alter the amount of gold the party is holding, too.
  • When hovering over the central gold, item, weapon, or armor option, you can type in the exact number of that object you wish.
  • For weapons and armors, the numbers available represent the amount of the object currently being carried by the party. Any equipped weapons or armors do not count towards the quantity.

Map Events

DebuggerMapEvents.png

This is a new menu added by this plugin that was not originally available in the default RPG Maker MZ Debug Menu.

  • This option accessible from the map scene only.
  • This menu allows you to adjust the A, B, C, D Self Switches an event has.
  • You can also erase events from this menu.
  • This does not give you control over the Self Switches and Self Variables added through other plugins due to how limitless they are.

Buffs & States

DebuggerBuffsStates.png

This is a new menu added by this plugin that was not originally available in the default RPG Maker MZ Debug Menu.

  • Lets you select a specific party member (or enemy if in battle) to alter their current buffs, debuffs, and/or states.
  • For buffs, debuffs, and states, you can alter how many turns are remaining if the battler is currently affected by it.
  • You can change the amount of buff or debuff stacks a battler has.
  • If using the VisuStella MZ Skills & States Core, you can alter the custom value assigned to the state if it's a numeric value.

Plugin Parameters: Quick Commands

DebuggerParams1.png

A list of commands and their JS code to add to the debug menu's Quick option. You can add in any command you need here.

---

DebuggerParams2.png

Quick Command

 Name:
 - Command name for the Quick command.
 Icon:
 - Icon index used for the Quick command.
 Help:
 - Help description displayed for this Quick command.
 Close Debugger on Select:
 - Close the debugger upon running the action?
 JS: Visibility:
 - JavaScript code to determine the visibility of this command.
 JS: Action:
 - JavaScript code that runs upon selecting this command.

---


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

Changelog

Version 1.01: August 30, 2020

  • Bug Fixes!
    • Deleted maps will have their ID's sorted out. Fix made by Shaz.

Version 1.00: August 21, 2020

  • Finished Plugin!

Help File