Github Avatar Generator

Generate github-style avatar with java awt.

This project was inspired by gabrie-allaigre/avatar-generator.

Result Set

Dependency

The artifact has been released to center maven, simply add dependency.

<dependency>
    <groupId>com.github.afkbrb</groupId>
    <artifactId>github-avatar-generator</artifactId>
    <version>1.0.0</version>
</dependency>

API

Configuration

Notice

The final foreground color will be decided by the last called setForeColor method. And if none of these setForeColor methods are called, the foreground color will be generated at random but will also meet certain conditions to make the color look nice.

Creation

Example

Default

Avatar avatar = new Avatar();
avatar.showAvatar();

Save

Avatar avatar = new Avatar();
avatar.saveAsPNG("E:/avatar.png");

Set padding and cell size

AvatarConfig config = new AvatarConfig();
config.setPadding(16);
config.setCellSize(32);
Avatar avatar = new Avatar(config);
avatar.showAvatar();

Set the number of cells per row / column

config.setCellCount(8);

Set transparency

config.setTransparent(true);

Set color

config.setForeColor(Color.MAGENTA);
// config.setBackColor(Color.LIGHT_GRAY);

Set colors

config.setForeColors(Color.MAGENTA, Color.BLUE, Color.GREEN);

// the other way
List<Color> colors = new ArrayList<>();
colors.add(Color.YELLOW);
colors.add(Color.ORANGE);
colors.add(Color.CYAN);
config.setForeColors(colors);

For more example details, see example.

Licence

The Apache Software License, Version 2.0