{"id":21065073,"url":"https://github.com/prolificinteractive/birdo","last_synced_at":"2026-05-16T23:32:20.786Z","repository":{"id":147516527,"uuid":"141630863","full_name":"prolificinteractive/Birdo","owner":"prolificinteractive","description":"Prolific's android wrapper around the UI code that is often needed for displaying debug menus.","archived":false,"fork":false,"pushed_at":"2019-07-25T15:51:49.000Z","size":299,"stargazers_count":1,"open_issues_count":1,"forks_count":1,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-14T01:46:23.776Z","etag":null,"topics":["android","debug","kotlin"],"latest_commit_sha":null,"homepage":"","language":"Kotlin","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/prolificinteractive.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":"2018-07-19T21:07:07.000Z","updated_at":"2019-07-25T15:51:49.000Z","dependencies_parsed_at":null,"dependency_job_id":"426a7203-36e8-4afb-a615-054707802b17","html_url":"https://github.com/prolificinteractive/Birdo","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/prolificinteractive/Birdo","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prolificinteractive%2FBirdo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prolificinteractive%2FBirdo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prolificinteractive%2FBirdo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prolificinteractive%2FBirdo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/prolificinteractive","download_url":"https://codeload.github.com/prolificinteractive/Birdo/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prolificinteractive%2FBirdo/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33122087,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-16T18:38:32.183Z","status":"ssl_error","status_checked_at":"2026-05-16T18:38:29.903Z","response_time":115,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["android","debug","kotlin"],"created_at":"2024-11-19T17:53:23.072Z","updated_at":"2026-05-16T23:32:20.770Z","avatar_url":"https://github.com/prolificinteractive.png","language":"Kotlin","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cimg src=\"/assets/hero.jpg\"/\u003e\n\n# Birdo\n[![Travis branch](https://img.shields.io/travis/prolificinteractive/Birdo/master.svg)](https://travis-ci.org/prolificinteractive/Birdo) [![](https://jitpack.io/v/prolificinteractive/birdo.svg)](https://jitpack.io/#prolificinteractive/birdo)\n\nProlific's wrapper for debugging their application. \n\nBirdo is based on DebugDrawer (https://github.com/palaima/DebugDrawer). \n\n## Installation\n\nStep 1. Add the JitPack repository to your build file\n\n```groovy\nallprojects {\n  repositories {\n    ...\n    maven { url 'https://jitpack.io' }\n  }\n}\n```\n\nStep 2. Add the dependency\n\n```groovy\ndependencies {\n  implementation 'com.github.prolificinteractive:birdo:${birdoVersion}'\n}\n```\n\n## Usage\n\n```kotlin\nclass App : Application() {\n  override fun onCreate() {\n    super.onCreate()\n\n    // Add this to your application class. Detect shakes and launch the default Birdo view.\n    ShakerDetector(this, BirdoInitializer(this))\n  }\n}\n```\n\n## Customization\n\n### Detectors\n\nThe detectors are utility classes that will launch Birdo upon a certain set of predefined user actions.\n\n#### ShakerDetector\n\nThe shaker detector is simply relying on shakes movement to launch Birdo. To use it, simply initialize the detector in your application class, like so:\n\n```kotlin\nclass App : Application() {\n  override fun onCreate() {\n    super.onCreate()\n\n    // Add this to your application class. Detect shakes and launch the default Birdo view.\n    ShakerDetector(this, BirdoInitializer(this))\n  }\n}\n```\n\n#### VolumeDownDetector\n\nThe volume down detector is looking for the user pressing 3 times volume down. To use it, you should add the detector to your base activity:\n\n```kotlin\nopen abstract class BaseActivity : AppCompatActivity() {\n  private lateinit var keyUpDetector: KeyUpDetector\n\n  override fun onCreate(savedInstanceState: Bundle?) {\n    super.onCreate(savedInstanceState)\n\n    keyUpDetector = VolumeDownDetector(BirdoInitializer(this))\n  }\n\n  override fun onKeyUp(keyCode: Int, event: KeyEvent): Boolean {\n    keyUpDetector.onKeyUp(this, keyCode, event)\n    return super.onKeyUp(keyCode, event)\n  }\n}\n```\n\nFeel free to implement your own version of KeyUpDetector with your own combination of keys.\n\n#### Your Own\n\nYou can also simply launch Birdo your way:\n\n```kotlin\nval birdoInitializer = BirdoInitializer(this)\nbutton.setOnClickListener { birdoInitializer.start(this) }\n```\n\n### Custom Birdo Modules\n\nBirdo comes with a set of predefined modules. You can always customize Birdo by providing your own implementation to the BirdoInitializer.\n\nFor example:\n```kotlin\nShakerDetector(this, BirdoInitializer(this, MyBirdoActivity::class.java))\n```\n\nExtending of BirdoActivity allows you to provide your Picasso or OkHttpClient instance, and provide your own custom modules.\n\n\n## Contributing to Birdo\n\nTo report a bug or enhancement request, feel free to file an issue under the respective heading.\n\nIf you wish to contribute to the project, fork this repo and submit a pull request. Code contributions should follow the standards specified in the [Prolific Android Style Guide](https://github.com/prolificinteractive/android-code-styles).\n\n## License\n\n![prolific](https://s3.amazonaws.com/prolificsitestaging/logos/Prolific_Logo_Full_Color.png)\n\nCopyright (c) 2019 Prolific Interactive\n\nBirdo is maintained and sponsored by Prolific Interactive. It may be redistributed under the terms specified in the [LICENSE] file.\n\n[LICENSE]: ./LICENSE\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprolificinteractive%2Fbirdo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprolificinteractive%2Fbirdo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprolificinteractive%2Fbirdo/lists"}