govatar

Avatar generation library for GO language

Programming language: Go

License: MIT License

Tags: Images    

Latest version: v0.3.0

README

GOvatar

[](LICENSE)

[GOvatar image](files/avatars.jpg)

GOvatar is an avatar generation library written in GO

Install

To install the library and command-line program, use the following:

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

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.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. Run $ make assets for building embedded assets.
3. 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](LICENSE)