o1egl / govatar

Avatar generation library for GO language

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 [email protected] -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.GenerateFileForUsername(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

govatar's Issues

ignoring errors

govatar/govatar.go

Line 126 in 7b91520

err = drawImg(avatar, randSliceString(rnd, assetsStore.Background), err)

you're effectively ignoring any possible errors returned by other function calls here... the correct (albeit tedious) way to error check, would be to use one "if err != nil" per "err = ..." line

Generate avatar based on hash (feature-request)

It would be nice to generate avatars based on hash (like gravatar). For example:

govatar generate -hash [email protected] female

The above could then generate an avatar based on the hash provided (like an email) so it would be the same avatar every time.

Would be happy to provide a pull-request for this feature.

BTW, great library and amazing artwork!

the govator.go was updated , but your README.md is not Synchronizing.

2021-10-25， I am using your govatar while found a little problem, GenerateFileFromUsername() was modified to GenerateFileForUsername() , the generatefilefromusername() method has been discarded .Can I join your contribution group and update the README.md, thank you very much.