Socket
Socket
Sign inDemoInstall

@plaindevelopment/sharkycanvas

Package Overview
Dependencies
2
Maintainers
1
Versions
5
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @plaindevelopment/sharkycanvas

Module for generating images


Version published
Weekly downloads
2
increased by100%
Maintainers
1
Created
Weekly downloads
 

Readme

Source

sharkycanvas

Easily create Discord.js rank, welcome and goodbye images.
npm i @plaindevelopment/sharkycanvas

This is not something that will not be updated. This was made for the bot "Sharky" and any issues are not for me to fix.


### Dependancies
- fs
- canvas

Examples

const canvas = require("@plaindevelopment/sharkycanvas"),
rankCardCanvas = new canvas.RankCard(),
welcomeCardCanvas = new canvas.Welcome(),
goodbyeCardCanvas = new canvas.Goodbye();

// Level/Rank Card
let image = await rankCardCanvas
    .setAvatar("url") // Avatar image URL
    .setXP("current", 0) // Current XP
    .setXP("needed", 100) // XP Needed To Level Up
    .setLevel(1) // Current Level
    .setRank(1) // Current Position (1st=1, 2nd=2)
    .setRankName("Default") // Special name for that level?
    .setUsername("Susan") // Username
    .setBackground("url") // Background image url
	.setFooter("{count}th Member") // Bottom Left Text - For membercount do {count}
    
// Welcome Card
let image = await welcomeCardCanvas
  .setUsername("Susan") // Username
  .setDiscriminator(1234) // Users tag so Susan#1234 (1234)
  .setMemberCount(100) // Server member count
  .setGuildName("PD Server") // Server name
  .setAvatar("url") // Avatar image URL
  .setColor("border", "#8015EA") // Only mess with these if you know colour codes!
  .setColor("username-box", "#8015EA")
  .setColor("discriminator-box", "#8015EA")
  .setColor("message-box", "#8015EA")
  .setColor("title", "#8015EA")
  .setColor("avatar", "#8015EA")
  .setBackground("url") // Background image url

// Goodbye Card
let image = await goodbyeCardCanvas
  .setUsername("Susan") // Username
  .setDiscriminator(1234) // Users tag so Susan#1234 (1234)
  .setMemberCount(100) // Server member count
  .setGuildName("PD Server") // Server name
  .setAvatar("url") // Avatar image URL
  .setColor("border", "#8015EA") // Only mess with these if you know colour codes!
  .setColor("username-box", "#8015EA")
  .setColor("discriminator-box", "#8015EA")
  .setColor("message-box", "#8015EA")
  .setColor("title", "#8015EA")
  .setColor("avatar", "#8015EA")
  .setBackground("url") // Background image url
  
/*
To send any of these as a discord attachment:
After all options put
*/
.toAttachment();
const attachment = new Discord.MessageAttachment(image.toBuffer(), "welcome-image.png");
// Then just do
message.channel.send(attachment);

FAQs

Last updated on 01 Aug 2021

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc