heraldry

Documentation

Overview

Package heraldry implements methods for randomly generating heraldic coats of arms and their associated blazons.

Index

• type Device
  • func Generate() (Device, error)
  • func GenerateByParameters(fieldName string, chargeTag string) (Device, error)
  • func (device Device) RenderToBlazon() (string, error)
  • func (device Device) RenderToPNG() (string, error)
  • func (device Device) Simplify() SimplifiedDevice
• type SimplifiedDevice

Types

type Device

type Device struct {
	Blazon   string      `json:"blazon"`
	Field    field.Field `json:"field"`
	ImageURL string      `json:"image_url"`
	FileName string      `json:"file_name"`
	GUID     string      `json:"guid"`
}

Device is the entire coat of arms

func Generate

func Generate() (Device, error)

Generate procedurally generates a random heraldic device and returns it.

func GenerateByParameters

func GenerateByParameters(fieldName string, chargeTag string) (Device, error)

GenerateByParameters generates a random heraldic device fitting certain criteria.

func (Device) RenderToBlazon

func (device Device) RenderToBlazon() (string, error)

RenderToBlazon renders a device as its blazon and returns it.

func (Device) RenderToPNG

func (device Device) RenderToPNG() (string, error)

RenderToPNG renders a device as PNG and returns the image

func (Device) Simplify

func (device Device) Simplify() SimplifiedDevice

Simplify returns a simplified device

type SimplifiedDevice

type SimplifiedDevice struct {
	Blazon   string `json:"blazon"`
	ImageURL string `json:"image_url"`
}

SimplifiedDevice is a simplified version of an heraldic device meant for JSON display