caption

node-caption
============

Node utility for captioning images via imageMagick

To use node-caption, the system it's running on must have imageMagick (and ghostscript) installed. Here are some ways to do that:

OSX: brew install imagemagick ghostscript

Ubuntu: apt-get install imagemagick ghostscript

RedHat and other yummy systems yum install imagemagick ghostscript

additionally, you can install it from a binary, as described here http://www.imagemagick.org/script/binary-releases.php

or build from source: http://www.imagemagick.org/script/install-source.php

##### Usage:

To use caption in a node project, just require it:

var caption = require('caption')

There are only two methods in caption, path, and url

To caption an existing image file, do this:

caption.path("path/to/file.jpg",options,function(err,captionedImage){
// err will contain an Error object if there was an error
// otherwise, captionedImage will be a path to a file.
})

To download the image first, use caption.url:

caption.url("http://www.someImageHost.com/path/to/image.jpg",options,function(err,captionedImage){
// err will contain an Error object if there was an error
// otherwise, captionedImage will be a path to a file.
})

the options object is always the same, and has the following options:

- caption : A string containing the text you would like to caption the image with
- bottomCaption : A string containing the bottom caption, for a meme style caption
- outputFile : if specified, caption will put the new image in this file. If not, it'll return an image in the /tmp directory.
- minHeight : minimum height of the image. (defaults to 100)
- minWidth : minimum width of the image. (defaults to 500)

##### Command line

You can also use caption from the command line.

First, install caption:

npm install -g caption

then you can start generating images to your hearts content. Calling caption with no arguments will output the usage options:

Usage:
For a caption on the bottom of the image:
caption -c "caption text" -o [ouput file]
For top and bottom captions (meme style):
caption --top-caption "top caption" --bottom-caption "bottom caption" --output [ouput file]

The available options are:

-c / --caption / -b / --bottom-caption : caption text to put at the bottom of the image.

-t / --top : caption text to put at the top of the image. May not be used with out a bottom caption.

-o / --output : output file to render the image to.

The first argument is the path or URL to an image.
You can use a url or a path, caption will try to download the url if it doesn't exist on your local fs.

To specify a minimum height or width from the command line, you can set the CAPTION_MIN_WIDTH and CAPTION_MIN_HEIGHT environment variables.

##### Examples:

caption http://simonbisleygallery.com/art/biz00157.jpg "I AM THE LAW" dredd.jpg

or

caption.url("http://simonbisleygallery.com/art/biz00157.jpg",{
caption : "I AM THE LAW",
outputFile : "dredd.jpg"
},function(err,filename){
// do stuff
})

!I AM THE LAW

caption http://i.imgur.com/AtLeN.png "You are mistaken." "This is my bowl." cat.jpg

or

caption.url("http://i.imgur.com/AtLeN.png",{
caption : "You are mistaken.",
bottomCaption : "This is my bowl.",
outputFile : "cat.jpg"
},function(err,filename){
// do stuff
})

!This is my bowl.

##### Notes

Currently caption always uses white text with a 2px black stroke. It will automatically make the text as big as possible given the image.

In the future, I may add support for specifying certain imagemagick options for more versatility.

If you find issues, please let me know! The preferred method is to use the github issue tracker

Credit to Zach Holman's Fuck Yeah for inspiration.

Feel free to talk to me on Twitter - @jesseditson