= MonsterID

:DonPark:               http://www.docuverse.com/blog/donpark/2007/01/18/visual-security-9-block-ip-identification
:CombinatoricCritters:  http://www.levitated.net/bones/walkingFaces/index.html

link:https://packagist.org/packages/arokettu/monsterid[image:https://img.shields.io/packagist/v/arokettu/monsterid.svg?style=flat-square[Packagist]]
link:https://packagist.org/packages/arokettu/monsterid[image:https://img.shields.io/packagist/php-v/arokettu/monsterid.svg?style=flat-square[PHP]]
link:https://opensource.org/licenses/MIT[image:https://img.shields.io/github/license/arokettu/monsterid.svg?style=flat-square[license]]
link:https://gitlab.com/sandfox/monsterid/-/pipelines[image:https://img.shields.io/gitlab/pipeline/sandfox/monsterid/master.svg?style=flat-square[Gitlab pipeline status]]
link:https://codecov.io/gl/sandfox/monsterid/[image:https://img.shields.io/codecov/c/gl/sandfox/monsterid?style=flat-square[Codecov]]

MonsterID is a method to generate a unique monster image based upon a certain identifier
(IP address, email address, whatever).
It can be used to automatically provide personal avatar images in blog comments or other community services.

image:docs/images/example.png[Monster Example]

MonsterID was inspired by a post by link:{DonPark}[Don Park] and the link:{CombinatoricCritters}[Combinatoric Critters].

== Installation

Install it with Composer

[source,bash]
----
composer require 'arokettu/monsterid'
----

== Usage

[source,php]
----
<?php

use function Arokettu\MonsterID\build_monster;

header('Content-type: image/png');
echo build_monster('sandfox@sandfox.me', 150);
----

Read full documentation here: <https://sandfox.dev/php/monsterid.html>

Also on Read the Docs: <https://monsterid.readthedocs.io/>

== License

:AndreasGohr:   https://www.splitbrain.org
:mit:           https://opensource.org/licenses/MIT
:SandFox:       https://sandfox.me/
:upstream:      https://github.com/splitbrain/monsterID

All graphics were created by link:{AndreasGohr}[Andreas Gohr].
The source code and the graphics are provided under the link:{mit}[MIT License].

Upgraded and maintained by link:{SandFox}[Anton "Sand Fox" Smirnov].

Original implementation can be found link:{upstream}[here].
