Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/SixLabors/Fonts
:black_nib: Font loading and layout library.
https://github.com/SixLabors/Fonts
dotnet font netstandard opentype truetype woff woff2
Last synced: 28 days ago
JSON representation
:black_nib: Font loading and layout library.
- Host: GitHub
- URL: https://github.com/SixLabors/Fonts
- Owner: SixLabors
- License: other
- Created: 2017-02-04T10:16:12.000Z (almost 8 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T08:34:09.000Z (about 1 month ago)
- Last Synced: 2024-10-29T09:52:27.528Z (about 1 month ago)
- Topics: dotnet, font, netstandard, opentype, truetype, woff, woff2
- Language: C#
- Homepage: https://sixlabors.com/products/fonts
- Size: 27.9 MB
- Stars: 305
- Watchers: 20
- Forks: 71
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-typography - SixLabors.Fonts - Font loading and drawing library. (C#)
README
SixLabors.Fonts
[](https://github.com/SixLabors/Fonts/actions)
[](https://codecov.io/gh/SixLabors/Fonts)
[](https://github.com/SixLabors/Fonts/blob/main/LICENSE)
[](https://github.com/SixLabors/Fonts/issues)
[](https://github.com/SixLabors/Fonts/stargazers)
[](https://github.com/SixLabors/Fonts/network)
**SixLabors.Fonts** is a new cross-platform font loading and drawing library.
## License
- Fonts is licensed under the [Six Labors Split License, Version 1.0](https://github.com/SixLabors/Fonts/blob/main/LICENSE)
## Support Six Labors
Support the efforts of the development of the Six Labors projects.
- [Purchase a Commercial License :heart:](https://sixlabors.com/pricing/)
- [Become a sponsor via GitHub Sponsors :heart:]( https://github.com/sponsors/SixLabors)
- [Become a sponsor via Open Collective :heart:](https://opencollective.com/sixlabors)
## Documentation
- [Detailed documentation](https://sixlabors.github.io/docs/) for the Fonts API is available. This includes additional conceptual documentation to help you get started.
- Our [Samples Repository](https://github.com/SixLabors/Samples/tree/main/ImageSharp) is also available containing buildable code samples demonstrating common activities.
## Questions
- Do you have questions? We are happy to help! Please [join our Discussions Forum](https://github.com/SixLabors/Fonts/discussions/category_choices).
- Please read our [Contribution Guide](https://github.com/SixLabors/Fonts/blob/main/.github/CONTRIBUTING.md) before opening issues or pull requests!
## Code of Conduct
This project has adopted the code of conduct defined by the [Contributor Covenant](https://contributor-covenant.org/) to clarify expected behavior in our community.
## Installation
Install stable releases via Nuget; development releases are available via Feedz.io.
| Package Name | Release (NuGet) | Nightly (Feedz.io) |
|--------------------------------|-----------------|-----------------|
| `SixLabors.Fonts` | [](https://www.nuget.org/packages/SixLabors.Fonts/) | [](https://f.feedz.io/sixlabors/sixlabors/nuget/index.json) |
## Manual build
If you prefer, you can compile Fonts yourself (please do and help!)
- Using [Visual Studio 2022](https://visualstudio.microsoft.com/vs/)
- Make sure you have the latest version installed
- Make sure you have [the .NET 7 SDK](https://www.microsoft.com/net/core#windows) installed
Alternatively, you can work from command line and/or with a lightweight editor on **both Linux/Unix and Windows**:
- [Visual Studio Code](https://code.visualstudio.com/) with [C# Extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.csharp)
- [.NET Core](https://www.microsoft.com/net/core#linuxubuntu)
To clone Fonts locally, click the "Clone in [YOUR_OS]" button above or run the following git commands:
```bash
git clone https://github.com/SixLabors/Fonts
```
If working with Windows please ensure that you have enabled log file paths in git (run as Administrator).
```bash
git config --system core.longpaths true
```
### Submodules
This repository contains [git submodules](https://blog.github.com/2016-02-01-working-with-submodules/). To add the submodules to the project, navigate to the repository root and type:
``` bash
git submodule update --init --recursive
```
### Features
- Reading font description (name, family, subname etc plus other string metadata).
- Loading OpenType fonts with with CFF1 and True Type outlines.
- Loading True Type fonts.
- Loading [WOFF fonts](https://www.w3.org/Submission/WOFF/).
- Loading [WOFF2 fonts](https://www.w3.org/TR/WOFF2).
- Load all compatible fonts from local machine store.
- Support for line breaking based on [UAX 14](https://www.unicode.org/reports/tr14/)
- Support for rendering left to right, right to left and bidirectional text.
- Support for ligatures.
- Support for advanced OpenType features glyph substitution ([GSUB](https://docs.microsoft.com/en-us/typography/opentype/spec/gsub)) and glyph positioning ([GPOS](https://docs.microsoft.com/en-us/typography/opentype/spec/gpos))
## API Examples
### Read font description
```c#
FontDescription description = null;
using(var fs = File.OpenRead("Font.ttf")){
description = FontDescription.Load(fs); // once it has loaded the data the stream is no longer required and can be disposed of
}
string name = description.FontName(CultureInfo.InvariantCulture);
```
### Populating a font collection
```c#
FontCollection fonts = new FontCollection();
FontFamily font1 = fonts.Add("./path/to/font1.ttf");
FontFamily font2 = fonts.Add("./path/to/font2.woff");
```
### How can you help?
Please... Spread the word, contribute algorithms, submit performance improvements, unit tests.
### Projects using SixLabors.Fonts
* [SixLabors.ImageSharp.Drawing](https://github.com/SixLabors/ImageSharp.Drawing) - cross platform, fully managed, image drawing library.
### The SixLabors.Fonts Team
- [Scott Williams](https://github.com/tocsoft)
- [Dirk Lemstra](https://github.com/dlemstra)
- [Anton Firsov](https://github.com/antonfirsov)
- [James Jackson-South](https://github.com/jimbobsquarepants)
- [Brian Popow](https://github.com/brianpopow)