{"id":13733848,"url":"https://github.com/maskarade/gradle-android-ribbonizer-plugin","last_synced_at":"2025-05-08T10:30:25.937Z","repository":{"id":51294276,"uuid":"20545293","full_name":"maskarade/gradle-android-ribbonizer-plugin","owner":"maskarade","description":"Modifies launcher icons on debug build","archived":false,"fork":false,"pushed_at":"2023-10-10T00:43:09.000Z","size":392,"stargazers_count":355,"open_issues_count":8,"forks_count":37,"subscribers_count":8,"default_branch":"master","last_synced_at":"2024-11-02T19:02:56.035Z","etag":null,"topics":["android","gradle-plugin","launcher-icon"],"latest_commit_sha":null,"homepage":"https://bintray.com/gfx/maven/ribbonizer-plugin","language":"Java","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/maskarade.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGES.md","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}},"created_at":"2014-06-05T23:39:05.000Z","updated_at":"2024-02-09T11:40:25.000Z","dependencies_parsed_at":"2024-01-23T21:20:38.743Z","dependency_job_id":"6f250190-777c-4927-96d4-140fcf846e3d","html_url":"https://github.com/maskarade/gradle-android-ribbonizer-plugin","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maskarade%2Fgradle-android-ribbonizer-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maskarade%2Fgradle-android-ribbonizer-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maskarade%2Fgradle-android-ribbonizer-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maskarade%2Fgradle-android-ribbonizer-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/maskarade","download_url":"https://codeload.github.com/maskarade/gradle-android-ribbonizer-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224720749,"owners_count":17358476,"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":["android","gradle-plugin","launcher-icon"],"created_at":"2024-08-03T03:00:50.121Z","updated_at":"2024-11-15T02:31:52.659Z","avatar_url":"https://github.com/maskarade.png","language":"Java","funding_links":[],"categories":["Plugins"],"sub_categories":["Android application development"],"readme":"# DEPRECATED\nNo longer actively maintained, I recommend [Mikel's easylauncher-gradle-plugin](https://github.com/akaita/easylauncher-gradle-plugin) which might not have seen much love lately either, but seems to still work since the JFrog shutdown.\n\n# Ribbonizer plugin for Android\n\n[![Circle CI](https://circleci.com/gh/gfx/gradle-android-ribbonizer-plugin.svg?style=svg\u0026branch=master)](https://circleci.com/gh/gfx/gradle-android-ribbonizer-plugin) [![Download](https://api.bintray.com/packages/gfx/maven/ribbonizer-plugin/images/download.svg)](https://bintray.com/gfx/maven/ribbonizer-plugin/_latestVersion)\n\nThis is a ribbonizer as a Gradle plugin for Android, which adds a ribbon to launcher icons.\n\n![](ic-beta.png) ![](ic-debug.png)\n\n## Usage\n\n```groovy\n// in build.gradle\nbuildscript {\n    repositories {\n        jcenter()\n    }\n    dependencies {\n        classpath 'com.android.tools.build:gradle:2.1.2'\n        classpath 'com.github.gfx.ribbonizer:ribbonizer-plugin:2.1.0'\n    }\n}\n```\n\n```groovy\n// in app/build.gradle\napply plugin: 'com.github.gfx.ribbonizer'\n\nandroid {\n    // ...\n\n    buildTypes {\n        debug {/*debuggable build, which will ribbonized automatically*/}\n        beta {\n            //debuggable build which will automatically ribbonized.\n            debuggable true\n        }\n        canary {\n            //non-debuggable build which will no automatically ribbonized.\n            //But, we force one of its flavors. See `ribbonizer` for how-to\n            debuggable false\n        }\n        release {/*non-debuggable build. Will not be rebbonized automatically*/}\n    }\n\n    productFlavors {\n        local {}\n        qa {}\n        staging {}\n        production {}\n    }\n}\n\nribbonizer {\n    // \"manifest application[android:icon]\" is automatically added to the list\n    iconNames \"@drawable/ic_notification\", \"@drawable/widget_preview\"\n\n    builder { variant, iconFile -\u003e\n        // change ribbon colors by product flavors\n        if (variant.flavorName == \"local\") {\n            return grayRibbonFilter(variant, iconFile)\n        } else if (variant.flavorName == \"qa\") {\n            // customColorRibbonFilter allows setting any color code\n            def filter = customColorRibbonFilter(variant, iconFile, \"#00C89C\")\n            // Finer control of the label text can be achieved by setting it manually, or set to\n            // null for an unlabelled ribbon. The default is to use the flavor name.\n            filter.label = \"QA\" + variant.versionCode\n            return filter\n        } else if (variant.flavorName == \"staging\") {\n            return yellowRibbonFilter(variant, iconFile)\n        } else if (variant.buildType.name == \"debug\") {\n            if (variant.flavorName == \"production\") {\n                // Particular configurations can be skipped by returning no filters\n                return null\n            }\n            else {\n                // Other filters can be applied, as long as they implement Consumer\u003cBufferedImage\u003e\n                return grayScaleFilter(variant, iconFile)\n            }\n        } else {\n            return greenRibbonFilter(variant, iconFile)\n        }\n    }\n\n    //Although `canary` build-type is marked as `non-debuggable`\n    //we can still force specific variants to be ribbonized:\n    forcedVariantsNames \"localCanary\"\n}\n\n```\n\n\n## Project Structure\n\n```\nplugin/   - The main module of a Gradle plugin\nexample/  - An example android application that uses this plugin\nbuildSrc/ - A helper module to use this plugin in example modules\n```\n\nYou can test this project with `./gradlew check`.\n\n## Release Engineering\n\n```console\n./gradlew bumpMinor # or bumpMajor, bumpPatch\n\nmake publish # upload artifacts to bintray jcenter\n```\n\n## Author And License\n\nThe MIT License (MIT)\n\nCopyright (c) 2015 FUJI Goro (gfx) \u003cgfuji@cpan.org\u003e.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaskarade%2Fgradle-android-ribbonizer-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmaskarade%2Fgradle-android-ribbonizer-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaskarade%2Fgradle-android-ribbonizer-plugin/lists"}