Skip to content

jimp-dev/jimp

main
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

Per [Cambridge Dictionary](https://dictionary.cambridge.org/grammar/british-grammar/it-s-or-its), `it's` is reserved for `it is` or `it has`, but in this context it is being used as neither of those.
9edebb3

Git stats

Files

Permalink
Failed to load latest commit information.

Jimp

JavaScript Image Manipulation Program

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

Notice of potentially breaking change

As of v0.10.4, core-js is no longer included with jimp or its extensions. If you rely on core-js, install it with either yarn add core-js or npm i core-js

Read before installing

Please be aware that Jimp is built on JavaScript implementations of image formats so in some cases that might allocate a lot of memory before using.

Installation

Installation: npm install --save jimp

API documentation can be found in the main jimp package

Supported Image Types

Image Manipulation Methods (Default Plugins)

  • blit - Blit an image onto another.
  • blur - Quickly blur an image.
  • color - Various color manipulation methods.
  • contain - Contain an image within a height and width.
  • cover - Scale the image to the given width and height keeping the aspect ratio.
  • displace - Displaces the image based on a displacement map
  • dither - Apply a dither effect to an image.
  • flip - Flip an image along its x or y axis.
  • gaussian - Hardcore blur.
  • invert - Invert an images colors
  • mask - Mask one image with another.
  • normalize - Normalize the colors in an image
  • print - Print text onto an image
  • resize - Resize an image.
  • rotate - Rotate an image.
  • scale - Uniformly scales the image by a factor.

Extra Plugins

  • circle - Creates a circle out of an image.
  • shadow - Creates a shadow on an image.
  • fisheye - Apply a fisheye effect to an image.
  • threshold - Lighten an image. Good for scanned drawing and signatures.

:rocket: If you want to add your plugins to this list make a PR! :rocket:

Custom Jimp

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

  • Add file-types or switch encoder/decoders
  • Add add/remove plugins (image manipulation methods)

Contributing

Basically clone, change, test, push and pull request.

Please read the CONTRIBUTING documentation.

License

Jimp is licensed under the MIT license. Open Sans is licensed under the Apache license

Project Using Jimp

nimp - Node based image manipulator. Procedurally create and edit images.

node-vibrant - Extract prominent colors from an image.

lqip - Low Quality Image Placeholders (LQIP) Module for Node

webpack-pwa-manifest - A webpack plugin that generates a 'manifest.json' for your Progressive Web Application, with auto icon resizing and fingerprinting support.

wdio-screenshot - A WebdriverIO plugin. Additional commands for taking screenshots with WebdriverIO.

asciify-image - Convert images to ASCII art

node-sprite-generator - Generates image sprites and their spritesheets (css, stylus, sass, scss or less) from sets of images. Supports retina sprites.

merge-img - Merge multiple images into a single image

postcss-resemble-image - Provide a gradient fallback for an image that loosely resembles the original.

differencify - Perceptual diffing tool

gifwrap - A Jimp-compatible library for working with GIFs

replace-color - Replace color with another one pixel by pixel

handwritten.js - Convert typed text to realistic handwriting!

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

💻

Jeremy Katz

💻

Jeroen Claassens

💻

Johannes Goslar

💻

J D Carmichael

💻

John-Robert Yrjölä

💻

Jordan Danford

💻

Joseph

💻

Keith

💻

Keith Mitchell

💻

Kwyn Alice Meagher

💻

Lucy

💻

Marat Nagayev

💻

Marcel Mundl

💻

Mario Adrian

💻

Martin Trobäck

💻

Matt Mc

💻

Max

💻

Maël Nison

💻

Michael Elhadad

💻

Milos Bejda

💻

Mithgol

💻

Nicolas Giard

💻

Nam Bok Rodriguez

💻

Nate Cavanaugh

💻

Nik

💻

Olly Banham

💻

Pasi Eronen

💻

Pavel Volyntsev

💻

Peter Theill

💻

Philip Hannent

💻

Philipp Laube

💻

Rahil Kabani

💻

Rob Moore

💻

Ruben Bridgewater

💻

Sam Broner

💻

Sam MacPherson

💻

Sander Weyens

💻

Shen Yiming

💻

Stefan Lau

💻

Steve Bazyl

💻

Steve Mao

💻

Stuart Hinson

💻

Tom Bull

💻

TonyStr

💻

Laurent

💻

Vincent Dufrasnes

💻

Vladimir Starkov

💻

Vojtěch Štěpančík

💻

William Friesen

💻

Xiliang Chen

💻

Yonggang Luo

💻

austinfrey

💻

brownrw8

💻

Eliott C.

💻

d07RiV

💻

fabb

💻

fratzinger

💻

Guillem Cruz

💻

krudos

💻

mLuby

💻

mfuatnuroglu

💻

Matt Misbach

💻

netdown

💻

nopeless

💻

Oz Weiss

💻

popinguy

💻

qw3n

💻

rifflock

💻

s4tori

💻

sertal70

💻

xinbenlv

💻

xinnix

💻

彭君怡

💻

Andrey Kutejko

📖

Ihor Bodnarchuk

📖

Daniell

💻

MD KHAIRUL ISLAM

⚠️ 💻

JunkMeal

📖

Nicolas Morel

💻

Zach Stevenson

💻

This project follows the all-contributors specification. Contributions of any kind welcome!