Custom Cards

Un simple módulo de manipulación de imágenes con Canvas, escrito en TypeScript.

Tabla de contenido

• Instalación
• Importar Módulo
• Uso básico
• Detalles del proyecto

Instalación

npm install custom-cards

Uso

Importar módulo

A partir de la versión 1.6.0 el módulo pasó a ser un ESM, por lo que usarlo con CommonJs puede llegar a dar problemas inesperados.

import * as CustomCards from "custom-cards";

Uso básico

import { readFileSync } from "node:fs";

// Leemos una imágen local
const wpBuf = readFileSync("./wallpaper.jpg");

// Inicializamos el cliente (reemplazamos TOKEN por nuestro token)
const client = new CustomCards.Setup("TOKEN");

// Creamos el modelo de nuestra tarjeta
const card = new CustomCards.WelcomeCard({
  variant: "Classic",
  avatar: {
    // usamos "imageUrlAdapter" para usar imágenes desde una URL
    source: await CustomCards.imageUrlAdapter(
      "https://yumikodev.vercel.app/avatar.webp"
    ),
    frameColor: "#ff7eae",
    frameType: CustomCards.FrameType.Square,
  },
  background: await CustomCards.imageBufferAdapter(wpBuf),
  font: CustomCards.Fonts.Fredoka,
  text: [
    {
      content: "Bienvenid@ usuario",
      color: "#fff",
    },
    {
      content: "Descripción aquí.",
      color: "#eee",
    },
  ],
});

const data = await client.cards.createWelcomeCard(card);
console.log(data);
/*
{
  "mimetype": "image/webp",
  "card": Buffer<...>
}
*/

Ejemplo:

Detalles del proyecto:

• Licencia: MIT License
• Autor: Yasu Yumiko
• Servidor de Discord
• Documentación oficial

Gracias :D