🚀 StickEngine

O StickEngine é um motor de alta performance para criação de figurinhas do WhatsApp, projetado para ser simples para iniciantes e extremamente poderoso para desenvolvedores avançados.

📦 1. Começando (Básico)

Instalação

npm install @boruto_vk7/stickengine

Requisito: Tenha o ffmpeg instalado no seu sistema.

Suporte Híbrido

O módulo funciona tanto com ESM quanto CommonJS:

• ESM: import StickEngine from '@boruto_vk7/stickengine';
• CJS: const StickEngine = require('@boruto_vk7/stickengine').default;

Sua Primeira Figurinha

Gere uma figurinha com apenas 3 linhas de código:

const engine = new StickEngine();
engine.addFile('./foto.jpg'); // Adiciona a imagem
const results = await engine.start(); // Inicia o processamento
console.log('Sticker salvo em:', results[0].value);

🛠️ 2. Personalizando (Intermediário)

Adicionando Nome e Autor (Metadados)

Personalize as informações que aparecem quando alguém clica na figurinha no WhatsApp.

const engine = new StickEngine({
  metadata: {
    pack: 'Meu Pack Incrível',
    author: 'Borutovk7'
  }
});

Figurinhas Animadas (GIF e Vídeo)

O motor detecta automaticamente se o arquivo é animado. Ele corta para 6 segundos e garante que o arquivo tenha menos de 1MB.

engine.addFile('./video_engracado.mp4');
engine.addFile('./dancinha.gif');
await engine.start();

🎨 3. Efeitos Especiais (Avançado)

Recorte Circular e Filtros

Transforme imagens quadradas em círculos e aplique filtros profissionais.

const engine = new StickEngine({
  edit: {
    circle: true,     // Recorte circular
    sepia: true,      // Filtro antigo
    brightness: 0.2   // Aumenta o brilho
  }
});

Legendas com Borda (Meme Style)

Adicione texto que pode ser lido em qualquer fundo graças ao contorno (stroke).

const engine = new StickEngine({
  edit: {
    text: {
      content: 'QUEBRADO!',
      color: 'WHITE',
      stroke: true // Adiciona borda preta ao texto branco
    }
  }
});

💎 4. Funções Profissionais (Expert)

Texto para Figurinha (TP)

Gere figurinhas de frases do zero, sem precisar de uma imagem de base.

const path = await engine.createTextSticker("ESSA É TOP!", { 
  color: 'WHITE',
  background: 0x00000000 // Transparente
});

Criando Ícone do Pacote (Tray Icon)

Gere o ícone de bandeja (96x96) necessário para pacotes oficiais.

const trayPath = await engine.createTrayIcon('./logo.png');

Auto-Dimensionamento Inteligente

O motor reduz automaticamente a qualidade e o FPS se a figurinha animada passar de 1MB, garantindo que ela sempre seja enviada com sucesso.

📑 5. Referência Técnica Completa

Opções do Construtor (StickEngineOptions)

| Propriedade | Tipo | Padrão | Descrição | | :--- | :--- | :--- | :--- | | quality | Number | 80 | Qualidade do WebP (1-100). | | fps | Number | 15 | Frames por segundo para animados. | | autoClean | Boolean | true | Apaga temporários automaticamente. |

Opções de Edição (JimpOptions)

| Opção | Descrição | | :--- | :--- | | circle | Ativa o recorte circular. | | brightness | Ajusta o brilho (-1 a 1). | | contrast | Ajusta o contraste (-1 a 1). | | blur | Aplica desfoque. | | text.stroke | Adiciona contorno ao texto. |

🤝 Créditos

Desenvolvido por Borutovk7.

📄 Licença

ISC