# telegram-emoji-sprites > Create Telegram-esque emoji sprites on the fly Latest version **1.1.0** (published 2018-02-20) · MIT license · 0 weekly downloads ## Install ```sh npm install telegram-emoji-sprites pnpm add telegram-emoji-sprites yarn add telegram-emoji-sprites bun add telegram-emoji-sprites ``` Provides the command `telegram-emoji-sprites`. ## 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.1.0 | | Published | 2018-02-20 | | First published | 2018-02-07 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Node | >=4 | | Dependencies | 14 | | Unpacked size | 10.4 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Author | Raul Macarie | | Maintainers | bored | | Keywords | cli-app, cli, telegram, x, sprite, sprites, emoji, emojis | ## Links - npm: https://www.npmjs.com/package/telegram-emoji-sprites - Repository: https://github.com/bored/telegram-emoji-sprites - Homepage: https://github.com/bored/telegram-emoji-sprites#readme - Issues: https://github.com/bored/telegram-emoji-sprites/issues - npm.io page: https://npm.io/package/telegram-emoji-sprites ## Dependencies (14) - [meow](https://npm.io/package/meow.md) https://github.com/sindresorhus/meow/tarball/v4.0.0 - [pify](https://npm.io/package/pify.md) ^3.0.0 - [chalk](https://npm.io/package/chalk.md) ^2.3.0 - [listr](https://npm.io/package/listr.md) ^0.13.0 - [layout](https://npm.io/package/layout.md) ^2.2.0 - [mkdirp](https://npm.io/package/mkdirp.md) ^0.5.1 - [tinify](https://npm.io/package/tinify.md) ^1.5.0 - [p-queue](https://npm.io/package/p-queue.md) ^2.3.0 - [pretty-ms](https://npm.io/package/pretty-ms.md) ^3.1.0 - [file-exists](https://npm.io/package/file-exists.md) ^5.0.1 - [spritesmith](https://npm.io/package/spritesmith.md) ^3.3.0 - [zen-observable](https://npm.io/package/zen-observable.md) ^0.8.6 - [update-notifier](https://npm.io/package/update-notifier.md) ^2.3.0 - [telegram-emoji-map](https://npm.io/package/telegram-emoji-map.md) ^1.0.0 ## Alternatives - [babylon](https://npm.io/package/babylon.md) — 5.1M weekly downloads - [csscolorparser](https://npm.io/package/csscolorparser.md) — 3.7M weekly downloads - [expr-eval-fork](https://npm.io/package/expr-eval-fork.md) — 1.5M weekly downloads - [@leeoniya/ufuzzy](https://npm.io/package/@leeoniya/ufuzzy.md) — 247.7K weekly downloads - [xml-parser](https://npm.io/package/xml-parser.md) — 78.4K weekly downloads ## Recent versions - 1.1.0 (latest) — 2018-02-20 - 1.0.1 — 2018-02-07 - 1.0.0 — 2018-02-07 ## README # telegram-emoji-sprites [![Build Status](https://travis-ci.org/bored/telegram-emoji-sprites.svg?branch=master)](https://travis-ci.org/bored/telegram-emoji-sprites) > Create Telegram-esque emoji sprites on the fly ## Requirements Emoji images have to be: * Called with the emoji Unicode code. * If the emoji is composed by multiple characters the codes have to be separated with a hyphen (`-`). * In PNG format. * `66px` in width and `66px` in height. Examples: `1f981.png`, `1f937-1f3fc-2642.png`, etc. ## Install ``` $ npm install --global telegram-emoji-sprites ``` ## Usage ``` $ telegram-emoji-sprites --help Create Telegram-esque emoji sprites on the fly Usage $ telegram-emoji-sprites [option] [folder] Get emoji images from the current folder by default Options --destination, -d Folder where sprites will be placed, default: ./sprites --key, -k TinyPNG API key (get one from https://goo.gl/w2NaRS) ``` ## Options * `--destination ` - Set destination folder, it is created at runtime. * `--key ` - Use the provided key to authenticate requests to [TinyPNG](https://tinypng.com/)'s API. You can get one from [here](https://goo.gl/w2NaRS), it's free if you do less than 500 optimizations/month. If the option is not used no image will be compressed. * `--version` - Print the current version. * `--help` - Print the help menu. ## Example Install [GraphicsMagick](http://www.graphicsmagick.org/). Download [EmojiOne's](https://www.emojione.com) emoji set, the 64x64px one, extract it somewhere and `cd` into it, then run: ``` gm mogrify -output-directory ./emojione -bordercolor transparent -border 1x1 *.png telegram-emoji-sprites ./emojione ``` Now check out `./sprites` and enjoy. ## Changelog ### [v1.1.0](https://github.com/bored/telegram-emoji-sprites/releases/tag/v1.1.0) * ✨ - No more errors while generating sprites (not due to missing images at least 😅), files existence is checked before, adds `~50ms`. * ✨ - Sprites can be compressed before being saved on disk thanks to [TinyPNG](https://tinypng.com/)'s magic 🐼, it can save up to `~90%` in image size. * ✨ - Get update notifications, don't miss any patch or major update! * 📝 - Last but not least, `listr` output is now less verbose. ### [v1.0.1](https://github.com/bored/telegram-emoji-sprites/releases/tag/v1.0.1) * 🚑 - The CLI app was using paths relative to its installation folder, not anymore! * 🚑 - Global installation was causing an error due to `meow`, now it's installing as a tarball. ### [v1.0.0](https://github.com/bored/telegram-emoji-sprites/releases/tag/v1.0.0) * 🎉 - Initial release. ## License MIT © [Raul Macarie](http://macarie.me) --- _Source: https://npm.io/package/telegram-emoji-sprites · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._