avatars

README

go-avatars

Go library for avatar generation.

Based on @dicebear

Supports SVG and PNG output.

Sample generated by main.go

Documentation

Index

• func PNG(name string, opts ...Option) ([]byte, error)
• func SVG(name string, opts ...Option) ([]byte, error)
• type Option
• type Options
• type Padding
• type RenderSize

Functions

func PNG

func PNG(name string, opts ...Option) ([]byte, error)

PNG generates an PNG avatar using the given name as seed.

func SVG

func SVG(name string, opts ...Option) ([]byte, error)

SVG generates an SVG avatar using the given name as seed.

Types

type Option

type Option interface {
	// contains filtered or unexported methods
}

Option is a function that applies an option to the avatar service.

type Options

type Options struct {
	// Size of the rendered avatar.
	Size int
	// Padding between the rendered avatar and the border.
	Padding int
}

Options for the avatar service.

type Padding

type Padding int

Padding sets the padding between the rendered avatar and the border.

type RenderSize

type RenderSize int

RenderSize sets the size of the rendered avatar in pixels.