Alternatively, use Figgle's source generator to embed just the fonts you want into your assembly, or—if the text to render is known ahead of time—generate output during compilation, so you don't need to ship Figgle binaries with your app. See below for details.
The library bundles 265 FIGletfonts in the Figgle.Fonts NuGet package. You can add your own if that's not enough!
Figgle ships with a bunch of fonts (in the FiggleFonts class). If you prefer, you can load your own.
Here's an example that loads a font from disk and renders some text with it:
using var fontStream = System.IO.File.OpenRead("myfont.flf");
var font = FiggleFontParser.Parse(fontStream);
var text = font.Render("Hello World, from My Font");
Using the Source Generator
Figgle has two source generators: one renders static text at compile time, the other embeds the font into your assembly.
Static text rendering
If the text you want Figgle to render is known at compile time, this section is for you.
Instead of having Figgle render text at runtime, you can use Figgle's source generator to
do the rendering at compile time. This has two benefits:
Faster runtime performance, as no Figgle code is executed
Less memory consumption, as no Figgle code is loaded
Smaller application footprint, as you don't need to ship Figgle binaries
In your code:
using Figgle;
namespace MyNamespace;
[GenerateFiggleText("HelloWorldString", "blocks", "Hello world")]
internal partial class MyClass
{
}
By adding this attribute to a partial class, Figgle will automatically generate the corresponding
member in another part of the partial class, resembling:
namespace MyNamespace;
partial class MyClass
{
public static string HelloWorldString { get; } = "...rendered text here...";
}
If you want to use an external font, include the external font file as an additional file in your csproj:
Note the font name specified in the GenerateFiggleText attribute is case-insensitive so mycustomfontname works too.
Embedding fonts
If you know the font you want to use to render, but the text to render is dynamic during runtime (e.g. user input),
you can use the source generator to embed the font into your assembly.
By embedding only the fonts you want into your assembly, you can avoid having to ship all of built-in figgle fonts with your application, reducing
the deploy size and memory usage of your application.
In your code:
using Figgle;
namespace MyNamespace;
[EmbedFiggleFont(memberName: "MyFont", fontName: "blocks")]
internal static partial class MyClass
{
}
This will cause the source generator to generate a static property of type FiggleFont in the MyClass type, which you can use to render text:
using Figgle;
namespace MyNamespace;
internal partial class MyClass
{
public static FiggleFont MyFont { get; }
}
You can then use the font the same way you use a built-in font:
using Figgle;
namespace MyNamespace;
string text = MyClass.MyFont.Render("Hello, World!");
Console.WriteLine(text);
Similar to GenerateFiggleText, external fonts are also supported. Include the external font file as an additional file in your csproj
the same way as before:
Then specify the font's font name as specified in AdditionalFiles
(filename without the extension is also recognized if FontName property is not defined):
