image-forge

A powerful tool for creating custom images from templates

⚠️ Important Warning ⚠️

Issue 1

Summary

• 📜 About the package
• 📥 Installation
• 🛠️ Usage
• 🚀 Action plan
• 🧐 Examples
• ❓ FAQ
• 🫶 Contributing
• 👀 License

📜 About the package

Image Forge is a package that simplifies creating images from templates. Used in the Discord bot developer community and meme creation, Image Forge offers an effective and intuitive way to generate filters and memes. With a comprehensive range of features, users can easily customize templates.

📥 Installation

Install using your favorite package manager:

# npm
npm install image-forge

# yarn
yarn add image-forge

# pnpm
pnpm add image-forge

(back to top)

🧐 Usage

All generators are exported using a single index.js file, so you can simply destructure just the generator you want using destructuring, without having to import every generator:

import { GrayFilter } from "image-forge";

In the example below we import the GrayFilter generator and create the filter passing the path of the image to be processed, and finally we use the apply method to generate a Buffer of the image with the applied filter, and write it to the file imageOutput.png:

import { GrayFilter } from "image-forge";
import { writeFileSync } from "node:fs";

const filter = new GrayFilter().setSource("./imageInput.png");
const imageBuffer = await filter.apply();

await writeFileSync("./imageOutput.png", imageBuffer);
console.log("Processing completed 🎉");

(back to top)

🚀 Action plan

• [x] create the because
• [x] create some base generators
• [] create good architecture
• [] create documentation for the generators (like discord.js maybe)
• [] create meme generators
• [] God only knows

(back to top)

❓ FAQ

Can it read an image from a url?

Yes, because it uses the @napi-rs/canvas package to manipulate images

const filter = new GrayFilter().setSource("https://imgur.com/eBIlPPn.png");

(back to top)

🫶 Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project (gh repo clone HarukaYamamoto0/image-forge)
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'feat: Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

👀 License

This project is licensed under the terms of the MIT license. See the LICENSE file for more details.

(back to top)