rpg-maker-mv-Debugger

Useful debugging plug-in for the RPG MAKER MV

For future plugin compatibility, it is recommended to place the debugger on top of the plugin manager!

Note that windows and information require space. The best setting is 1366*768 resolution.

With this add-on, you can monitor real-time event feedback while testing the game. It supports a wide range of event actions, and you have the possibility to use precise (start/end) hierarchical logging (only possible with manual script embedding, and no way to use this for Paralell and Autorun events yet!)

Due to the size of the logging window, and other windows, I suggest you use a higher resolution, at least while you are testing, to fit everything.

The resolution used during development: 1366 wide / 768 high. Use for example Yanfly CoreEngine.

In addition to the log window, it also contains some additional windows that can be turned off and on:

Game time
Steps
Gold meter

Special module window group.

There are currently 2 groups available, and only one group can be active at a time. These are always 3 maximum windows, which appear directly above your logging window.

In the first group you can visually track the changes of 3 items in relatime.

In the second group you can add player (leader) info e.g.: (these are also updated in real time)

HP / MP / TP / LEVEL / ACTOR NAME / CLASS / MAP NAME

Event action Track list:

Switcher state (both single and range supported)
Self Switch State
Variables changes (both single + range) Current value calc print too
Level up / Down (both manual, and automatically)
Item gain / Remove
Money gain / remove
Teleport from / to
Waiting
Common event (Still in development) (just need to show, if the event action come from normal, or common event)
Erase event
Party changed (add / remove)
Movement Route (start / end)
Conditional Branch (true / false)
Repeatable and configurable steps log
Change tilesets
Selected Choices
Change XP (by event)
Items used in the menu (multiple support)
Region Movement (entered / left)
Tint Screen
Play BGM
Control timer (stopped / expired / rem time)
Yanfly Region Events
Yanfly Quest Journey

There is currently compatibility with two extension:

Yanfly Quest Journey:

Supported logs: plugin commands only: Completed, Added ( all three types: single, multiple, and range version plugin commands)

For objective performances, a trimming technique is still being developed, as it is not advisable to add too long entries, and the names of the objectives can be long.

Yanfly RegionEvents

Precise manual event tracking (with end and start signals):

this.logEvent(this._eventId) you need to call this at the top of your event page. this.finishEvent(this._eventId); and this to the bottom of your event page.

** Similar system with the Common events: this.logCommonEvent(n) -- Change the N with your common event ID (place this script call top of your common event page) this.finishCommonEvent(n) -- Change the N with your common event ID (place this script call bottom of your common event page as !last action)

Sample:

Unfortunately, you have to set it for each page if you want to use it.

There is a starter log built in. It runs when you start the game.

To do this, you need to store a var for it, because it only needs to be run once when the game starts. If you don't want to use it, set it to 0 (i.e. none).

The Starter returns the following data (this is from the player + track):

Current Map name
Current cooridnate
Dash enabled / or not
Encounters on the track
How many people are in the party
How much gold the player has
Tileset name
Activated plugins number

Log window Informations

One of the challenges of the logging window was solving the line break. It will happen that in some situations the line break will not be correct, I am still working on this, but these require complicated calculations. The log window is scrollable, for which you can set two keyboard shortcuts.

In addition, there is a Smartfade technique that fades the window itself after 5 seconds of inactivity (texts are not affected) You can define a key to toggle the window log visibility

You can turn this feature off.

It will be automatically hidden in case of dialogue, later it will be customizable.

Event labelling

This is a labelling system that you can use to label certain events. Currently it does not handle multi-page labels, i.e. it will not overwrite if you use a different label on the pages. (we are working on it)

Labeling works with a tiny script call: this.createEventLabel(1, "Hello World", "red");

The one is the ID of the event, and you can give the text a coloring if you like.

Known issue:

Autorun and Paralell events cannot currently be manually tracked properly. Here I am mainly working on finding an optimized solution for logging them.

Currently, information can be printed from a parallel event. But if it is spammed, performance problems can occur, as it will keep trying to log (these are usually rare, but can happen)

Changelog

0.19.5

Plugin list window resized
Pluginlist header no longer count the separator plugins.
NEW Tint Screen log (Support predefined versions too)
NEW Play BGM log
NEW Full Control timer logs
Reposition the countdown timer (param)
New Range switcher now can log also
New Range Variable now can log also
Single variable log now will calculates the current value and will print also

0.19.0

NEW Title screen scrollable window show the activated plugins. (+ version support)
Complete refactored the Log system storage (Many future problems have been solved)
Resized the log window (+30 width)
Repositioned the Modal window Groups
Fixed the issue if the player opened the shop, the same event action logs deleted.
Option to delete the logs.(you can define a keyups)
Option to enable or disable, if player teleport, log every prev logs from the window deleting
Title screen show the Debugger is enabled text
New Goal system (pre-alpha) think no big deal

0.18.0

New Plugin Compatibility: Yanfly RegionEvents
NEW Region Logs
Region logs enable / disable param
NEW Item used log (Only if item used on the menu screen support multiple items in a same time)
Param to enable / disable item used logs
New Common event manual tracker (just like the event) -
New script call : this.finishCommonEvent(n)

0.17.5

NEW you can define a key to toggle the log window visibility
Enable / Disable Switcher log param
Enable / Disable the Waiting Logs param
NEW Player logs - Change Xp

0.17.1

Removed the event id form the logs when using the manual scripts (page changes)

0.17

Better Logs Commenting separators
We tried to fix the line break
Removed the mapID from the log, when player teleporting.
Fixed the teleport log bug,
now there is no problem with keys not working in the Show Choices
Fixed the Questlog param
NEW Mapname displaying in the first(#1) Playerinfo modal window
NEW Show Choice - selected Choice log
NEW Starter log include Activated plugins number
NEW Change tilesets logs

0.16

Fixed the Conditional Branch log Bug. (cant freeze anymore the game)
Removed the Battle logs (It is being redesigned.)
Fixed the three player info window position, and fixed the third window battle visibility bug
From now on, when the fight is over and the player has won, the battle does not delete the previous log entries.
Starter log : Added a new Party player names log, and map tilesets name log
NEW configurable Steps log (repeat)
NEW ItemEnable log param

0.15

Refactored the Switcher log. Now better handling, when come the log from paralell or autorun events.
Refactored the Self Switcher log. Now better handling, when come the log from paralell or autorun events. (Bonus Disable logging)
Refactored better gold gain / remove handling
NEW Conditional Branch False log.
NEW Movement Route log