pokedex

Documentation

Index

• Variables
• func CategoryDirpath(subdir string, cat string) string
• func CategoryFpath(subdir string, category string, fname string) string
• func Check(e error)
• func Compress(data []byte) []byte
• func ConvertPngToCow(sourceDirpath string, sourceFpath string, destDirpath string, extraPadding int) (string, error)
• func CreateCategoryStruct(rootDir string, metadata []PokemonMetadata, debug bool) []string
• func Decompress(data []byte) []byte
• func EntryFpath(subdir string, idx int) string
• func FindFiles(dirpath string, ext string, skip []string) []string
• func GatherMapKeys[T any](m map[string]T) []string
• func MetadataFpath(subdir string, idx int) string
• func ReadIntFromBytes(bs []byte) int
• func ReadNames(fpath string) map[string]PokemonName
• func ReadPokemonCow(embeddedData embed.FS, fpath string) []byte
• func ReadStructFromBytes[T any](data []byte) T
• func StructToJSON(obj interface{}, indentation ...int) string
• func WriteBytesToFile(data []byte, fpath string, compress bool)
• func WriteIntToFile(n int, fpath string)
• func WriteStructToFile(obj interface{}, fpath string)
• func WriteToCowfile(data string, destDirpath string, destFpath string)
• type DataEntry
• type PokemonEntryMapping
• type PokemonMetadata
  • func CreateNameMetadata(idx string, key string, name PokemonName, rootDir string, fpaths []string) *PokemonMetadata
  • func NewMetadata(idx string, name string, japaneseName string, japanesePhonetic string, ...) *PokemonMetadata
  • func ReadMetadataFromBytes(data []byte) PokemonMetadata
  • func ReadMetadataFromEmbedded(embeddedData embed.FS, fpath string) PokemonMetadata
  • func ReadMetadataFromFile(fpath string) PokemonMetadata
• type PokemonName
  • func NewPokemonName(entry DataEntry) *PokemonName

Variables

var (
	COLOUR_RESET string = fmt.Sprintf("%s[%dm\n", "\x1b", 39)
)

Functions

func CategoryDirpath

func CategoryDirpath(subdir string, cat string) string

func CategoryFpath

func CategoryFpath(subdir string, category string, fname string) string

func Check

func Check(e error)

func Compress

func Compress(data []byte) []byte

func ConvertPngToCow

func ConvertPngToCow(sourceDirpath string, sourceFpath string, destDirpath string, extraPadding int) (string, error)

func CreateCategoryStruct

func CreateCategoryStruct(rootDir string, metadata []PokemonMetadata, debug bool) []string

func Decompress

func Decompress(data []byte) []byte

func EntryFpath

func EntryFpath(subdir string, idx int) string

func FindFiles

func FindFiles(dirpath string, ext string, skip []string) []string

func GatherMapKeys

func GatherMapKeys[T any](m map[string]T) []string

func MetadataFpath

func MetadataFpath(subdir string, idx int) string

func ReadIntFromBytes

func ReadIntFromBytes(bs []byte) int

func ReadNames

func ReadNames(fpath string) map[string]PokemonName

func ReadPokemonCow

func ReadPokemonCow(embeddedData embed.FS, fpath string) []byte

func ReadStructFromBytes

func ReadStructFromBytes[T any](data []byte) T

func StructToJSON

func StructToJSON(obj interface{}, indentation ...int) string

func WriteBytesToFile

func WriteBytesToFile(data []byte, fpath string, compress bool)

func WriteIntToFile

func WriteIntToFile(n int, fpath string)

func WriteStructToFile

func WriteStructToFile(obj interface{}, fpath string)

func WriteToCowfile

func WriteToCowfile(data string, destDirpath string, destFpath string)

Types

type DataEntry

type DataEntry struct {
	Name struct {
		Eng    string `json:"eng"`
		Jpn    string `json:"jpn"`
		Jpn_ro string `json:"jpn_ro"`
	} `json:"name"`
	Slug struct {
		Eng    string `json:"eng"`
		Jpn    string `json:"jpn"`
		Jpn_ro string `json:"jpn_ro"`
	} `json:"slug"`
}

{
  "name": { "eng": "Charizard", "chs": "喷火龙", "jpn": "リザードン", "jpn_ro": "Lizardon" }
  "slug": { "eng": "charizard",                  "jpn": "riza-don",   "jpn_ro": "lizardon" }
}

Out of all these names, we want the name.jpn, name.jpn_ro, slug.eng,

type PokemonEntryMapping

type PokemonEntryMapping struct {
	EntryIndex int
	Categories []string
}

type PokemonMetadata

type PokemonMetadata struct {
	Idx              string
	Name             string
	JapaneseName     string
	JapanesePhonetic string
	Entries          []PokemonEntryMapping
}

func CreateNameMetadata

func CreateNameMetadata(idx string, key string, name PokemonName, rootDir string, fpaths []string) *PokemonMetadata

func NewMetadata

func NewMetadata(idx string, name string, japaneseName string, japanesePhonetic string, entryMap map[int][][]string) *PokemonMetadata

func ReadMetadataFromBytes

func ReadMetadataFromBytes(data []byte) PokemonMetadata

func ReadMetadataFromEmbedded

func ReadMetadataFromEmbedded(embeddedData embed.FS, fpath string) PokemonMetadata

func ReadMetadataFromFile

func ReadMetadataFromFile(fpath string) PokemonMetadata

type PokemonName

type PokemonName struct {
	English          string
	Japanese         string
	JapanesePhonetic string
	Slug             string
}

func NewPokemonName

func NewPokemonName(entry DataEntry) *PokemonName