Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/AlexDisler/cordova-icon
Automatic icon resizing for Cordova
https://github.com/AlexDisler/cordova-icon
Last synced: 5 days ago
JSON representation
Automatic icon resizing for Cordova
- Host: GitHub
- URL: https://github.com/AlexDisler/cordova-icon
- Owner: AlexDisler
- License: mit
- Archived: true
- Created: 2014-05-22T13:48:32.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2020-01-11T17:34:34.000Z (almost 5 years ago)
- Last Synced: 2024-12-02T02:44:15.071Z (10 days ago)
- Language: JavaScript
- Homepage:
- Size: 72.3 KB
- Stars: 689
- Watchers: 29
- Forks: 291
- Open Issues: 55
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-cordova - cordova-icon
README
# cordova-icon
Automatic icon resizing for Cordova. Create an icon in the root folder of your Cordova project and use cordova-icon to automatically resize and copy it for all the platforms your project supports (currenty works with iOS, Android, Windows 10 and OSX).
### Installation
```bash
$ sudo apt-get install imagemagick
$ # on Mac: brew install imagemagick
$ # on Windows: http://www.imagemagick.org/script/binary-releases.php#windows (check "Legacy tools")
$ sudo npm install cordova-icon -g
```
If you are using an older version of cordova (before 7.x):
```bash
$ sudo npm install [email protected] -g
```
### Requirements
- **ImageMagick installed**
- At least one platform was added to your project ([cordova platforms docs](http://cordova.apache.org/docs/en/edge/guide_platforms_index.md.html#Platform%20Guides))
- Cordova's config.xml file must exist in the root folder ([cordova config.xml docs](http://cordova.apache.org/docs/en/edge/config_ref_index.md.html#The%20config.xml%20File))
### Usage
Create an `icon.png` file in the root folder of your cordova project.
You can provide a platform-specific icon by naming it `icon-[platform].png`
(e.g `icon-android.png`, `icon-ios.png`).
Then run:
$ cordova-icon
You also can specify manually a location for your `config.xml` or `icon.png`:
$ cordova-icon --config=config.xml --icon=icon.png
If you run a old version of Cordova for iOS / Mac and you need your files in `/Resources/icons/`, use this option:
$ cordova-icon --xcode-old
For good results, your file should be:
- square
- for Android and iOS, at least 1024\*1024px
- for Windows, at least 1240\*1240px
#### Notes:
- Your `config.ml` file will not be updated by the tool (because images are automatically created in the good folders)
- Therefore, in your `config.xml`, be sure to remove all lines looking like ``
### Creating a cordova-cli hook
Since the execution of cordova-icon is pretty fast, you can add it as a cordova-cli hook to execute before every build.
To create a new hook, go to your cordova project and run:
$ mkdir hooks/after_prepare
$ vi hooks/after_prepare/cordova-icon.sh
Paste the following into the hook script:
#!/bin/bash
cordova-icon
Then give the script +x permission:
$ chmod +x hooks/after_prepare/cordova-icon.sh
That's it. Now every time you `cordova build`, the icons will be auto generated.
### Splash screens
Check out [cordova-splash](https://github.com/AlexDisler/cordova-splash)
### More
- [cordova-plugin-inapppurchase](https://github.com/AlexDisler/cordova-plugin-inapppurchase) - a lightweight cordova plugin for in app purchases on iOS/Android
- [ng-special-offer](https://github.com/AlexDisler/ng-special-offer) - prompt users to rate your cordova app in the app store
- [ionic-lock-screen](https://github.com/AlexDisler/ionic-lock-screen) - passcode lock screen for ionic (with touch id support for iOS)
- [ionic-zoom-view](https://github.com/AlexDisler/ionic-zoom-view) - an easy way to add a zoom view to images using an ionic modal
- [ng-persist](https://github.com/AlexDisler/ng-persist) - store data on mobile devices (using cordova) that persists even if the user reinstalls the app
### License
MIT