Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/britzl/defpro
Defold Profiler interaction using Lua
https://github.com/britzl/defpro
defold defold-library profiling
Last synced: about 1 month ago
JSON representation
Defold Profiler interaction using Lua
- Host: GitHub
- URL: https://github.com/britzl/defpro
- Owner: britzl
- License: mit
- Created: 2016-09-09T05:06:27.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2019-02-15T06:44:16.000Z (almost 6 years ago)
- Last Synced: 2024-11-02T14:23:19.363Z (about 2 months ago)
- Topics: defold, defold-library, profiling
- Language: Lua
- Size: 160 KB
- Stars: 23
- Watchers: 9
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-defold - DefPro
README
# DefPro
This project provides a way to interact with the [Defold](http://www.defold.com) profiler using Lua. It can be used inside a running Defold game to show a profiler overlay (much like the existing [visual profiler](http://www.defold.com/manuals/debugging/#_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](http://www.defold.com/manuals/debugging/#_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](http://www.defold.com/manuals/libraries/). 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](http://w3.impa.br/~diego/software/luasocket/).
# Examples
### From Defold
Check [examples/defold](https://github.com/britzl/defpro/tree/master/example/defold) for an example of how to get and display profiler data from within a running Defold app.
### From command line
Check [examples/commandline](https://github.com/britzl/defpro/tree/master/example/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!
