Skip to content
Create a very pretty random avatars with ease.
PHP
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
resources
src
tests
.gitattributes
.gitignore
.travis.yml
composer.json
phpunit.xml
readme.md

readme.md

Laravel - Instant Avatar

Create a very pretty random avatars with ease.

installation

Add the new required package in your composer.json

"vinicius73/laravel-instantavatar": "~1.1"

Run composer update or php composer.phar update.

After composer command, add new service provider in app/config/app.php :

Vinicius73\IAvatar\IAvatarServiceProvider::class,

Now, add new aliases in app/config/app.php.

'IAvatar' => Vinicius73\IAvatar\Facade\IAvatarFacade::class,

Finally publish the configuration file of the package php artisan vendor:publish

Usage

/**
 * Creates the image. Only the first letter will be passed to the image.
 * Ex.:
 * 'My String' -> output My
 * You can change this in the settings
 */
$avatar = IAvatar::random('My String');

/**
 * Save imagem in path
 * You can use `public::` Omit the full address /public
 */
$avatar->save('public::path/to/file.png');

/**
 * Output image in browser
 */
$avatar->display();
IAvatar::random('Vinicius')->save('public::avatars/vinicius.png')->display();

Configuration

return array(
    'width'    => 150,
    'heigth'   => 150,
    'fontsize' => 80, // in px
    'chars'    => 2, // Character limit for every image
    'font' => array( // You can register or remove more sources with ease.
        'InstantAvatar::Comfortaa-Regular.ttf',
        'InstantAvatar::Roboto-Regular.ttf',
        'InstantAvatar::Ubuntu-Regular.ttf',
        'InstantAvatar::DroidSans.ttf'
    ),
    'overlay'  => 'InstantAvatar::glass.png', // A watermark that overlays the image
    'flat'     => false // Enables the flat mode
);

Demo

Default

Instant Avatar

Flat

Color based in avatarly

Instant Avatar Flat

You can’t perform that action at this time.