generator

package

v1.3.0 Latest Latest Go to latest Published: Nov 6, 2023 License: MIT Imports: 11 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package generator handles the generation of achievement images.

This section is empty.

View Source

var (
	ErrUnknownBackground = fmt.Errorf("unknown background")
)

list of errors returned by the generator

This section is empty.

type Generator struct {
	Backgrounds map[string]image.Image
	FontFace    font.Face
	// contains filtered or unexported fields
}

A Generator manages all resources required to generate achievement images and provides a method to generate them.

func New() (*Generator, error)

New returns a new generator. It loads all embedded assets for quick access when needed.

func (generator *Generator) Generate(background string, textTop string, textBottom string) ([]byte, error)

Generate generates an achievement image with the given background and text. It will return an error if the background is unknown.