Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jansedivy/potion-debugger
Debugger for Potion framework
https://github.com/jansedivy/potion-debugger
Last synced: 15 days ago
JSON representation
Debugger for Potion framework
- Host: GitHub
- URL: https://github.com/jansedivy/potion-debugger
- Owner: jansedivy
- License: mit
- Created: 2014-07-26T13:50:22.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2015-12-07T15:29:34.000Z (about 9 years ago)
- Last Synced: 2024-12-03T05:04:33.000Z (25 days ago)
- Language: JavaScript
- Size: 24.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Potion Debugger
Game debugger for [Potion framework](https://github.com/jansedivy/potion)
## Screenshot
## Installation
`npm install potion-debugger`
## Features
- runtime informations
- togglable settings
- logging
- pretty printing objects, arrays
- error logging with stack traces (even with Browserify using [source-map-support](https://github.com/evanw/node-source-map-support))
## Usage
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
```javascript
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);
}
});
```
## Keyboard shortcuts
- **F12** toggles all debug rendering
- **\** shows user defined togglable options
## Custom 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
```javascript
this.debug = new Debugger(this, [
{ name: 'Show Pathfinding', entry: 'showPathFinding' }
{ name: 'Alert', type: 'call', entry: function() { alert('debug'); } }
]);
```
#### name
Rendered name for the option
#### type
defaults to `toggle`, can be `toggle` or `call`
#### default
default value
#### entry
When type is `toggle` entry will be defined as property on debug instance
###### example
```javascript
if (this.debug.showPathFinding) {
// render
}
```
When type is `call` entry is going to be called as function
## API
### log(message, color=white)
#### message
Value you want to print to the screen, can be any javascript value (string, object, array, ...)
#### color
Color you want to use for printing the message
## License
[MIT license](http://opensource.org/licenses/mit-license.php)