# Stickers-Formatter
**Create and format WhatsApp Stickers with ease.**
A feature-rich fork of [wa-sticker-formatter](https://github.com/AlenVelocity/wa-sticker-formatter)
[](https://github.com/GlobalTechInfo/stickers-formatter/blob/main/LICENSE)
[](https://www.codefactor.io/repository/github/GlobalTechInfo/stickers-formatter)
[](https://npmjs.com/package/stickers-formatter)
[](https://npmjs.com/package/stickers-formatter)
[](https://github.com/GlobalTechInfo/stickers-formatter/attestations)
---
## ✨ Features
- 🖼️ Supports **static images**, **GIFs**, and **Videos** (animated WebP output)
- 🎨 Custom **backgrounds**, **types**, and **categories**
- 🔗 Fluent **method chaining** API
- 📦 **Baileys-MD** compatible output
- 🔍 **Metadata extraction** from existing stickers
- 📐 Multiple sticker **types**: Default, Crop, Full, Circle, Rounded
- 🖋️ **SVG** input support
---
## 📦 Installation
```bash
npm i stickers-formatter
```
---
## 🚀 Quick Start
```ts
import { Sticker, StickerTypes } from 'stickers-formatter'
const sticker = new Sticker('./image.png', {
pack: 'My Pack',
author: 'Me',
type: StickerTypes.FULL,
})
const buffer = await sticker.toBuffer()
```
---
## 📥 Import
```ts
import { Sticker, createSticker, StickerTypes } from 'stickers-formatter' // ES6
// const { Sticker, createSticker, StickerTypes } = require('stickers-formatter') // CommonJS
```
---
## 📖 Usage
Stickers-Formatter provides two ways to create stickers — the `Sticker` class and the `createSticker` function. Both accept the same parameters:
| Parameter | Type | Description |
|-----------|------|-------------|
| `image` | `Buffer \| string` | Buffer, URL, SVG string, or file path. GIFs and videos produce animated WebP. |
| `options` | `IStickerOptions` | Configuration object (see [Options](#%EF%B8%8F-options)) |
---
### 🏗️ Using the `Sticker` Class (Recommended)
```ts
const sticker = new Sticker(image, {
pack: 'My Pack',
author: 'Me',
type: StickerTypes.FULL,
categories: ['🤩', '🎉'],
id: '12345',
quality: 50,
background: '#000000'
})
const buffer = await sticker.toBuffer()
await sticker.toFile('sticker.webp')
sock.sendMessage(jid, await sticker.toMessage())
```
#### Method Chaining
```ts
const buffer = await new Sticker(image)
.setPack('My Pack')
.setAuthor('Me')
.setType(StickerTypes.FULL)
.setCategories(['🤩', '🎉'])
.setID('12345')
.setBackground('#000000')
.setQuality(50)
.toBuffer()
```
#### SVG Input
```ts
const sticker = new Sticker(`
