You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

315 lines
7.1 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>
# 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/Uqd2sQP">discord server.</a>
<a href="https://discord.gg/Uqd2sQP"><img src="https://discord.com/api/guilds/527836578912010251/widget.png" alt="Amandine support 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");
5 years ago
> You can also destructure to avoid repeating DIG.
// 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") {
5 years ago
// Get the avatarUrl of the user
let avatar = message.author.displayAvatarURL({ dynamic: false, format: 'png' });
// Make the image
5 years ago
let img = await new 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
5 years ago
## Filters
5 years ago
- ``new DIG.Blur().getImage(`<Avatar>`, `<Level(Number)>`);``
5 years ago
![Blur](https://imgur.com/JqpNFTY.png)
5 years ago
- ``new DIG.Gay().getImage(`<Avatar>`);``
![Gay](https://imgur.com/BDTrXzZ.png)
5 years ago
- ``new DIG.Greyscale().getImage(`<Avatar>`);``
5 years ago
![Greyscale](https://imgur.com/h3ahY7Z.png)
5 years ago
- ``new DIG.Invert().getImage(`<Avatar>`);``
5 years ago
![Invert](https://imgur.com/Rl0wGQM.png)
5 years ago
- ``new DIG.Sepia().getImage(`<Avatar>`);``
5 years ago
![Sepia](https://imgur.com/OTbKVtj.png)
5 years ago
## Gifs
4 years ago
- ``new DIG.Blink().getImage(`<Avatar>`, `<Avatar2>`, `<Timeout (Number in ms)>`);``
5 years ago
![Blink](https://imgur.com/JjUXmRU.gif)
5 years ago
- ``new DIG.Triggered().getImage(`<Avatar>`);``
5 years ago
![Triggered](https://imgur.com/0QvyYQa.gif)
5 years ago
## Montage
- ``new DIG.Ad().getImage(`<Avatar>`);``
![Ad](https://imgur.com/H7FvUtZ.png)
5 years ago
- ``new DIG.Affect().getImage(`<Avatar>`);``
5 years ago
![Affect](https://imgur.com/g4Gaehb.png)
5 years ago
- ``new DIG.Batslap().getImage(`<Avatar>`, `<Avatar2>`);``
5 years ago
![Batslap](https://imgur.com/oYMpa5A.png)
5 years ago
- ``new DIG.Beautiful().getImage(`<Avatar>`);``
5 years ago
![Beautiful](https://imgur.com/HGZkmXo.png)
5 years ago
- ``new DIG.Bed().getImage(`<Avatar>`, `<Avatar2>`);``
5 years ago
![Bed](https://imgur.com/b1idSnr.png)
- ``new DIG.Bobross().getImage(`<Avatar>`);``
![Bobross](https://imgur.com/lATDohK.png)
- ``new DIG.ConfusedStonk().getImage(`<Avatar>`);``
![ConfusedStonk](https://imgur.com/b4UB3BE.png)
5 years ago
- ``new DIG.Delete().getImage(`<Avatar>`);``
5 years ago
![Delete](https://imgur.com/6V1IYJp.png)
4 years ago
- ``new DIG.DiscordBlack().getImage(`<Avatar>`)``
![DiscordBlack](https://imgur.com/dTX3wta.png)
- ``new DIG.DiscordBlue().getImage(`<Avatar>`)``
![DiscordBlue](https://imgur.com/q1bRGrx.png)
- ``new DIG.DoubleStonk().getImage(`<Avatar`, `<Avatar2>`)``
![DoubleStonk](https://imgur.com/HbuuUC6.png)
5 years ago
- ``new DIG.Facepalm().getImage(`<Avatar>`);``
5 years ago
![Facepalm](https://imgur.com/cdPC3P1.png)
5 years ago
- ``new DIG.Hitler().getImage(`<Avatar>`);``
![Hitler](https://imgur.com/wK9puxH.png)
5 years ago
- ``new DIG.Jail().getImage(`<Avatar>`);``
5 years ago
![Jail](https://imgur.com/QslACNo.png)
- ``new DIG.Karaba().getImage(`<Avatar>`);``
![Karaba](https://imgur.com/4aEZs6v.png)
5 years ago
- ``new DIG.Kiss().getImage(`<Avatar>`, `<Avatar2>`);``
5 years ago
![Kiss](https://imgur.com/sSoCAeH.png)
- ``new DIG.LisaPresentation().getImage(`<Text>`);``
4 years ago
![LisaPresentation](https://imgur.com/u5cPVVW.png)
> Limited to 300char
4 years ago
(Thanks to sιмση εcεяε#5765)
- ``new DIG.Mms().getImage(`<Avatar>`);``
5 years ago
![MMS](https://imgur.com/nH3URHb.png)
4 years ago
- ``new DIG.NotStonk().getImage(`<Avatar>`);``
![NotStonk](https://imgur.com/NJ2Svtj.png)
- ``new DIG.Podium().getImage(`<Avatar1>, <Avatar2>, <Avatar2>, <Name1>, <Name2>, <Name3>`);``
![Podium](https://imgur.com/bQoKf0a.png)
- ``new DIG.Poutine().getImage(`<Avatar>`);``
![Poutine](https://imgur.com/UpQJHzM.png)
5 years ago
- ``new DIG.Rip().getImage(`<Avatar>`);``
5 years ago
![RIP](https://imgur.com/qhyZKfz.png)
5 years ago
5 years ago
- ``new DIG.Spank().getImage(`<Avatar>`, `<Avatar2>`);``
![Spank](https://imgur.com/25gq0es.png)
5 years ago
4 years ago
- ``new DIG.Stonk().getImage(`<Avatar>`);``
![Stonk](https://imgur.com/oAVgevR.png)
5 years ago
- ``new DIG.Tatoo().getImage(`<Avatar>`)``
5 years ago
![Tatoo](https://imgur.com/wJju4UJ.png)
5 years ago
- ``new DIG.Thomas().getImage(`<Avatar>`);``
5 years ago
![Thomas](https://imgur.com/7R37J2j.png)
5 years ago
- ``new DIG.Trash().getImage(`<Avatar>`);``
5 years ago
![Trash](https://imgur.com/nwAHGgF.png)
5 years ago
- ``new DIG.Wanted().getImage(`<Avatar>`, `<Currency>`);``
> Currency ($, €, ...)
![Wanted](https://imgur.com/NJfzJeN.png)
5 years ago
## Utils
5 years ago
- ``new DIG.Circle().getImage(`<Avatar>`);``
5 years ago
![Circle](https://imgur.com/0Zo8NYS.png)
5 years ago
- ``new DIG.Color().getImage(`<Color>`);``
5 years ago
> An hex color is needed, like "#FF0000"
5 years ago
![Color](https://imgur.com/40tMwfe.png)
5 years ago
# Changelog
## v1.4.5
- Added Karaba()
- Fixed some errors returns that were not the same
4 years ago
## v1.4.0
- Added DiscordBlack() and DiscordBlue()
- Added ESLint and fixed all problems
- Use of the function file in LisaPresentation() instead of an in file function
## v1.3.9
- Edited links in README
- Bumped jimp from 0.14.0 to 0.16.1
## v1.3.8
- Edited the Rip() image
- Fixed the Spank() colors
## v1.3.4
- Added bobross()
4 years ago
## v1.3.2
- Added Stonk()
- Added NotStonk()
- Added DoubleStonk()
- Added ConfusedStonk()
4 years ago
## v1.2.12
- Optimized src/index.js (thanks to https://github.com/Pyrojs)
## v1.2.9
- Added Podium()
- Added Ad()
- Added Poutine()
- Fixed Wanted()
- Bumped jimp from ^0.13.0 to ^0.14.0
## v1.1.5
- Added LisaPresentation
## v1.1.2
- Fixed invalid path
- Moved assets folder
5 years ago
## v1.0.0
- Changed the full structure
- Sorted all files in folders
- Sorted all files in the README
5 years ago
- Fixed new Wanted() text bug
- Added new Blink()
- Added a timeout options for new Triggered()
5 years ago
- 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
5 years ago
## 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
5 years ago
## 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()