{"id":15633630,"url":"https://github.com/sockeqwe/debugoverlay","last_synced_at":"2025-04-14T12:32:20.506Z","repository":{"id":43166043,"uuid":"44209965","full_name":"sockeqwe/debugoverlay","owner":"sockeqwe","description":"A tiny window overlay to log app internal on top of your android app","archived":false,"fork":false,"pushed_at":"2021-03-01T17:04:29.000Z","size":111,"stargazers_count":151,"open_issues_count":2,"forks_count":39,"subscribers_count":13,"default_branch":"master","last_synced_at":"2025-03-28T01:49:55.209Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://hannesdorfmann.com/android/debug-overlay/","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sockeqwe.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}},"created_at":"2015-10-13T22:47:29.000Z","updated_at":"2023-07-14T07:20:26.000Z","dependencies_parsed_at":"2022-09-13T12:23:52.037Z","dependency_job_id":null,"html_url":"https://github.com/sockeqwe/debugoverlay","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sockeqwe%2Fdebugoverlay","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sockeqwe%2Fdebugoverlay/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sockeqwe%2Fdebugoverlay/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sockeqwe%2Fdebugoverlay/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sockeqwe","download_url":"https://codeload.github.com/sockeqwe/debugoverlay/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248881749,"owners_count":21176913,"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":[],"created_at":"2024-10-03T10:49:44.558Z","updated_at":"2025-04-14T12:32:20.479Z","avatar_url":"https://github.com/sockeqwe.png","language":"Java","funding_links":[],"categories":["Libs"],"sub_categories":["\u003cA NAME=\"Widget\"\u003e\u003c/A\u003eWidget"],"readme":"# DebugOverlay\nA `logcat` alike overlay to display log messages in your app as independent overlay.\n\nTypically in android you would log some app internals for debugging puropose by using `Log.d()`. However, sometimes you may need to display that logging messages right on the screen to make them visible for non developers that have to verify certain app internals, like tracking.\n\n![DebugOverlay](http://hannesdorfmann.com/images/debugoverlay.png)\n\nThis tiny library adds an overlay as independent `Window` on top of your android application. You can close this `DebugOverlay`-Window by clicking on the close button. The window will then automatically pop up again when the next message to log is detected.\n\n## How to use it\n```java\nDebugOverlay.with(context).log(\"My logging message\");\n```\n\n## Dependencies\nObviously you wont deliver this `DebugOverlay` with you production code in the play store .apk file. Hence this library provides two maven artifacts to include.\n```groovy\ndebugCompile('com.hannesdorfmann:debugoverlay:0.4.0') // Starts the service and displays the overlay\nreleaseCompile('com.hannesdorfmann:debugoverlay-noop:0.4.0') // Does nothing\n```\n\nThe idea is to use gradle build types to add the `DebugOverlay` only to debug builds.\n`debugoverlay` is the real implementation and displays the window while `debugoverlay-noop` is a stub and simply does nothing!\n\n## Permissions\nPlease note that `com.hannesdorfmann:debugoverlay:0.4.0` will add `android.permission.SYSTEM_ALERT_WINDOW` to your apk. Hence you should avoid to use that dependency for your release `.apk`\n\n## Features\nThe api is very simple. You can simply log string messages. You can open new issues here on github to make a new feature request. If it is not too complicated and will not add a lot of new methods to the public API (dex count 65k limit) then it's very likely that we can add this feature to this library.\n\n## License\n```\nCopyright 2015 Hannes Dorfmann\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n   http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsockeqwe%2Fdebugoverlay","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsockeqwe%2Fdebugoverlay","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsockeqwe%2Fdebugoverlay/lists"}