When something goes wrong

If the editor does something strange (or a bug happens) you can check the debug console to see what happened, use the bug report option to copy it, or use the Report an Issue to send it.

The debug console#

View ▸ Debug Console opens a strip along the bottom of the window with the log in it: maps opened and saved, plugins started and stopped, where the game data came from, and every error the page threw.

The log is kept whether the strip is open or not, so opening it after something odd happened still shows what happened. The last couple of thousand lines are kept; Clear empties it, for starting clean before reproducing something.

Warnings and Errors narrow the list to what went wrong; the box beside them filters on any text. Verbose adds a line for every edit and every call a plugin makes into the editor. It answers "which plugin did that?", it is noisy by design, and it turns itself off when you next load the editor.

Copying a bug report#

Help ▸ Copy Bug Report puts the log on the clipboard with a short header above it — the version, the browser or desktop app, where the game data came from, the map's size and tileset, and the plugins with their versions — ready to paste into an issue, a forum post or a message. A long session is trimmed to its most recent lines so the paste fits in an issue; when it is, the report says so.

The console's own Copy does the same without the trim, and Save… writes the whole log to a file, for when it is too long to paste.

Filing an issue#

Help ▸ Report an Issue… opens a new issue on GitHub with the report already filled in, under three questions: what you did, what you expected, and what happened. Answer those, check the rest, and submit. You need a GitHub account.

The automatic issue contains a truncated log. If the lines that matter are not listed, use Copy Bug Report and paste it over the shortened one.

Nothing is sent until you submit the issue yourself. Every report names the map file you have open, the plugins you have installed and the build you are running. Nothing specific to you is included.