Nanoscale Parts Manufacturing

    avatars

    0.9.7 • Public • Published

    avatars

    NPM version

    Pixel avatar (npm-like) generator.

    This module using strings as seed for generator. There are some examples:

    Some random string (with 3 colors):

    alt example

    admin (with 2 colors):

    alt example

    username (with 2 colors and bigger cells):

    alt example

    Install

    npm install --save avatars
    

    Usage

    Basic promise usage:

    var avatars = require('avatars');
    avatars()
        .then(image => {
            image.write("./text.png", (err) => {
                if (err) throw err;
                console.log("Created text.png");
            });
        })
        .catch(e => console.error(e));

    Basic callback usage:

    var avatars = require('avatars');
    avatars(null, function(error, image) {
        if (error) throw error;
        
        image.write("./text.png", (err) => {
            if (err) throw err;
            console.log("Created text.png");
        });
    });

    First argument of avatars() is parameters object for image generation. Avatars return image object that is created by Jimp module.

    Parameters

    Parameter Description
    seed Some string that will be used as a seed for randomizer (default: random string)
    width Width of the output image in px (default: 256)
    height Height of the output image in px (default: 256)
    pwidth Width of the generated pattern in cells (default: 16)
    pheight Height of the generated pattern in cells (default: 16)
    filename Filename to write the image (default: null)

    Example

    var avatars = require('avatars');
     
    var params = {
        seed: 'Some Random Name',   // can be username, login, id etc
        width: 500,
        height: 500,
        pwidth: 15,
        pheight: 15,
        filename: './test.png'  // file with this name will be created
    };
     
    avatars(params)
        .then(image => {
            console.log("Image created");
        })
        .catch(e => console.error(e));

    Install

    npm i avatars

    DownloadsWeekly Downloads

    80

    Version

    0.9.7

    License

    ISC

    Unpacked Size

    7.64 kB

    Total Files

    3

    Last publish

    Collaborators

    • saveryanov