goavatar

Goavatar Identicon Generator in Go

This package provides a simple way to generate unique, symmetric identicons based on an input string (e.g., an email address or username). It uses an MD5 hash to create a deterministic pattern and color scheme, then mirrors the design for a visually appealing avatar.

User Avatars

QuantumNomad42     
EchoFrost7     
NebulaTide19     
ZephyrPulse88     
EmberNexus23     
nice__user__name

Installation

To use this package in your Go project, install it via:

go get github.com/MuhammadSaim/goavatar

Then, import it in your Go code:

import "github.com/MuhammadSaim/goavatar"

Usage

Basic Example

package main

import (
 "fmt"
 "image"
 "image/png"
 "os"

 "github.com/MuhammadSaim/goavatar"
)

func main() {
 // empty slice.
 imgSlice := make([]image.Image, 0)

 // Generates a unique avatar based on "QuantumNomad42" with a custom width and height.
 // Saves the generated avatar as avatar_1.png
 image1 := goavatar.Make("QuantumNomad42",
  goavatar.WithSize(512),  // Set custom image widthxheight (default is 64)
 )

 // Generate the second avatar with a custom grid size with a 10x10 grid for more detail.
 // Saves the generated avatar as avatar_2.png
 image2 := goavatar.Make("EchoFrost7",
  goavatar.WithSize(512),   // Set custom image widthxheight (default is 64)
  goavatar.WithGridSize(10), // Set custom grid size (default is 8), affects pattern complexity
 )

 // Generate the third avatar with a custom brownish background color.
 // Saves the generated avatar as avatar_3.png
 image3 := goavatar.Make("NebulaTide19",
  goavatar.WithSize(512),                 // Set custom image widthxheight (default is 256)
  goavatar.WithBgColor(170, 120, 10, 255), // Change background color (default is light gray)
 )

 // Generate the fourth avatar with a custom brownish background and white foreground.
 // Saves the generated avatar as avatar_4.png
 image4 := goavatar.Make("ZephyrPulse88",
  goavatar.WithSize(512),                  // Set custom image widthxheight (default is 64)
  goavatar.WithBgColor(170, 120, 10, 255),  // Change background color (default is light gray)
  goavatar.WithFgColor(255, 255, 255, 255), // Change foreground color (default is extracted from hash)

 )

 // Generate an avatar using default settings
 // Saves the generated avatar as avatar_5.png
 image5 := goavatar.Make("EmberNexus23")

 // Collect options dynamically
 var opts []goavatar.OptFunc

 // add size
 opts = append(opts, goavatar.WithSize(100))
 opts = append(opts, goavatar.WithGridSize(10))
 image6 := goavatar.Make("nice__user__name", opts...)

 // append all the images into the list
 imgSlice = append(imgSlice, image1, image2, image3, image4, image5, image6)

 // loop through the image slice and save the images
 for i, img := range imgSlice {

  filename := fmt.Sprintf("../arts/avatar_%d.png", i+1)

  // Create the file
  file, err := os.Create(filename)
  if err != nil {
   fmt.Println("Error creating file:", err)
   continue
  }
  defer file.Close()

  // Encode image as PNG and save
  err = png.Encode(file, img)
  if err != nil {
   fmt.Println("Error saving image:", err)
  } else {
   fmt.Println("Saved: ", filename)
  }

 }
}

This will generate a unique identicons for the input string and save in the arts directory.

Package Documentation

Generate Identicon

func Make(input, ...optFunc) image.Image

• input: A string used to generate a unique identicon (e.g., email, username).
• ...optFunc: Functional options to override the default values.
• image.Image: Function returns an image.Image, allowing the caller to handle image processing, encoding, and storage as needed.

License

This project is open-source under the MIT License.

Contributing

Contributions are welcome! Feel free to open a pull request or create an issue.