node package manager

fur

Quick generator for banner, favicon, etc...

fur

Quick generator for banner, favicon, etc...

// Generate favicon with command options. 
$ fur favicon "my-favicon.png" --color b --font n --text oh --shape c

fur is available as an npm package.

# Install fur as a global module.
$ npm install fur -g

Or you can install it without -g option and use Programmatic API.

### Available Commands
$ fur -h
 
  Usage: fur [options] [command]
 
 
  Commands:
 
    banner [options] <filename>   Generate a banner.
    favicon [options] <filename>  Generate a favicon.
 
  Options:
 
    -h, --help     output usage information
    -V, --version  output the version number
 
 
### Programmatic API

fur provides programmatic API which enables you to execute fur commands from Node.js program.

var fur = require('fur');
fur.banner('my-banner.svg', {
text: "coz",
color: "o",
font: "aa",
style: "plain",
shape: "k"
}, function (err) {
});

Image Command
$ fur banner "fur-banner.png" --text="FUR" --color="#ff9100" --font="bt" --shape="a"
$ fur banner "coz-banner.png" --text="coz" --color="#00b560" --font="aa" --shape="b"
$ fur banner "apeman-banner.png" --text="apeman" --color="n" --font="p" --shape="a"
$ fur banner "pudding-banner.png" --text="PUDDING" --color="bi" --font="cn" --shape="e"
$ fur banner "pon-banner.png" --text="pon" --color="ah" --font="ar" --shape="f"
$ fur banner "rfunc-banner.png" --text="rfunc" --color="ac" --font="e" --shape="f"

These examples are available here.

$ fur banner -h
 
 
  Usage: banner [options] <filename>
 
  Generate a banner.
 
  Options:
 
    -h, --help                  output usage information
    -c, --color <color>         Color expression string or color theme name.
    -s, --shape <shape>         Banner style.
    -f, --font <font>           Font file name or font theme name.
    -F, --font-size <fontSize>  Size of font.
    -H, --height <height>       Banner height.
    -o, --format <format>       File format. 'svg' or 'png'.
    -t, --text <text>           Banner text.
    -W, --width <width>         Banner width.
    -v, --verbose               Emit verbose log.
 
 

Image Command
$ fur favicon "f-favicon.png" --text="F" --color="#ff9100" --font="bt" --shape="a"
$ fur favicon "c-favicon.png" --text="c" --color="#00b560" --font="aa" --shape="c"
$ fur favicon "ap-favicon.png" --text="ap" --color="n" --font="p" --shape="g"
$ fur favicon "p-favicon.png" --text="P" --color="bi" --font="cn" --shape="a"
$ fur favicon "pon-favicon.png" --text="pon" --color="ah" --font="ar" --shape="g"
$ fur favicon "rf-favicon.png" --text="rf" --color="ac" --font="e" --shape="c" --font-size="148"
$ fur favicon "mw-favicon.png" --text="mw" --color="n" --font="p" --shape="i" --font-size="92"
$ fur favicon "api-favicon.png" --text="api" --color="n" --font="p" --shape="i" --font-size="92"
$ fur favicon "a-favicon.png" --text="a" --color="n" --font="p" --shape="g" --font-size="92"

These examples are available here.

$ fur favicon -h
 
 
  Usage: favicon [options] <filename>
 
  Generate a favicon.
 
  Options:
 
    -h, --help                  output usage information
    -c, --color <color>         Color expression string or color theme name.
    -f, --font <font>           Font file name or font theme name.
    -F, --font-size <fontSize>  Size of font.
    -S, --size <size>           Favicon size.
    -s, --shape <shape>         Banner style.
    -t, --text <text>           Favicon text.
    -o, --format <format>       File format. 'svg' or 'png'.
    -v, --verbose               Emit verbose log.
 
 

Support this project and others by okunishinishi via gratipay.

This software is released under the MIT License.