govatar

README

GOvatar

GOvatar is an avatar generation library written in GO

---

Notes

1. From release v0.4.0 onward, the minimal supported golang version is 1.16.

---

Install

Brew

$ brew tap o1egl/tap
$ brew install govatar

Docker

$ docker pull o1egl/govatar

From source

$ go get -u github.com/o1egl/govatar/...

Prebuilt binary packages are available for Mac, Linux, and Windows.

Usage

$ govatar generate male -o avatar.png                        # Generates random avatar.png for male
$ govatar generate female -o avatar.png                      # Generates random avatar.png for female
$ govatar generate male -u username@site.com -o avatar.png   # Generates avatar.png for specified username
$ govatar -h                                                 # Display help message

As lib

Generates avatar and save it to filePath

err := govatar.GenerateFile(govatar.MALE, "/path/to/avatar.jpg")
err := govatar.GenerateFileFromUsername(govatar.MALE, "username", "/path/to/avatar.jpg")

Generates an avatar and returns it as an image.Image

img, err := govatar.Generate(govatar.MALE)
img, err := govatar.GenerateForUsername(govatar.MALE, "username")

Copyright, License & Contributors

Adding new skins

1. Add new skins to the background, male/clothes, female/hair, etc...
2. Submit pull request :)

Submitting a Pull Request

1. Fork it.
2. Create a branch (git checkout -b my_branch)
3. Commit your changes (git commit -am "Added new awesome avatars")
4. Push to the branch (git push origin my_branch)
5. Open a Pull Request
6. Enjoy a refreshing Diet Coke and wait

GOvatar is released under the MIT license. See LICENSE

Documentation

Index

• Variables
• func Generate(gender Gender) (image.Image, error)
• func GenerateFile(gender Gender, filePath string) error
• func GenerateFileForUsername(gender Gender, username string, filePath string) error
• func GenerateForUsername(gender Gender, username string) (image.Image, error)
• type Gender

Variables

var ErrUnsupportedGender = errors.New("unsupported gender")

Functions

func Generate

func Generate(gender Gender) (image.Image, error)

Generate generates random avatar

func GenerateFile

func GenerateFile(gender Gender, filePath string) error

GenerateFile generates random avatar and save it to specified file. Image format depends on file extension (jpeg, jpg, png, gif). Default is png

func GenerateFileForUsername

func GenerateFileForUsername(gender Gender, username string, filePath string) error

GenerateFileForUsername generates avatar for username and save it to specified file. Image format depends on file extension (jpeg, jpg, png, gif). Default is png

func GenerateForUsername

func GenerateForUsername(gender Gender, username string) (image.Image, error)

GenerateForUsername generates avatar for username

Types

type Gender

type Gender int

Gender represents gender type

const (
	MALE Gender = iota
	FEMALE
)

Male and female constants