jimp README

The project's README from github.com/jimp-dev/jimp. As one markdown file: README.md.

Jimp

JavaScript Image Manipulation Program

An image processing library for Node written entirely in JavaScript, with zero native dependencies

Custom Jimp

If you want to extend jimp or omit types or functions visit @jimp/custom.

Contributing

Please read the CONTRIBUTING documentation.

Contributors ✨

Thanks goes to these wonderful people (emoji key):


Andrew Lisowski

💻 🚇 📖 ⚠️

Oliver Moran

💻

strandedcity

💻

Edgar Hipp

💻

Corbin Crutchley

💻

Max G J Panas

💻

Michael Vogt

💻

Marcolino

💻

iwsfg

💻

arlecchino

💻

super-ienien

💻

Bennett Somerville

💻

Florian Barth

💻

Adam Rackis

💻

Aurélio A. Heckert

💻

Daniel Tian

💻

Jeff Bonnes

💻

Russley Shaw

💻

CodeLenny

💻

Sebastian Skałacki

💻

Turan Rustamli

💻

Vlad Turak

💻

ozelot379

💻

Adam Jones

💻

Ahmad Awais ⚡️

💻

Andrei Picus

💻

Andy Chou

💻

Arjun Khoosal

💻

Arman

💻

Autom3

💻

Bernardo Farah

💻

Boon

💻

BrianRosamilia

💻

Carter Bancroft

💻

Chad Banfield

💻

Charaf Salmi

💻

ciffelia

💻

Cody Schrank

💻

Cru Scanlan

💻

Curtis Autery

💻

Dan

💻

Daniel Holmes

💻 ⚠️

Daniel Tschinder

💻

Daniel Kimani

💻

Dara Kong

💻

Denis Bendrikov

💻

Dennis Bartlett

💻

Dominique Rau

💻

Eirik Birkeland

💻

Emily Marigold Klassen

💻

Emmanuel Bourgerie

💻

Endre Szabo

💻

Eric Rabil

💻

Gal Horowitz

💻

GlitchyPSI

💻

Gustavo Ramos Rehermann

💻

Han Kruiger

💻

Igor Borges

💻

Ivan Ganev

💻

Ivan Koprda

💻

iwasawafag

💻

Jake Champion

💻

James Harris

💻

James Ross

jimp (jimp-dev/jimp)

Searching Database…

14.7K ·GitHub
What is this?Jimp is an image processing library written entirely in JavaScript for Node.js, with zero external or native dependencies.
Is it a standalone app or a library I add to my code?It's a library you install via a package manager and import into your Node.js project; it's modular, with custom plugins and file-type encoders/decoders you can add or remove.
How do I add it to a project?Install the package and require/import Jimp in your Node.js code, then use its API to load, manipulate and save images.
Do I need native libraries like GraphicsMagick or ImageMagick first?No, Jimp has zero external or native dependencies since it's written entirely in pure JavaScript.
Does it need a specific Node version?The project requires Node.js version 18 or newer according to the engines field.
Who would use this?Node.js developers who need to process or manipulate images (resize, crop, blur, composite, etc.) without installing native image libraries.
Does it work without a server or internet connection?Since it's a pure JS library with no external services, all processing happens locally in the Node process.
Can I use Jimp in the browser, not just Node?The repo includes a test:browser script and browser build targets, suggesting Jimp can run in browser environments in addition to Node.js.
Is the project actively maintained?Yes, it has over 14,000 GitHub stars, an active CI pipeline (build.yml, deploy.yml), and a long list of contributors, indicating ongoing maintenance.
Can I extend Jimp with custom plugins?Yes, Jimp supports custom plugins and lets you add or remove file-type encoders/decoders and image manipulation methods via @jimp/custom.
What package manager does the project use internally?The repo uses pnpm and turbo (a monorepo build system) for building, linting, and testing its packages.
Creator
jimp-dev
Size
458.3 MB
Stars
14.7K
Age
12y
Commits · 90 Days