defpro

Defold Profiler interaction using Lua

MIT License

Stars
19

DefPro

This project provides a way to interact with the Defold profiler using Lua. It can be used inside a running Defold game to show a profiler overlay (much like the existing visual profiler). It is also possible to use from the command line to pull profiler data from a running Defold game in much the same way as the web profiler. This is useful if you wish to get key metrics and send them off to some other system or as part of automated testing to verify that certain values do not go above defined thresholds.

Requirements

From Defold

When using this project from within Defold the only thing you need to do is to include this project as a library dependency. Add this to your dependencies in game.project to get the latest version:

https://github.com/britzl/defpro/archive/master.zip

From command line

When running from the command line you need to use a Lua version with bit wise operations enabled (LuaJit or Lua 5.2+). You also need LuaSocket.

Examples

From Defold

Check examples/defold for an example of how to get and display profiler data from within a running Defold app.

From command line

Check examples/commandline for an example of how to get and display profiler data from the command line. Run the example like this:

lua example/commandline/capture.lua

Make sure to have a Defold app running!