Game debugger for Potion framework

npm install potion-debugger

• runtime informations
• togglable settings
• logging
• pretty printing objects, arrays
• error logging with stack traces (even with Browserify using source-map-support)

Debugger requires some methods to be called

• update - must be called with time in exitUpdate hook
• render - must be called in render hook
• keydown - must be called with key in keydown hook

Debugger also requires runtime property with time on the Potion instance for displaying total game time

var Debugger = require('potion-debugger');

Potion.init(document.querySelector('canvas'), {
  init: function() {
    this.runtime = {
      time: 0
    };

    this.debug = new Debugger(this);
  },

  update: function(time) {
    this.runtime.time += time;
  },

  exitUpdate: function(time) {
    this.debug.update(time);
  },

  render: function() {
    this.debug.render();
  },

  keydown: function(key) {
    this.debug.keydown(key);
  }
});

• F12 toggles all debug rendering
• ** shows user defined togglable options

When creating debugger instance you can pass array of options you want to configure

Keyboard shortcuts are automatically defined based on the position in array

There are already defined 3 custom options for showing fps, time and key/button codes

this.debug = new Debugger(this, [
  { name: 'Show Pathfinding', entry: 'showPathFinding' }
  { name: 'Alert', type: 'call', entry: function() { alert('debug'); } }
]);

Rendered name for the option

defaults to toggle, can be toggle or call

default value

When type is toggle entry will be defined as property on debug instance

if (this.debug.showPathFinding) {
  // render
}

When type is call entry is going to be called as function

Value you want to print to the screen, can be any javascript value (string, object, array, ...)

Color you want to use for printing the message

MIT license