Skip to content

Latest commit

 

History

History
136 lines (109 loc) · 4.57 KB

README.md

File metadata and controls

136 lines (109 loc) · 4.57 KB

Futuristic welcome card canvas library

Github • Support

NPM Version NPM Downloads NPM License GitHub Repo stars

Installation

npm install greetify

Usage

Using File System (FS)

import { Panorama } from "greetify";
import fs from "fs";

// OR

const { Panorama } = require("greetify");
const fs = require('fs')

Panorama({
    avatar: "https://cdn.discordapp.com/avatars/786504767358238720/f65e8322c0c290e7fc1d9ad20322256b.webp",
    name: "FLAMEFACE",
    type: "WELCOME",
}).then(x => {
    fs.writeFileSync("greetify.png", x)
})

In Discord Bot

// Assuming you defined client
const { Minimal } = require("greetify");

client.on("guildMemberAdd", async member => {
    const message = `YOU ARE ${member.guild.memberCount}TH MEMBER`

    const card = await Minimal({
        name: member.user.username,
        avatar: member.user.displayAvatarURL({
            size: 4096 // For High Res Avatar
        }),
        type: "WELCOME",
        message: message
    })

    const channel = member.guild.channels.cache.get("1201155869610627212");

    return channel.send({
        files: [{
            attachment: card
        }]
    })
})

Themes

Minimal

minimal

const { Minimal } = require("greetify");
const fs = require('fs')

Minimal({
    avatar: "https://cdn.discordapp.com/avatars/786504767358238720/f65e8322c0c290e7fc1d9ad20322256b.webp",
    name: "FLAMEFACE",
    type: "WELCOME",
    message: "YOUR ARE 100TH MEMBER"
}).then(x => {
    fs.writeFileSync("greetify.png", x)
})

Minimal Options

Parameters Types Default
avatar* string none
backgroundImage string https://ik.imagekit.io/unburn/greetify-default.png
circleBorder boolean false
message* string none
messageColor string #FFFFFF
name* string none
nameColor string #00FF9E
type string WELCOME
typeColor string #FFFFFF

Panorama

panorama

const { Panorama } = require("greetify");
const fs = require('fs')

Panorama({
    avatar: "https://cdn.discordapp.com/avatars/786504767358238720/f65e8322c0c290e7fc1d9ad20322256b.webp",
    name: "FLAMEFACE",
    type: "WELCOME"
}).then(x => {
    fs.writeFileSync("greetify.png", x)
})

Panorama Options

Parameters Types Default
avatar* string none
backgroundImage string https://ik.imagekit.io/unburn/greetify-default.png
circleBorder boolean false
name* string none
nameColor string #00FF9E
type string WELCOME
typeColor string #FFFFFF

Licence

GPL