{"id":16774499,"url":"https://github.com/melonjs/debug-plugin","last_synced_at":"2025-07-31T03:38:22.164Z","repository":{"id":143506855,"uuid":"615583934","full_name":"melonjs/debug-plugin","owner":"melonjs","description":"melonJS official debug plugin","archived":false,"fork":false,"pushed_at":"2024-05-13T08:02:18.000Z","size":172,"stargazers_count":1,"open_issues_count":2,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-02-16T15:26:29.647Z","etag":null,"topics":["debug","debugging-tool","debugging-visualizer","game-development","javascript","melonjs","plugin","typescript"],"latest_commit_sha":null,"homepage":"https://melonjs.org","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/melonjs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-03-18T04:08:57.000Z","updated_at":"2025-01-27T10:58:17.000Z","dependencies_parsed_at":null,"dependency_job_id":"61767aa8-8c27-4483-965c-a350007d302c","html_url":"https://github.com/melonjs/debug-plugin","commit_stats":null,"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/melonjs%2Fdebug-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/melonjs%2Fdebug-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/melonjs%2Fdebug-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/melonjs%2Fdebug-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/melonjs","download_url":"https://codeload.github.com/melonjs/debug-plugin/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241686832,"owners_count":20003112,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["debug","debugging-tool","debugging-visualizer","game-development","javascript","melonjs","plugin","typescript"],"created_at":"2024-10-13T06:49:18.094Z","updated_at":"2025-03-03T15:15:30.635Z","avatar_url":"https://github.com/melonjs.png","language":"JavaScript","readme":"# melonJS Debug Plugin\n![melonJS Logo](https://github.com/melonjs/melonJS/raw/master/media/Banner/Banner%20-%20Billboard%20-%20Original%20Logo%20-%20horizontal.png)\n\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/melonjs/es6-boilerplate/blob/master/LICENSE)\n[![NPM Package](https://img.shields.io/npm/v/@melonjs/debug-plugin)](https://www.npmjs.com/package/@melonjs/debug-plugin)\n[![jsDeliver](https://data.jsdelivr.com/v1/package/npm/@melonjs/debug-plugin/badge?style=rounded)](https://www.jsdelivr.com/package/npm/@melonjs/debug-plugin)\n\nInstallation\n-------------------------------------------------------------------------------\n`$ [sudo] npm install @melonjs/debug-plugin`\n\nThen import and instantiante the debug plugin in your project. For example:\n```JavaScript\nimport { utils, plugin } from 'melonjs';\n\n// dynamically import the plugin\nimport(\"@melonjs/debug-plugin\").then((debugPlugin) =\u003e {\n    // automatically register the debug panel\n    utils.function.defer(plugin.register, this, debugPlugin.DebugPanelPlugin, \"debugPanel\");\n});\n```\n\nUsage\n-------------------------------------------------------------------------------\n\nThe Debug Panel is hidden by default and can be displayed using the `S` key, it will then provide the below information :\n![debug-panel](https://user-images.githubusercontent.com/4033090/138006717-cf3165a4-a52d-4855-a7c7-16b2a09ed124.png)\n\n* Amount of objects currently active in the current scene\n* Amount of draws operation\n* Amount of body shape (requires to enable the hitbox checkbox)\n* Amount of bounding box\n* Amount of sprites objects\n* Amount of objects currently inactive in the the object pool\n* Heap/memory usage\n* Frame update time (in ms)\n* Frame draw time (in ms)\n* Current fps rate vs target fps\n\n\u003e Note: Heap information requires starting Chrome [with](http://www.chromium.org/developers/how-tos/run-chromium-with-flags) `--enable-precise-memory-info`\n\nAdditionally, using the checkbox in the panel it is also possible to draw :\n* Shape and Bounding box for all objects\n* Current velocity vector\n* Quadtree spatial visualization\n\nQuestions, need help ?\n-------------------------------------------------------------------------------\nIf you need technical support, you can contact us through the following channels :\n* Forums: with melonJS 2 we moved to a new discourse [forum](https://melonjs.discourse.group), but we can still also find the previous one [here](http://www.html5gamedevs.com/forum/32-melonjs/)\n* Chat: come and chat with us on [discord](https://discord.gg/aur7JMk)\n* we tried to keep our [wikipage](https://github.com/melonjs/melonJS/wiki) up-to-date with useful links, tutorials, and anything related melonJS.","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmelonjs%2Fdebug-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmelonjs%2Fdebug-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmelonjs%2Fdebug-plugin/lists"}