Welcomify NPM | npm.io

🏠 Homepage

Install

npm i welcomify

Usage

This example code will create a welcome card and save it as a png.

(async () => {
  // Importing modules
  const { Card } = require("welcomify");
  const fs = require("fs");

  // Card details here
  const card = new Card()
    .setName("Shiorii")
    .setAvatar(
      "https://raw.githubusercontent.com/Shiioriii/Welcomify/main/assets/avatar.png"
    )
    .setMessage("YOU ARE 300 MEMBERS!")
    .setBackground('https://raw.githubusercontent.com/Shiioriii/Welcomify/main/assets/background.jpg')
    .setColor("00FF38") // without #
    .setTitle("Welcome");

  // Building process
  const cardoutput = await card.build();

  // Save as image
  fs.writeFileSync("cardout.png", cardoutput);
  console.log("Done");
})();

Example For Discord.js Bot Used

// Importing modules
const { Card } = require("welcomify");
const { AttachmentBuilder } = require("discord.js");

// Make sure to define client
client.on("guildMemberAdd", async (member) => {
  // Card details here
  const card = new Card()
    .setName("Shiorii")
    .setAvatar(
      "https://raw.githubusercontent.com/Shiioriii/Welcomify/main/assets/avatar.png"
    )
    .setMessage("YOU ARE 300 MEMBER!")
    .setBackground('https://raw.githubusercontent.com/Shiioriii/Welcomify/main/assets/background.jpg')
    .setColor("00FF38") // without #
    .setTitle("Welcome");

  // Building process
  const cardoutput = await card.build();

  // Fetch channel from members guild using ID
  const channel = member.guild.channels.cache.get("0000000000000000000");

  // Sends card to the "channel"
  await channel.send({
    files: [
      {
        attachment: cardoutput,
        name: `${member.id}.png`,
      },
    ],
  });
});