Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/adrg/sysfont

Golang identification and matching of system fonts
https://github.com/adrg/sysfont

cross-platform font font-alternatives font-defaults font-identification font-list font-match fonts go golang identification installed-font-detection installed-fonts matching multiple-os os-fonts

Last synced: 2 months ago
JSON representation

Golang identification and matching of system fonts

Host: GitHub
URL: https://github.com/adrg/sysfont
Owner: adrg
License: mit
Created: 2019-11-29T10:55:38.000Z (about 5 years ago)
Default Branch: master
Last Pushed: 2024-04-10T08:36:08.000Z (10 months ago)
Last Synced: 2024-06-18T15:38:28.141Z (8 months ago)
Topics: cross-platform, font, font-alternatives, font-defaults, font-identification, font-list, font-match, fonts, go, golang, identification, installed-font-detection, installed-fonts, matching, multiple-os, os-fonts
Language: Go
Homepage: https://pkg.go.dev/github.com/adrg/sysfont
Size: 110 KB
Stars: 41
Watchers: 4
Forks: 13
Open Issues: 8
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        sysfont

=======

[![Build Status](https://github.com/adrg/sysfont/workflows/CI/badge.svg)](https://github.com/adrg/sysfont/actions?query=workflow%3ACI)

[![pkg.go.dev documentation](https://pkg.go.dev/badge/github.com/adrg/sysfont)](https://pkg.go.dev/github.com/adrg/sysfont)

[![MIT license](https://img.shields.io/github/license/adrg/sysfont)](https://opensource.org/licenses/MIT)

[![Go report card](https://goreportcard.com/badge/github.com/adrg/sysfont)](https://goreportcard.com/report/github.com/adrg/sysfont)

[![GitHub issues](https://img.shields.io/github/issues/adrg/sysfont)](https://github.com/adrg/sysfont/issues)

[![Buy me a coffee](https://img.shields.io/static/v1.svg?label=%20&message=Buy%20me%20a%20coffee&color=579fbf&logo=buy%20me%20a%20coffee&logoColor=white)](https://ko-fi.com/T6T72WATK)

sysfont is a small package that makes it easy to identify installed fonts. It

is useful for listing installed fonts or for matching fonts based on user

queries. The matching process also suggests viable font alternatives.

The package uses a collection of standard fonts compiled from the

[os-font-list](https://github.com/adrg/os-font-list) project along with string

processing and similarity metrics for scoring font matches, in order to account

for partial or inexact input queries.

Full documentation can be found at: https://pkg.go.dev/github.com/adrg/sysfont.

## Installation

```

go get github.com/adrg/sysfont

```

## Usage

#### List fonts

```go

finder := sysfont.NewFinder(nil)

for _, font := range finder.List() {

    fmt.Println(font.Family, font.Name, font.Filename)

}

```

#### Match fonts

The matching process has three steps. Identification of the best matching

installed font, based on the specified query, is attempted first. If no close

match is found, alternative fonts are searched. If no alternative font is

found, a suitable default font is returned.

```go

finder := sysfont.NewFinder(nil)

terms := []string{

    "AmericanTypewriter",

    "AmericanTypewriter-Bold",

    "Andale",

    "Arial",

    "Arial Bold",

    "Arial-BoldItalicMT",

    "ArialMT",

    "Baskerville",

    "Candara",

    "Corbel",

    "Gill Sans",

    "Hoefler Text Bold",

    "Impact",

    "Palatino",

    "Symbol",

    "Tahoma",

    "Times",

    "Times Bold",

    "Times BoldItalic",

    "Times Italic Bold",

    "Times Roman",

    "Verdana",

    "Verdana-Italic",

    "Webdings",

    "ZapfDingbats",

}

for _, term := range terms {

    font := finder.Match(term)

    fmt.Printf("%-30s -> %-30s (%s)\n", term, font.Name, font.Filename)

}

```

Output:

![sysfont test output minimal](https://raw.githubusercontent.com/adrg/adrg.github.io/master/assets/projects/sysfont/output_minimal.png)

A more comprehensive test made on Ubuntu:

![sysfont test output full](https://raw.githubusercontent.com/adrg/adrg.github.io/master/assets/projects/sysfont/output-full.png)

## References

For more information see:

- [os-font-list](https://github.com/adrg/os-font-list)

- [strutil](https://github.com/adrg/strutil)

- [xdg](https://github.com/adrg/xdg)

## Contributing

Contributions in the form of pull requests, issues or just general feedback,

are always welcome.  

See [CONTRIBUTING.MD](CONTRIBUTING.md).

## License

Copyright (c) 2019 Adrian-George Bostan.

This project is licensed under the [MIT license](https://opensource.org/licenses/MIT).

See [LICENSE](LICENSE) for more details.