# cordova-splash

> Automatic splash screen cropping for Cordova

Latest version **1.0.0** (published 2018-02-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install cordova-splash
pnpm add cordova-splash
yarn add cordova-splash
bun add cordova-splash
```

Provides the command `cordova-splash`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2018-02-09 |
| First published | 2014-10-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 14.4 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 435 |
| Author | Alex Disler |
| Maintainers | alex101 |
| Keywords | cordova, splash, splashscreen, crop |

## Links

- npm: https://www.npmjs.com/package/cordova-splash
- Repository: https://github.com/AlexDisler/cordova-splash
- Issues: https://github.com/AlexDisler/cordova-splash/issues
- npm.io page: https://npm.io/package/cordova-splash

## Dependencies (7)

- [q](https://npm.io/package/q.md) ^1.0.1
- [colors](https://npm.io/package/colors.md) ^0.6.2
- [xml2js](https://npm.io/package/xml2js.md) ^0.4.3
- [fs-extra](https://npm.io/package/fs-extra.md) ^0.30.0
- [minimist](https://npm.io/package/minimist.md) ^1.2.0
- [underscore](https://npm.io/package/underscore.md) ^1.6.0
- [imagemagick](https://npm.io/package/imagemagick.md) ^0.1.3

## Recent versions

- 1.0.0 (latest) — 2018-02-09
- 0.12.0 — 2018-02-07
- 0.11.0 — 2018-02-06
- 0.10.0 — 2017-11-04
- 0.9.0 — 2016-08-25
- 0.8.0 — 2016-08-19
- 0.7.1 — 2016-04-21
- 0.7.0 — 2016-04-13
- 0.6.0 — 2016-03-26
- 0.5.1 — 2016-03-11
- 0.4.0 — 2016-02-19
- 0.3.0 — 2014-11-20
- 0.2.0 — 2014-11-18
- 0.1.1 — 2014-10-03
- 0.1.0 — 2014-10-03

## README

# cordova-splash

Automatic splash screen generator for Cordova. Create a splash screen once in the root folder of your Cordova project and use cordova-splash to automatically crop and copy it for all the platforms your project supports (currenty works with iOS, Android and Windows 10).

The splash screen image should be 2208x2208 px with a center square of about 1200x1200 px. The image may be cropped around the center square. You can also use larger images with similar proportions.

### Installation

    $ sudo npm install cordova-splash -g

If you are using an older version of cordova (before 7.x):

    $ sudo npm install cordova-splash@0.12.0 -g

### Requirements

- ImageMagick installed (*Mac*: `brew install imagemagick`, *Debian/Ubuntu*: `sudo apt-get install imagemagick`, *Windows*: [See here, install "Legacy tools"](http://www.imagemagick.org/script/binary-releases.php#windows))
- 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 a `splash.png` file in the root folder of your cordova project and run:

    $ cordova-splash

You also can specify manually a location for your `config.xml` or `splash.png`:

    $ cordova-splash --config=config.xml --splash=splash.png

If you run a old version of Cordova for iOS and you need your files in `/Resources/icons/`, use this option:

    $ cordova-splash --xcode-old

#### 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 `<splash src="res/screen/android/splash-land-mdpi.png" density="land-mdpi"/>`

### Icons

Check out [cordova-icon](https://github.com/AlexDisler/cordova-icon)

### License

MIT

---
_Source: https://npm.io/package/cordova-splash · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._