Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alenvelocity/wa-sticker-formatter
Sticker Creator for WhatsApp
https://github.com/alenvelocity/wa-sticker-formatter
exif image nodejs png sharp sticker wa-sticker-formatter webp whatsapp-stickers
Last synced: about 15 hours ago
JSON representation
Sticker Creator for WhatsApp
- Host: GitHub
- URL: https://github.com/alenvelocity/wa-sticker-formatter
- Owner: AlenVelocity
- License: mit
- Created: 2021-03-20T13:56:06.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-02-23T14:29:00.000Z (7 months ago)
- Last Synced: 2024-05-12T23:23:01.287Z (5 months ago)
- Topics: exif, image, nodejs, png, sharp, sticker, wa-sticker-formatter, webp, whatsapp-stickers
- Language: TypeScript
- Homepage: https://alensaito1.github.io/wa-sticker-formatter/
- Size: 12.3 MB
- Stars: 92
- Watchers: 4
- Forks: 41
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Wa-Sticker-Formatter
Wa-Sticker-Formatter is a simple tool which allows you to create and format WhatsApp Stickers.
[](https://github.com/AlenVelocity/wa-sticker-formatter/blob/master/LICENSE) [](https://www.codefactor.io/repository/github/AlenVelocity/wa-sticker-formatter) [](https://npmjs.com/package/wa-sticker-formatter)
# Installation
```cmd
> npm i wa-sticker-formatter
```
# Usage
Wa-Sticker-Formatter provides two ways to create stickers.
The paramers are the same for both.
1. First is the Buffer, SVG String, URL, SVG String or File path of static image, GIF or Video. The second is the options. GIFs and Videos will output an animated WebP file.
2. 2nd Paramter, an object, Sticker Options accepts the following fields
`pack` - The pack name.
`author` - The author name.
`type` - Value from StickeTypes enum (exported). Can be 'crop' or 'full' or undefined (default).
`categories` - The sticker category. Can be an array of Emojis or undefined (default).
`quality` - The quality of the output file. Can be an integer from 0 to 100. Defaults to 100.
`id` - The sticker id. If this property is not defined, it will be generated.
`background` - Background color in hexadecimal format or an RGBA Object. Defaults to undefined (transparent).
## Import
Before using the library, you need to import it.
```TS
import { Sticker, createSticker, StickerTypes } from 'wa-sticker-formatter' // ES6
// const { Sticker, createSticker, StickerTypes } = require('wa-sticker-formatter') // CommonJS
```
## Using The `Sticker` constructor (Recommended)
```TS
const sticker = new Sticker(image, {
pack: 'My Pack', // The pack name
author: 'Me', // The author name
type: StickerTypes.FULL, // The sticker type
categories: ['🤩', '🎉'], // The sticker category
id: '12345', // The sticker id
quality: 50, // The quality of the output file
background: '#000000' // The sticker background color (only for full stickers)
})
const buffer = await sticker.toBuffer() // convert to buffer
// or save to file
await sticker.toFile('sticker.webp')
// or get Baileys-MD Compatible Object
conn.sendMessage(jid, await sticker.toMessage())
```
You can also chain methods like this:
```TS
const buffer = await new Sticker(image)
.setPack('My Pack')
.setAuthor('Me')
.setType(StickerTypes.FULL)
.setCategories(['🤩', '🎉'])
.setId('12345')
.setBackground('#000000')
.setQuality(50)
.toBuffer()
```
The `image` (first parameter) can be a Buffer, URL, SVG string, or File path.
### SVG Example
```TS
const sticker = new Sticker(`
`, { author: 'W3' })
```
## Using the `createSticker` function
```TS
const buffer = await createSticker(buffer, options) // same params as the constructor
// NOTE: `createSticker` returns a Promise of a Buffer
```
## Options
The following options are valid:
```TS
interface IStickerConfig {
/** Sticker Pack title*/
pack?: string
/** Sticker Pack Author*/
author?: string
/** Sticker Pack ID*/
id?: string
/** Sticker Category*/
categories?: Categories[]
/** Background */
background?: Sharp.Color
/** Sticker Type */
type?: StickerTypes | string
/* Output quality */
quality?: number
}
```
## Sticker Types
Sticker types are exported as an enum.
```ts
enum StickerTypes {
DEFAULT = 'default',
CROPPED = 'crop',
FULL = 'full',
CIRCLE = 'circle,
ROUNDED = 'rounded'
}
```
## Background
Background can be a hex color string or a sharp color object.
```JSON
{
"background": "#FFFFFF"
}
```
or
```JSON
{
"background": {
"r": 255,
"g": 255,
"b": 255,
"alpha": 1
}
}
```
# Metadata
Here's some basic information about WhatsApp Sticker Metadata.
In WhatsApp, stickers have their own metadata embedded in the WebP file as They hold info like the author, the title or pack name and the category.
### 1. Author and Pack Title
The text on bold is the pack title and the rest is the author.
This is actually [Exif](https://en.wikipedia.org/wiki/Exif) Metadata embedded in the WebP file.
### 2 Sticker Category
This is an array of Emojis. [Learn More](https://github.com/WhatsApp/stickers/wiki/Tag-your-stickers-with-Emojis)
### Extracting Metadata
To extract the metadata from the WebP file, you can use the `extractMetadata()` function.
```TS
import { extractMetadata, Sticker } from 'wa-sticker-formatter'
import { readFileSync } from 'fs'
const sticker = readFileSync('sticker.webp')
let metadata = await extractMetadata(sticker) // { emojis: [], 'sticker-pack-id': '', 'sticker-pack-name': '', 'sticker-author-name': '' }
// or use the static method from the Sticker class
metadata = await Sticker.extractMetadata(sticker)
```
---
Thanks for using Wa-Sticker-Formatter!