{"id":21511979,"url":"https://github.com/strvcom/ios-version-icon","last_synced_at":"2025-04-09T18:20:47.506Z","repository":{"id":56925922,"uuid":"174138170","full_name":"strvcom/ios-version-icon","owner":"strvcom","description":"Script written in Swift that prepares the iOS app icon overlay with ribbon, build type and version (build) info","archived":false,"fork":false,"pushed_at":"2023-11-09T16:55:59.000Z","size":6927,"stargazers_count":31,"open_issues_count":2,"forks_count":2,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-03-23T20:21:52.777Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Swift","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/strvcom.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":"2019-03-06T12:08:59.000Z","updated_at":"2024-10-16T14:59:35.000Z","dependencies_parsed_at":"2024-11-23T22:24:57.373Z","dependency_job_id":"936edc01-e3f9-4f1c-97b4-a53f5df9a8b2","html_url":"https://github.com/strvcom/ios-version-icon","commit_stats":null,"previous_names":[],"tags_count":27,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/strvcom%2Fios-version-icon","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/strvcom%2Fios-version-icon/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/strvcom%2Fios-version-icon/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/strvcom%2Fios-version-icon/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/strvcom","download_url":"https://codeload.github.com/strvcom/ios-version-icon/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248085369,"owners_count":21045145,"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-11-23T22:24:38.562Z","updated_at":"2025-04-09T18:20:47.488Z","avatar_url":"https://github.com/strvcom.png","language":"Swift","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Version](https://img.shields.io/cocoapods/v/VersionIcon.svg?style=flat)](https://cocoapods.org/pods/VersionIcon)\n[![License](https://img.shields.io/cocoapods/l/VersionIcon.svg?style=flat)](https://cocoapods.org/pods/VersionIcon)\n\n\u003cp align=\"center\"\u003e\n    \u003cimg src=\"https://i.ibb.co/pBJbxxsH/App-Icon60x60-2x.png\" width=\"180\" max-width=\"180\" alt=\"VersionIcon\" /\u003e\n\u003c/p\u003e\n\n# VersionIcon\n\nA simple tool that can add an icon overlay with app version to your iOS app icon. Overlays can include the ribbon with app version (_Dev_, _Staging_, _Production_, _MVP_...) and/or version number. The icon overlays can be customized many ways. You can also use your own graphic resources. The VersionIcon tool is distributed in binary form, so it is independent on your project setup.\n\n- [Requirements](#requirements)\n- [Installation](#installation)\n- [Usage](#usage)\n- [License](#license)\n\n## Requirements\n\n- Xcode 10.0+\n\n## Installation\n\n### Cocoapods\n\n[CocoaPods](http://cocoapods.org) is a dependency manager for Cocoa projects. You can install it with the following command:\n\n```bash\n$ gem install cocoapods\n```\n\nTo integrate VersionIcon into your Xcode project using CocoaPods, specify it in your `Podfile`:\n\n```ruby\npod 'VersionIcon', '~\u003e 1.0.8'\n```\n\nThen, run the following command:\n\n```bash\n$ pod install\n```\n\n## Usage\n\n* Make a duplicate of your app icon resource in asset catalog - let's have for example _AppIcon_ and _AppIconOriginal_. The copy is used as a backup. Production builds typically have no icon overlays. (if your project contains icon resource with other than this default name, you need to specify it using `--appIcon` and/or `--appIconOriginal` parameter.\n* Create a new Run Script Phase in Build Settings \u003e Build Phases in your app\n* Use this shell script:\n```shell\nif [ \"${CONFIGURATION}\" = \"Release\" ]; then\n    \"Pods/VersionIcon/Bin/VersionIcon\" --resources \"Pods/VersionIcon/Bin\" --original\nelse\n    \"Pods/VersionIcon/Bin/VersionIcon\"  --ribbon Blue-TopRight.png --title Devel-TopRight.png --resources \"Pods/VersionIcon/Bin\" --strokeWidth 0.07\nfi\n```\n* If your projects contains different configuration names, you'll need to adjust the script.\n* Move this script phase above the Copy Bundle Resources phase.\n* If you need to use your own ribbon or title asset, you can specify full path to image file\n\n## Parameters\n#### Ribbon Style\n* `--ribbon \u003cIcon ribbon\u003e`\n    * Icon ribbon. The folder Ribbons contains variety of ribbons .png files with different colors and positions. You can also specify the absolute path to your custom .png.\n    \n* `--title \u003cIcon ribbon title\u003e`\n    * The title on ribbon. You can choose from a several predefined titles in different positions in Titles folder. Or you can provide absolute path to your custom ribbon title image. (Ribbon titles are images with transparency, custom text is not supported yet)\n\n#### Icon version Title\n* `--fillColor \u003cTitle fill color\u003e`\n    * The fill color of version title in `#xxxxxx` hexa format. Default fill color is white ('#FFFFFF').\n    \n* `--strokeColor \u003cTitle stroke color\u003e`\n    * The stroke color of version title in `#xxxxxx` hexa format. Default stroke color is black ('#000000').\n    \n* `--strokeWidth \u003cVersion Title Stroke Width\u003e`\n    * The title stroke width related to icon width. Default value of stroke width is '0.03'.\n    \n* `--font \u003cVersion label font\u003e`\n    * Font used for version title. Default font is 'Impact'.\n    \n* `--titleSize \u003cVersion Title Size Ratio\u003e`\n    * Version title size related to icon width. Default title size is '0.2'.\n    \n* `--horizontalTitlePosition \u003cVersion Title Size Ratio\u003e`\n    * Version title position related to icon width. Default = '0.5'.\n    \n* `--verticalTitlePosition \u003cVersion Title Size Ratio\u003e`\n    * Version title position related to icon width. Default = '0.2'.\n      \n* `--titleAlignment \u003cVersion Title Text Alignment\u003e`\n    * Possible values are left, center, right. Default = 'center'.\n    \n* `--versionStyle \u003cThe format of version label\u003e`\n    * Possible values are _dash_, _parenthesis_, _versionOnly_, _buildOnly_. Default = 'dash'.\n\n#### Script Setup\n* `--resources \u003cVersionIcon resources path\u003e`\n    * Default path where Ribbons and Titles folders are located. It is not necessary to set when script is executed as a build phase in Xcode\n    \n* `--original`\n    * If you need to use just original icon without any modifications, use this parameter. The production app typically has no icon overlay.\n    \n* `--help`\n    * Full description of parameters is available when you run VersionIcon with `--help` parameter\n\n## Debugging\n\nIf you want to modify the behavior and debug VersionIcon in context of your project, you need a special setup of the scheme. The screenshot shows the commandline arguments passed on launch. These parameters can be copied from the existing VersionIcon call build phase. And three environment variables that are necessary to propagate. The values of these environment are visible in the Xcode's Report navigator. All checkboxes should be on.\n\n\u003cp align=\"center\"\u003e\n    \u003cimg src=\"https://i.ibb.co/5XC6fT9p/Scheme-Setup.png\" width=\"936\" max-width=\"534\" alt=\"Scheme\" /\u003e\n\u003c/p\u003e\n\n\n## Contributing\n\nIssues and pull requests are welcome!\n\n## Author\n\n* Daniel Čech [GitHub](https://github.com/DanielCech) \n\n## License\n\nVersionIcon is released under the MIT license. See [LICENSE](https://github.com/DanielCech/DeallocTests/blob/master/LICENSE) for details.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstrvcom%2Fios-version-icon","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstrvcom%2Fios-version-icon","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstrvcom%2Fios-version-icon/lists"}