Image generation tools for Discord.JS / Node.JS
📦 Installation
npm i meta-discord@latest
🖼️ Cards
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
profileImage('ID')
2] Example Two
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
profileImage('ID', {
customTag: 'Minecraft Bot',
customBackground: './imgs/axoBackground.png',
usernameColor: '#ffbddf',
borderColor: '#fe6a90',
presenceStatus: 'online',
squareAvatar: true
});
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
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'
}
});
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`)
})
welcomeImage('UserID','Meta Development');
welcomeImage('UserID','Meta Development',{
leave: true
});
welcomeImage('UserID','Meta Development',{
borderColor: '#5663EC',
presenceStatus: 'dnd',
squareAvatar: true
});
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