npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

meta-discord

v0.0.2

Published

Customized cards with Discord style

Downloads

6

Readme

Image generation tools for Discord.JS / Node.JS

📦 Installation

npm i meta-discord@latest

🖼️ Cards

🔘 profileImage(userId, imgOptions)

Description: Generates the card of a user/bot, with its badges.

PARAMETER | TYPE | REQUIRED | DESCRIPTION -------- | --------- | -------- | -------- userId| string | ✔️ | Discord User ID imgOptions| object | ✖️ | Customize the card in multiple ways

🔴 imgOptions

PARAMETER | TYPE | DEFAULT | DESCRIPTION -------- | --------- | -------- | -------- customTag| string | ✖️ | Text below the user customBadges| string[] | ✖️ | Your own png badges path and URL customBackground| string | ✖️ | Change the background to any image path and URL overwriteBadges| boolean | false | Merge your badges with the discord defaults badgesFrame| boolean | false | Creates a small frame behind the badges removeBadges| boolean | false | Removes badges, whether custom or from discord usernameColor| string | ✖️ | Username HEX color tagColor| string | ✖️ | Tag HEX color borderColor| string or string[] | ✖️ | Border HEX color, can be gradient if 2 colors are used borderAllign| string | horizontal | Gradient alignment if 2 colors are used presenceStatus| string | ✖️ | User status to be displayed below the avatar squareAvatar| boolean | false | Change avatar shape to a square

📃 Discord.js v14 Example

const { AttachmentBuilder } = require('discord.js');
const { profileImage } = require('meta-discord');
await interaction.deferReply();
const user = interaction.options.getUser('user-option');
const buffer = await profileImage(user.id, {
  customTag: 'Admin',
  ...imgOptions
});
const attachment = new AttachmentBuilder(buffer, { name: 'profile.png' });
interaction.followUp({ files: [attachment] });
client.on("channelCreate", (channel) => {
    console.log(`${channel} has been created`)
})

1️] Example One

Default

profileImage('ID')

2] Example Two

Default

profileImage('ID', {
 customTag: 'Minecraft Modder',
 customBadges: [ './badges/booster.png','./badges/orange.png', './badges/giveaway.png' ],
 overwriteBadges: false,
 usernameColor: '#d9dfef',
 borderColor: ['#f90257', '#043a92'],
 presenceStatus: 'idle',
 squareAvatar: true
});

3] Example Three [Bot]

Default

profileImage('ID', {
 customTag: 'Minecraft Bot',
 customBackground: './imgs/axoBackground.png',
 usernameColor: '#ffbddf',
 borderColor: '#fe6a90',
 presenceStatus: 'online',
 squareAvatar: true
});

🔘 profileImage(userId, imgOptions)

Description: Generates the rank card of a user/bot, with its badges.

PARAMETER | TYPE | REQUIRED | DESCRIPTION -------- | --------- | -------- | -------- userId| string | ✔️ | Discord User ID imgOptions| object | ✖️ | Customize the card in multiple ways

🔴 imgOptions

PARAMETER | TYPE | DEFAULT | DESCRIPTION -------- | --------- | -------- | -------- customTag| string | ✖️ | Text below the user customBadges| string[] | ✖️ | Your own png badges path and URL customBackground| string | ✖️ | Change the background to any image path and URL overwriteBadges| boolean | false | Merge your badges with the discord defaults badgesFrame| boolean | false | Creates a small frame behind the badges removeBadges| boolean | false | Removes badges, whether custom or from discord usernameColor| string | ✖️ | Username HEX color tagColor| string | ✖️ | Tag HEX color borderColor| string or string[] | ✖️ | Border HEX color, can be gradient if 2 colors are used borderAllign| string | horizontal | Gradient alignment if 2 colors are used presenceStatus| string | ✖️ | User status to be displayed below the avatar squareAvatar| boolean | false | Change avatar shape to a square rankData| object | ✖️ | Input users rank data

🔴 rankData

PARAMETER | TYPE | DEFAULT | DESCRIPTION -------- | --------- | -------- | -------- currentXp| number | ✖️ | Current user XP requiredXp| number | ✖️ | XP required to level up level| number | ✖️ | Current user level rank| number | ✖️ | Position on the leaderboard barColor| string | ✖️ | HEX XP bar color

📃 Discord.js v14 Example

const { AttachmentBuilder } = require('discord.js');
const { profileImage } = require('meta-discord');
await interaction.deferReply();
const user = interaction.options.getUser('user-option');
const buffer = await profileImage(user.id, {
  rankData: {
    currentXp: 2100,
    requiredXp: 3000,
    rank: 10,
    level: 20,
    barColor: '0b7b95'
  },
  ...imgOptions
});
const attachment = new AttachmentBuilder(buffer, { name: 'profile.png' });
interaction.followUp({ files: [attachment] });
client.on("channelCreate", (channel) => {
    console.log(`${channel} has been created`)
})

1️] Example

Default

profileImage('UserID', {
 customBadges: [  './skull.png', './letter.png', './rocket.png', './crown.png', './hearth.png'  ],
 borderColor: '#087996',
 presenceStatus: 'dnd',
 badgesFrame: true,
 rankData: {
   currentXp: 2100,
   requiredXp: 3000,
   rank: 10,
   level: 20,
   barColor: '0b7b95'
 }
});

🔘 welcomeImage(userId,serverName, imgOptions)

Description: Generates the welcome/leave card of a user/bot.

PARAMETER | TYPE | REQUIRED | DESCRIPTION -------- | --------- | -------- | -------- userId| string | ✔️ | Discord User ID serverName| string | ✔️ | Discord Server Name imgOptions| object | ✖️ | Customize the card in multiple ways

🔴 imgOptions

PARAMETER | TYPE | DEFAULT | DESCRIPTION -------- | --------- | -------- | -------- leave| string | false | Change to welcome or leave image customBackground| string | ✖️ | Change the background to any image path and URL usernameColor| string | ✖️ | Username HEX color Color| string | ✖️ | Text HEX color borderColor| string or string[] | ✖️ | Border HEX color, can be gradient if 2 colors are used borderAllign| string | horizontal | Gradient alignment if 2 colors are used presenceStatus| string | ✖️ | User status to be displayed below the avatar squareAvatar| boolean | false | Change avatar shape to a square

📃 Discord.js v14 Example

const { AttachmentBuilder } = require('discord.js');
const { welcomeImage } = require('meta-discord');
await interaction.deferReply();
const user = interaction.options.getUser('user-option');
const buffer = await welcomeImage(user.id,'Server Name',{
   leave:true,     //if leave image
  ...imgOptions
});
const attachment = new AttachmentBuilder(buffer, { name: 'profile.png' });
interaction.followUp({ files: [attachment] });
client.on("channelCreate", (channel) => {
    console.log(`${channel} has been created`)
})

1️] Example One [Welcome Card]

Default

welcomeImage('UserID','Meta Development');

2] Example One [Leave Card]

Default

welcomeImage('UserID','Meta Development',{
 leave: true
});

3] Example Two [Welcome Card]

Default

welcomeImage('UserID','Meta Development',{
     borderColor: '#5663EC',
     presenceStatus: 'dnd',
     squareAvatar: true
   });

4] Example Two [Leave Card]

Default

welcomeImage('UserID','Meta Development',{
     borderColor: '#5663EC',
     presenceStatus: 'dnd',
     squareAvatar: true,
     leave: true
   });

Requirements

  • Basic knowledge on JavaScript
  • Basic knowledge on Discord.JS (v14)
  • Basic knowledge on Node.JS

Credits