220 lines
4.8 KiB
Markdown
220 lines
4.8 KiB
Markdown
<a href="https://nodei.co/npm/discord-image-generation/"><img src="https://nodei.co/npm/discord-image-generation.png?downloads=true&downloadRank=true&stars=true"></a>
|
|
|
|
<a href="https://discord.gg/qvzwqaM"><img src="https://discord.com/api/guilds/661897530459684865/widget.png" alt="Discord server"/></a>
|
|
|
|
# discord-image-generation
|
|
|
|
A powerfull module that allow you to generate awesome images.
|
|
|
|
# Bugs and glitches
|
|
|
|
Feel free to report all bugs and glitches by creating an issue in the <a href="https://github.com/Mr-KayJayDee/discord-image-generation/issues">issue section.</a>
|
|
|
|
A correct and understandable issue contains :
|
|
- Steps to reproduce
|
|
- Code that summonned the error
|
|
- The complete error
|
|
|
|
You can also join me on my <a href="https://discord.gg/qvzwqaM">discord server.</a>
|
|
|
|
# Download
|
|
|
|
You can download it from <a href="https://www.npmjs.com/package/discord-image-generation">npmjs</a>.
|
|
|
|
```cli
|
|
npm i discord-image-generation
|
|
```
|
|
|
|
# Configuration
|
|
|
|
The first step is to import the module in your code.
|
|
|
|
```js
|
|
const DIG = require("discord-image-generation");
|
|
```
|
|
|
|
Then you have to request your image and send it as an attachement.
|
|
|
|
```js
|
|
// Import the discord.js library.
|
|
const Discord = require("discord.js")
|
|
// Create a new discord.js client.
|
|
const bot = new Discord.Client()
|
|
|
|
const DIG = require("discord-image-generation");
|
|
|
|
// Listen to the ready event
|
|
bot.on("ready", () => {
|
|
console.log("ok");
|
|
})
|
|
|
|
// Listen to the message event
|
|
bot.on("message", async (message) => {
|
|
if (message.content === "*delete") {
|
|
// Get the avatarUrl of the user
|
|
let avatar = message.author.displayAvatarURL({ dynamic: false, format: 'png' });
|
|
// Make the image
|
|
let img = await DIG.delete().getImage(avatar)
|
|
// Add the image as an attachement
|
|
let attach = new Discord.MessageAttachment(img, "delete.png");;
|
|
message.channel.send(attach)
|
|
}
|
|
})
|
|
|
|
// Log in to the bot
|
|
bot.login("super_secret_token")
|
|
````
|
|
|
|
# Available images
|
|
|
|
|
|
## Filters
|
|
|
|
- .Blur().getImage(`<Avatar>`, `<Level(Number)>`);
|
|
|
|
|
|
|
|
- .Gay().getImage(`<Avatar>`);
|
|
|
|
|
|
|
|
- .Greyscale().getImage(`<Avatar>`);
|
|
|
|
|
|
|
|
- .Invert().getImage(`<Avatar>`);
|
|
|
|
|
|
|
|
- .Sepia().getImage(`<Avatar>`);
|
|
|
|
|
|
|
|
|
|
## Gifs
|
|
|
|
- .Blink().getImage()
|
|
|
|
|
|
|
|
- .Triggered().getImage(`<Avatar>`);
|
|
|
|
|
|
|
|
|
|
## Montage
|
|
|
|
- .Affect().getImage(`<Avatar>`);
|
|
|
|
|
|
|
|
- .Batslap().getImage(`<Avatar>`, `<Avatar2>`);
|
|
|
|
|
|
|
|
- .Beautiful().getImage(`<Avatar>`);
|
|
|
|
|
|
|
|
- .Bed().getImage(`<Avatar>`, `<Avatar2>`);
|
|
|
|
|
|
|
|
- .Delete().getImage(`<Avatar>`);
|
|
|
|
|
|
|
|
- .Facepalm().getImage(`<Avatar>`);
|
|
|
|
|
|
|
|
- .Hitler().getImage(`<Avatar>`);
|
|
|
|
|
|
|
|
- .Jail().getImage(`<Avatar>`);
|
|
|
|
|
|
|
|
- .Kiss().getImage(`<Avatar>`, `<Avatar2>`);
|
|
|
|
|
|
|
|
- .Mms().getImage(`<Avatar>`);
|
|
|
|
|
|
|
|
- .Rip().getImage(`<Avatar>`);
|
|
|
|
|
|
|
|
- .Spank().getImage(`<Avatar>`, `<Avatar2>`);
|
|
|
|
|
|
|
|
- .Tatoo().getImage(`<Avatar>`)
|
|
|
|
|
|
|
|
- .Thomas().getImage(`<Avatar>`);
|
|
|
|
|
|
|
|
- .Trash().getImage(`<Avatar>`);
|
|
|
|
|
|
|
|
- .Wanted().getImage(`<Avatar>`, `<Currency>`);
|
|
|
|
> Currency ($, €, ...)
|
|
|
|
|
|
|
|
|
|
## Utils
|
|
|
|
- .Circle().getImage(`<Avatar>`);
|
|
|
|
|
|
|
|
- .Color().getImage(`<Color>`);
|
|
|
|
> An hex color is needed, like "#FF0000"
|
|
|
|
|
|
|
|
# Changelog
|
|
|
|
## v1.0.0
|
|
- Changed the full structure
|
|
- Sorted all files in folders
|
|
- Sorted all files in the README
|
|
- Fixed .wanted() text bug
|
|
- Added .blink()
|
|
- Added a timeout options for .triggered()
|
|
- Fixed the triggered example not animated
|
|
- Added some keywords
|
|
- Bumped jimp from ^0.12.1 to ^0.13.0
|
|
- Added workflow to auto publish to npm and github packages on push
|
|
|
|
|
|
## v0.1.14
|
|
- Updated .thomas() example
|
|
|
|
## v0.1.13
|
|
- Added example for .tatoo()
|
|
- Fixed the litle hole at the top of the users pic on .thomas()
|
|
|
|
## v0.1.12
|
|
- Saved all examples to imgur
|
|
|
|
## v0.1.11
|
|
- Added .tatoo()
|
|
- Updated JSDoc
|
|
|
|
## v0.1.9
|
|
- Added options for the wanted.
|
|
- The base image has been updated
|
|
- There is now a random price diplayed
|
|
- You can now configure a currency
|
|
- Added .thomas() |