Usage#

Simple image generation#

Function-style#

Get PNG as a string:

<?php

use function SandFox\MonsterID\build_monster;

// output to browser
header('Content-type: image/png');
echo build_monster('[email protected]', 150);

Put PNG to a stream:

<?php

use function SandFox\MonsterID\stream_monster;

// save to file
$stream = fopen('avatar.png', 'w');
stream_monster($stream, '[email protected]', 150);
fclose($stream);

// more efficient output to browser
$stream = fopen('php://temp', 'r+');
stream_monster($stream, '[email protected]', 150);
rewind($stream);
fpassthru($stream);
fclose($stream);

Export GD object:

<?php

use function SandFox\MonsterID\build_monster_gd;

// convert it to a different format for example
$gd = build_monster_gd('[email protected]', 150); // a copy of the internal gd object
header('Content-type: image/avif');
imageavif($gd);
imagedestroy($gd); // it's your responsibility to destroy the resource (PHP < 8.0)

Monster object#

<?php

use SandFox\MonsterID\Monster;

$monster = new Monster('[email protected]', 150);

// output it to browser
header('Content-type: image/png');
echo $monster->getImage();

// save it to file
$monster->writeToStream(fopen('avatar.png', 'w'));

// gd
header('Content-type: image/avif');
imageavif($monster->getGdImage());

Random sequences#

New in version 2.2.

The library supports 3 random number generators:

  • Version 1: Mersenne Twister based. It generates the same images as MonsterID v1 and the original implementation did in PHP 7.2+. (7.1 may be glitchy, rand() in earlier versions was not MT based and is not reproducible)

  • Version 2 (default): Xorshift32 based, as implemented in MonsterID 2.1+

  • Version 3 (will be default in MonsterID 3): native PHP Xoshiro256** based sequence. Recommended if you use PHP 8.2+

Also the lib provides \SandFox\MonsterID\Randomizer\FactoryInterface that you can use to implement your own.

Note

Monster object will be serializable if your factory implementation is. All default factories are serializable.

Setting a default factory globally#

<?php

use SandFox\MonsterID\Config;
use SandFox\MonsterID\Randomizer\DefaultV1Factory;
use SandFox\MonsterID\Randomizer\DefaultV2Factory;
use SandFox\MonsterID\Randomizer\DefaultV3Factory;

Config::setRandomizerFactory(); // reset to default (currently V2)
Config::setRandomizerFactory(new DefaultV1Factory()); // set V1
Config::setRandomizerFactory(new DefaultV2Factory()); // set V2
Config::setRandomizerFactory(new DefaultV3Factory()); // set V3

All Monster objects created after the config change will use the specified factory if not explicitly passed.

Passing explicitly#

Object constructor and all functions support passing $rngFactory explicitly:

<?php

use SandFox\MonsterID\Monster;
use SandFox\MonsterID\Randomizer\DefaultV3Factory;

use function SandFox\MonsterID\build_monster;

use const SandFox\MonsterID\MONSTER_DEFAULT_SIZE;

$image = (new Monster('[email protected]', MONSTER_DEFAULT_SIZE, new DefaultV3Factory()))
    ->getImage();
// or
$image = build_monster('[email protected]', MONSTER_DEFAULT_SIZE, new DefaultV3Factory());