Skip to content
forked from unburn/greetify

Greetify is futuristic welcome card canvas library

License

Notifications You must be signed in to change notification settings

HighError/greetify

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Futuristic welcome card canvas library

GithubSupport

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

About

Greetify is futuristic welcome card canvas library

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 90.9%
  • JavaScript 9.1%