Skip to content

Latest commit

 

History

History
62 lines (44 loc) · 1.98 KB

README.md

File metadata and controls

62 lines (44 loc) · 1.98 KB
Raw

OpenFL-Console is haxe logger/debugger for OpenFL.
It comes with a collection of features to help speed up your development.

Console overlays on top of your OpenFL application.
Remote logging feature is also available to log to an external console.
No special browser or player version is required.

New features

  • Optional tilemap support has been added to Display Roller. (It must be enabled from config)
  • [New Addon] It is possible to check for memory leaks with the Memory Tracker addon.
  • [New Addon] Run scripts with HScript addon.

Main features

  • Channels
  • Priorities aka levels with colour code
  • Object linking where you can click on objects in log to inspect aka introspection
  • [CommandLineHelp Command line] CL - lets you execute code at runtime (as3 syntax)
  • [Remoting Remote logging] also as Adobe AIR app
  • No dependencies, requirements and non-invasive
  • Super fast!
  • [Addons] adds specialized features

Other features

  • filtering/searching via exact match or regular expression
  • Roller tool Ro - shows display map of what's under your mouse pointer
  • Graph reporting numeric values (such as FPS, memory, user definable)
  • Ruler tool RL - Measure distances/degrees on screen
  • Garbage collection monitor - notifies you when objects of your interest are being garbage collected.
  • Key-binding to functions
  • Non-repetitive tracing
  • Customizable UI
  • Easy to remove when no longer needed

Goal

  • The goal is for the project to be fully compatible with OpenFL and to add new features.

Completion Status

  • %100

Missing Features

Pull requests are welcome

OpenFL Console is port of Flash Console

Installation

haxelib install openfl-console

add in your project.xml:

<haxelib name="openfl-console"/>
<haxeflag name="--macro" value="addGlobalMetadata('', '@:rtti')" if="debug"/>