Fixed type error and added cutom background example.

unburn · Mar 21, 2024 · 845079f · 845079f
1 parent 1416631
commit 845079f
Show file tree

Hide file tree

Showing 7 changed files with 50 additions and 6 deletions.
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "musicard",
-    "version": "2.0.4",
+    "version": "2.0.5",
     "description": "Musicard is one of the best canvas libraries to create a variety of music cards.",
     "main": "./dist/index.js",
     "module": "./dist/index.mjs",
@@ -22,7 +22,7 @@
         "deploy": "npm publish",
         "deploy:beta": "npm publish --tag beta",
         "test:m": "cd tests && node index.mjs",
-        "test:c": "cd tests && node --watch index.js"
+        "test:c": "cd tests && node index.js"
     },
     "keywords": [
         "musicard",

diff --git a/readme.md b/readme.md
@@ -63,6 +63,27 @@ return message.channel.send({
 })
 ```
 
+## Custom Background (New)
+Use a custom image background and also adjust the darkness of the image.
+```js
+import { Classic } from "musicard";
+import fs from 'fs'
+
+Classic({
+    thumbnailImage: "https://cdn.discordapp.com/attachments/1220001571228880917/1220001571690123284/01.png?ex=660d5a01&is=65fae501&hm=a8cfb44844e61aa0fd01767cd363af048df28966c30d7b04a59f27fa45cf69c4&",
+    backgroundImage: "https://cdn.discordapp.com/attachments/1220001571228880917/1220001571690123284/01.png?ex=660d5a01&is=65fae501&hm=a8cfb44844e61aa0fd01767cd363af048df28966c30d7b04a59f27fa45cf69c4&",
+    imageDarkness: 60,
+    nameColor: "#DC92FF",
+    progressColor: "#DC92FF",
+    progressBarColor: "#2B2B2B",
+    progress: 50
+}).then(x => {
+    fs.writeFileSync("output.png", x)
+})
+```
+
+![custom](https://ik.imagekit.io/unburn/custom-output.png?updatedAt=1710995171966)
+
 # Themes
 Musicard is the #1 canvas library to create music cards with awesome themes.
 

diff --git a/tests/index.js b/tests/index.js
@@ -1,6 +1,14 @@
 const { Classic } = require("musicard");
 const fs = require('fs')
 
-Classic({}).then(x => {
+Classic({
+    thumbnailImage: "https://cdn.discordapp.com/attachments/1220001571228880917/1220001571690123284/01.png?ex=660d5a01&is=65fae501&hm=a8cfb44844e61aa0fd01767cd363af048df28966c30d7b04a59f27fa45cf69c4&",
+    backgroundImage: "https://cdn.discordapp.com/attachments/1220001571228880917/1220001571690123284/01.png?ex=660d5a01&is=65fae501&hm=a8cfb44844e61aa0fd01767cd363af048df28966c30d7b04a59f27fa45cf69c4&",
+    imageDarkness: 60,
+    nameColor: "#DC92FF",
+    progressColor: "#DC92FF",
+    progressBarColor: "#2B2B2B",
+    progress: 50
+}).then(x => {
     fs.writeFileSync("output.png", x)
 })
diff --git a/tests/index.mjs b/tests/index.mjs
@@ -0,0 +1,14 @@
+import { Classic } from "musicard";
+import fs from 'fs'
+
+Classic({
+    thumbnailImage: "https://cdn.discordapp.com/attachments/1220001571228880917/1220001571690123284/01.png?ex=660d5a01&is=65fae501&hm=a8cfb44844e61aa0fd01767cd363af048df28966c30d7b04a59f27fa45cf69c4&",
+    backgroundImage: "https://cdn.discordapp.com/attachments/1220001571228880917/1220001571690123284/01.png?ex=660d5a01&is=65fae501&hm=a8cfb44844e61aa0fd01767cd363af048df28966c30d7b04a59f27fa45cf69c4&",
+    imageDarkness: 60,
+    nameColor: "#DC92FF",
+    progressColor: "#DC92FF",
+    progressBarColor: "#2B2B2B",
+    progress: 50
+}).then(x => {
+    fs.writeFileSync("output.png", x)
+})
diff --git a/tests/output.png b/tests/output.png
diff --git a/tsconfig.json b/tsconfig.json
@@ -1,7 +1,8 @@
 {
   "compilerOptions": {
-    "target": "ES2016",
-    "module": "CommonJS",
+    "target": "ESNext",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
     "esModuleInterop": true,
     "strict": true,
     "outDir": "dist",

diff --git a/tsup.config.ts b/tsup.config.ts
@@ -6,5 +6,5 @@ export default defineConfig({
     dts: true,
     shims: true,
     skipNodeModulesBundle: true,
-    clean: ['./src/index.ts']
+    clean: true
 });