GenAvatar

A simple recreation of GitHubs random avatars

Introduction

This is a simple PHP library that recreates the random avatars GitHub creates for every user. It uses a seed for the generation and has various settings.

Pronounciation

/ˈdʒɛn æv.ə.tɑɹ/

Usage

// Including the Library
include('class.genAvatar.php');

// Setting a Header
header("Content-type: image/png");

// Creating a GenAvatar instance with the seed
$ga = new GenAvatar('github');

// Output the image content
echo $ga->generate(128, "#ffffff", "#ffd001");

// Output the image content of a smaller pattern
echo $ga->generate(128, "#ffffff", "#ffd001", 16);

Functions

Generate

Generates a GenAvatar

$genAvatar->generate($outputSize, $backgroundHex, $foregroundHex);

$genAvatar->generate($outputSize, $backgroundHex, $foregroundHex, $patternSize);

Parameters

Parameter	Type	Example	Explaination
size	integer	128	Output size of the image.
backgroundColor	Hex Color	#ffffff	The background color of the GenAvatar
foregroundColor	Hex Color	#ffd001	The foreground color of the GenAvatar
patternSize	integer	8	The pattern size used for the generation. Default is 8

License

This project is licensed under the MIT License. To read the license, click here.
For a simple explaination what you can and cannot do, click here