aoi.watermark
v1.0.0
Published
A simple package for watermarking images
Downloads
2
Maintainers
Readme
aoi.watermark
🌟 This is a port of DevilsCord for aoi.js.
aoi.watermark is a simple package for watermarking images for people using aoi.js!
index.js:
const aoijs = require('aoi.js');
const bot = new aoijs.AoiClient({
token: process.env.TOKEN,
prefix: ["$getGuildVar[prefix]"],
intents: [
"Guilds",
"GuildMessages"
],
events: [
"onMessage"
]
});
+ require('./node_modules/aoi.watermark/src/func.js')(bot)
Function Usage:
$watermark[key;image;watermark]
- Key (Required) - Your Img.BB API key. To get one, click here, Login/Register and create a key!
- Image - Image URL you want to watermark.
- Watermark - Watermark URL you want to apply.
Errors:
There are three scenarios here:
- Watermark will apply successfully and it will return the URL to watermarked product.
- Provided Background Image will not be of supported types (.jpeg, .jpg, .png, .webp).
- Provided Watermark Image will not be of supported types (.jpeg, .jpg, png).
1st Case:
When the watermark is applied, It will return an Img.BB url. For example: https://i.ibb.co/Bj86cXW/bfb53095fc89.png.
2nd Case:
If the image is not of supported types, It will return Unknown Image Type
.
3rd Case:
If the watermark is not of supported types, It will return Unknown Watermark Type
.
Watermark Command Example:
module.exports = [{
name: "watermark",
code: `
$watermark[$get[key];$nonEscape[$message];$get[watermark]]
$let[key;KEY_HERE]
$let[watermark;WATERMARK_URL]
$onlyIf[$isValidLink[$message]==true;URL is invalid]
$onlyIf[$message!=;Please enter a URL]
`
}]
Example:
Input:
Output:
Input:
Output:
Same watermark was used for both the images but it resizes automatically according to the image!
Credits:
- @_devilsking_ (736115344539779072) - For making DevilsCord.
- @leref (608358453580136499) and whole Akarui Development Team - For making aoi.js, a great wrapper for interacting with Discord.
FAQs:
Q1. Why is the message getting sent after soo long?
Answer: This function relies on many other processes to be completed first like uploading of image to img.bb server (if your network is slow, it may take a while), processing the image to apply watermark (if your system is slow, it may take a while) and converting webp buffer to jpeg buffer.
Q2. Which formats can you apply watermark?
Answer: You can currently apply watermark on .png, .jpeg, .jpg, .webp, .svg.
Q3. I got an error! Where can I report?
Answer: At the moment, I dont have any support server but you can always dm me at @asheyxd (428191892950220800)