Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/o1egl/govatar
Avatar generation library for GO language
https://github.com/o1egl/govatar
avatar-generator go golang skin
Last synced: 7 days ago
JSON representation
Avatar generation library for GO language
- Host: GitHub
- URL: https://github.com/o1egl/govatar
- Owner: o1egl
- License: mit
- Created: 2016-01-18T12:12:28.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2022-10-04T06:28:45.000Z (about 2 years ago)
- Last Synced: 2024-10-14T10:45:01.807Z (25 days ago)
- Topics: avatar-generator, go, golang, skin
- Language: Go
- Homepage:
- Size: 10 MB
- Stars: 586
- Watchers: 10
- Forks: 44
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome-go - govatar - Library and CMD tool for generating funny avatars. (Images / Search and Analytic Databases)
- awesome-ccamel - o1egl/govatar - Avatar generation library for GO language (Go)
- awesome-trevor - govatar - avatar generation library for Go language (Programming / Golang)
- awesome-go - govatar - Avatar generator library for GO language - ★ 266 (Images)
- awesome-go-extra - govatar - 01-18T12:12:28Z|2022-07-29T11:21:00Z| (Images / Advanced Console UIs)
- awesome-go-zh - govatar
README
# GOvatar
[](LICENSE)
[](https://godoc.org/github.com/o1egl/govatar)
[](https://github.com/o1egl/govatar/actions/workflows/main.yaml)
[](https://codecov.io/gh/o1egl/govatar)
[](https://goreportcard.com/report/github.com/o1egl/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](https://github.com/o1egl/govatar/releases) are available for Mac, Linux, and Windows.
## Usage
```bash
$ 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
```go
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
```go
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](https://github.com/o1egl/govatar/pulls)
6. Enjoy a refreshing Diet Coke and wait
GOvatar is released under the MIT license. See [LICENSE](LICENSE)