-
Notifications
You must be signed in to change notification settings - Fork 25
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated dependencies and invalid thumbnail handler.
- Loading branch information
Showing
1 changed file
with
211 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,211 @@ | ||
<img src="https://ik.imagekit.io/unburn/Musicard.svg" /> | ||
|
||
<p align="center">Musicard is one of the best canvas libraries to create a variety of music cards.</p> | ||
|
||
<p align="center"> | ||
<a href="https://github.com/unburn/musicard/"><b>Github</b></a> • | ||
<a href="https://discord.gg/66uGX7t4ww"><b>Support</b></a> | ||
</p> | ||
|
||
<div align="center"> | ||
|
||
[![NPM Version](https://img.shields.io/npm/v/musicard?style=flat-square&color=%23FF7A00)](https://www.npmjs.com/package/musicard) | ||
[![NPM Downloads](https://img.shields.io/npm/dw/musicard?style=flat-square&color=%23FF7A00)](https://www.npmjs.com/package/musicard) | ||
[![NPM License](https://img.shields.io/npm/l/musicard?style=flat-square&color=%23FF7A00)](https://github.com/unburn/musicard/blob/main/LICENSE) | ||
[![GitHub Repo stars](https://img.shields.io/github/stars/unburn/musicard?style=flat-square&color=%23FF7A00)](https://github.com/unburn/musicard) | ||
|
||
</div> | ||
|
||
<div align="center"> | ||
<a href="https://github.com/sponsors/flameface"><img src="https://ik.imagekit.io/unburn/SupportMusicard.svg"/></a> | ||
</div> | ||
|
||
# Installation | ||
```js | ||
// using npm | ||
npm install musicard | ||
|
||
// using yarn | ||
yarn add musicard | ||
``` | ||
|
||
# Usage | ||
You can use the Musicard package in your Discord bots, websites, etc. | ||
|
||
## Using Create File | ||
```js | ||
(async () => { | ||
const { Classic } = require("musicard"); | ||
const fs = require("fs") | ||
|
||
const musicard = await Classic({ }); | ||
|
||
// Creates PNG file | ||
fs.writeFileSync("musicard.png", musicard); | ||
})() | ||
``` | ||
|
||
## Using Discord Bot | ||
```js | ||
const { Classic } = require("musicard"); | ||
const fs = require("fs") | ||
|
||
const musicard = await Classic({}); | ||
|
||
... | ||
|
||
return message.channel.send({ | ||
files: [{ | ||
attachment: musicard | ||
}] | ||
}) | ||
``` | ||
|
||
# Themes | ||
Musicard is the #1 canvas library to create music cards with awesome themes. | ||
|
||
## Classic | ||
|
||
![classic](https://ik.imagekit.io/unburn/Classic.svg) | ||
|
||
```js | ||
(async () => { | ||
const { Classic } = require("musicard"); | ||
const fs = require("fs") | ||
|
||
const musicard = await Classic({ | ||
thumbnailImage: "https://lh3.googleusercontent.com/yavtBZZnoxaY21GSS_VIKSg0mvzu1b0r6arH8xvWVskoMaZ5ww3iDMgBNujnIWCt7MOkDsrKapSGCfc=w544-h544-l90-rj", | ||
backgroundColor: "#070707", | ||
progress: 10, | ||
progressColor: "#FF7A00", | ||
progressBarColor: "#5F2D00", | ||
name: "Burn", | ||
nameColor: "#FF7A00", | ||
author: "By 2WEI & Edda Hayes", | ||
authorColor: "#696969", | ||
startTime: "0:00", | ||
endTime: "4:00", | ||
timeColor: "#FF7A00" | ||
}); | ||
|
||
fs.writeFileSync("musicard.png", musicard); | ||
})() | ||
``` | ||
|
||
*** | ||
|
||
## Classic Pro | ||
|
||
![classicpro](https://ik.imagekit.io/unburn/ClassicPro.svg) | ||
|
||
```js | ||
(async () => { | ||
const { ClassicPro } = require("musicard"); | ||
const fs = require("fs") | ||
|
||
const musicard = await ClassicPro({ | ||
thumbnailImage: "https://lh3.googleusercontent.com/yavtBZZnoxaY21GSS_VIKSg0mvzu1b0r6arH8xvWVskoMaZ5ww3iDMgBNujnIWCt7MOkDsrKapSGCfc=w544-h544-l90-rj", | ||
backgroundColor: "#070707", | ||
progress: 10, | ||
progressColor: "#FF7A00", | ||
progressBarColor: "#5F2D00", | ||
name: "Burn", | ||
nameColor: "#FF7A00", | ||
author: "By 2WEI & Edda Hayes", | ||
authorColor: "#696969", | ||
startTime: "0:00", | ||
endTime: "4:00", | ||
timeColor: "#FF7A00" | ||
}); | ||
|
||
fs.writeFileSync("musicard.png", musicard); | ||
})() | ||
``` | ||
|
||
*** | ||
|
||
## Dynamic | ||
|
||
![dynamic](https://ik.imagekit.io/unburn/Dynamic.svg) | ||
|
||
```js | ||
(async () => { | ||
const { Dynamic } = require("musicard"); | ||
const fs = require("fs") | ||
|
||
const musicard = await Dynamic({ | ||
thumbnailImage: "https://lh3.googleusercontent.com/yavtBZZnoxaY21GSS_VIKSg0mvzu1b0r6arH8xvWVskoMaZ5ww3iDMgBNujnIWCt7MOkDsrKapSGCfc=w544-h544-l90-rj", | ||
backgroundColor: "#070707", | ||
progress: 10, | ||
progressColor: "#FF7A00", | ||
progressBarColor: "#5F2D00", | ||
name: "Burn", | ||
nameColor: "#FF7A00", | ||
author: "By 2WEI & Edda Hayes", | ||
authorColor: "#696969" | ||
}); | ||
|
||
fs.writeFileSync("musicard.png", musicard); | ||
})() | ||
``` | ||
|
||
*** | ||
|
||
## Mini | ||
|
||
![mini](https://ik.imagekit.io/unburn/Mini.svg) | ||
|
||
```js | ||
(async () => { | ||
const { Mini } = require("musicard"); | ||
const fs = require("fs") | ||
|
||
const musicard = await Mini({ | ||
thumbnailImage: "https://lh3.googleusercontent.com/yavtBZZnoxaY21GSS_VIKSg0mvzu1b0r6arH8xvWVskoMaZ5ww3iDMgBNujnIWCt7MOkDsrKapSGCfc=w544-h544-l90-rj", | ||
backgroundColor: "#070707", | ||
progress: 10, | ||
progressColor: "#FF7A00", | ||
progressBarColor: "#5F2D00", | ||
menuColor: "#FF7A00", | ||
paused: false | ||
}); | ||
|
||
fs.writeFileSync("musicard.png", musicard); | ||
})() | ||
``` | ||
|
||
*** | ||
|
||
## Mini Pro | ||
|
||
![minipro](https://ik.imagekit.io/unburn/MiniPro.svg) | ||
|
||
```js | ||
(async () => { | ||
const { MiniPro } = require("musicard"); | ||
const fs = require("fs") | ||
|
||
const musicard = await MiniPro({ | ||
thumbnailImage: "https://lh3.googleusercontent.com/yavtBZZnoxaY21GSS_VIKSg0mvzu1b0r6arH8xvWVskoMaZ5ww3iDMgBNujnIWCt7MOkDsrKapSGCfc=w544-h544-l90-rj", | ||
backgroundColor: "#070707", | ||
progress: 10, | ||
progressColor: "#FF7A00", | ||
progressBarColor: "#5F2D00", | ||
name: "Burn", | ||
nameColor: "#FF7A00", | ||
author: "By 2WEI & Edda Hayes", | ||
authorColor: "#696969" | ||
}); | ||
|
||
fs.writeFileSync("musicard.png", musicard); | ||
})() | ||
``` | ||
|
||
# Resource | ||
Pull request to add your project here. | ||
|
||
| Riffy Music Bot | https://github.com/riffy-team/riffy-music-bot | | ||
| --------------- | --------------------------------------------- | | ||
|
||
# Licence | ||
[GPL](https://github.com/unburn/musicard/blob/main/LICENSE) |