SixLabors.Fonts 1.0.0-beta18

.NET Core 3.1 .NET Standard 2.0
This is a prerelease version of SixLabors.Fonts.
NuGet\Install-Package SixLabors.Fonts -Version 1.0.0-beta18
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
dotnet add package SixLabors.Fonts --version 1.0.0-beta18
<PackageReference Include="SixLabors.Fonts" Version="1.0.0-beta18" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add SixLabors.Fonts --version 1.0.0-beta18
#r "nuget: SixLabors.Fonts, 1.0.0-beta18"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install SixLabors.Fonts as a Cake Addin
#addin nuget:?package=SixLabors.Fonts&version=1.0.0-beta18&prerelease

// Install SixLabors.Fonts as a Cake Tool
#tool nuget:?package=SixLabors.Fonts&version=1.0.0-beta18&prerelease

SixLabors.Fonts

SixLabors.Fonts

Build Status codecov License: Apache 2.0

GitHub issues GitHub stars GitHub forks

SixLabors.Fonts is a new cross-platform font loading and drawing library.

License

Support Six Labors

Support the efforts of the development of the Six Labors projects.

Documentation

  • Detailed documentation for the Fonts API is available. This includes additional conceptual documentation to help you get started.
  • Our Samples Repository is also available containing buildable code samples demonstrating common activities.

Questions

Code of Conduct

This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community. For more information, see the .NET Foundation Code of Conduct.

Installation

Install stable releases via Nuget; development releases are available via MyGet.

Package Name Release (NuGet) Nightly (MyGet)
SixLabors.Fonts NuGet MyGet

Manual build

If you prefer, you can compile Fonts yourself (please do and help!)

Alternatively, you can work from command line and/or with a lightweight editor on both Linux/Unix and Windows:

To clone Fonts locally, click the "Clone in [YOUR_OS]" button above or run the following git commands:

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).

git config --system core.longpaths true

Submodules

This repository contains git submodules. To add the submodules to the project, navigate to the repository root and type:

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.
  • Loading WOFF2 fonts.
  • Load all compatible fonts from local machine store.
  • Suppord for line breaking based on UAX 14
  • Support for rendering left to right, right to left and bidirectional text.
  • Support for ligatures.
  • Support for advanced OpenType features glyph substitution (GSUB) and glyph positioning (GPOS)

API Examples

Read font description

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

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

The SixLabors.Fonts Team

Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows
.NET Core netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard2.0 netstandard2.1
.NET Framework net461 net462 net463 net47 net471 net472 net48
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen40 tizen60
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (45)

Showing the top 5 NuGet packages that depend on SixLabors.Fonts:

Package Downloads
NPOI The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

.NET port of Apache POI | Contact us on telegram: https://t.me/npoidevs

SixLabors.ImageSharp.Drawing The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

An extension to ImageSharp that allows the drawing of images, paths, and text.

PdfSharpCore

PdfSharp for .NET Core PdfSharpCore is a partial port of PdfSharp.Xamarin for .NET Core Additionally MigraDoc has been ported as well (from version 1.32). Images have been implemented with ImageSharp from https://www.nuget.org/packages/SixLabors.ImageSharp

SixLabors.Shapes.Text The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Allows generating glyphs for text and a fonts for manipulation using SixLabors.Shapes

Stimulsoft.Reports.Engine.NetCore The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

The native .NET Core report engine is a part of the reporting tool for .NET Standard, .NET Core and .NET, that renders reports from getting data from the source, building bands, calculating aggregate functions, charting, applying styles, conditions, filtering, sorting, and more. Also, the report engine has algorithms for exporting reports to various formats such as PDF, Rich Text, Excel, and others.

GitHub repositories (13)

Showing the top 5 popular GitHub repositories that depend on SixLabors.Fonts:

Repository Stars
nissl-lab/npoi
a .NET library that can read/write Office formats without Microsoft Office installed. No COM+, no interop.
peachpiecompiler/peachpie
PeachPie - the PHP compiler and runtime for .NET and .NET Core
Webreaper/Damselfly
Damselfly is a server-based Photograph Management app. The goal of Damselfly is to index an extremely large collection of images, and allow easy search and retrieval of those images, using metadata such as the IPTC keyword tags, as well as the folder and file names. Damselfly includes support for object/face detection, and face-recognition.
swharden/Csharp-Data-Visualization
Resources for visualizing data using C# and the .NET platform
ststeiger/PdfSharpCore
Port of the PdfSharp library to .NET Core - largely removed GDI+ (only missing GetFontData - which can be replaced with freetype2)
Version Downloads Last updated
1.0.0-beta18 53,437 7/22/2022
1.0.0-beta17 276,783 5/18/2022
1.0.0-beta16 758,738 2/9/2022
1.0.0-beta15 657,833 5/20/2021
1.0.0-beta0013 3,359,486 6/18/2020
1.0.0-beta0012 42,397 6/8/2020
1.0.0-beta0011 168,116 5/13/2020
1.0.0-beta0009 1,230,961 9/1/2019
1.0.0-beta0008 805,123 1/25/2019
1.0.0-beta0007 591,759 8/5/2018
1.0.0-beta0006 7,664 6/7/2018
1.0.0-beta0005 1,978,797 5/24/2018
1.0.0-beta0004 3,083 3/27/2018
1.0.0-beta0003 124,016 11/17/2017
1.0.0-beta0002 15,425 9/16/2017
1.0.0-beta0001 22,600 9/13/2017
0.1.0-alpha0016 13,669 7/16/2017
0.1.0-alpha0015 705 6/22/2017
0.1.0-alpha0014 73,283 6/13/2017
0.1.0-alpha0013 681 6/6/2017
0.1.0-alpha0012 676 6/4/2017
0.1.0-alpha0011 243,409 5/30/2017
0.1.0-alpha0010 26,653 5/2/2017
0.1.0-alpha0009 682 4/21/2017
0.1.0-alpha0008 1,834 4/17/2017
0.1.0-alpha0007 678 4/16/2017
0.1.0-alpha0006 706 4/13/2017
0.1.0-alpha0005 793 4/12/2017
0.1.0-alpha0004 723 4/12/2017
0.1.0-alpha0003 690 4/12/2017
0.1.0-alpha0002 20,497 3/12/2017
0.1.0-alpha0001 760 3/5/2017