Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/drewnoakes/figgle
ASCII banner generation for .NET
https://github.com/drewnoakes/figgle
ascii-art ascii-fonts banner-generator banners figlet
Last synced: 5 days ago
JSON representation
ASCII banner generation for .NET
- Host: GitHub
- URL: https://github.com/drewnoakes/figgle
- Owner: drewnoakes
- License: apache-2.0
- Created: 2017-09-03T08:56:03.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-07-25T03:19:15.000Z (5 months ago)
- Last Synced: 2024-12-02T03:49:58.628Z (10 days ago)
- Topics: ascii-art, ascii-fonts, banner-generator, banners, figlet
- Language: C#
- Homepage:
- Size: 1.04 MB
- Stars: 437
- Watchers: 8
- Forks: 43
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- RSCG_Examples - Figgle,
- csharp-source-generators - Figgle -   - Generate ASCII banner text at compile time (or run time) using figlet fonts. (Source Generators / Console / CLI)
README
```
_____ _ _
| __|_|___ ___| |___
| __| | . | . | | -_|
|__| |_|_ |_ |_|___|
|___|___|
```
[](https://ci.appveyor.com/project/drewnoakes/figgle)
[](https://www.nuget.org/packages/Figgle/)
[](https://www.nuget.org/packages/Figgle/)
## ASCII banner generation for .NET
```c#
Console.WriteLine(
FiggleFonts.Standard.Render("Hello, World!"));
```
Produces...
```
_ _ _ _ __ __ _ _ _
| | | | ___| | | ___ \ \ / /__ _ __| | __| | |
| |_| |/ _ \ | |/ _ \ \ \ /\ / / _ \| '__| |/ _` | |
| _ | __/ | | (_) | \ V V / (_) | | | | (_| |_|
|_| |_|\___|_|_|\___( ) \_/\_/ \___/|_| |_|\__,_(_)
|/
```
Alternatively, use Figgle's source generator to generate output during compilation, so you don't need to ship Figgle binaries with your app. See below for details.
The library bundles 265 [FIGlet](http://www.figlet.org/) [fonts](http://www.jave.de/figlet/fonts.html). You can add your own if that's not enough!
## Installation
Available via [NuGet](https://www.nuget.org/packages/Figgle/):
>Install-Package Figgle
Targets .NET Standard 2.0, so runs pretty much anywhere. If you require .NET Standard 1.3, use package version 0.4.1.
## Other samples
Using `FiggleFonts.Graffiti`:
```
___ ___ .__ .__ __ __ .__ .___._.
/ | \ ____ | | | | ____ / \ / \___________| | __| _/| |
/ ~ \_/ __ \| | | | / _ \ \ \/\/ / _ \_ __ \ | / __ | | |
\ Y /\ ___/| |_| |_( <_> ) \ ( <_> ) | \/ |__/ /_/ | \|
\___|_ / \___ >____/____/\____/ /\ \__/\ / \____/|__| |____/\____ | __
\/ \/ )/ \/ \/ \/
```
Using `FiggleFonts.ThreePoint`:
```
|_| _ || _ \ / _ _| _||
| |(/_||(_), \/\/ (_)| |(_|.
```
Using `FiggleFonts.Ogre`:
```
_ _ __ __ _ _ _
/\ /\___| | | ___ / / /\ \ \___ _ __| | __| | / \
/ /_/ / _ \ | |/ _ \ \ \/ \/ / _ \| '__| |/ _` |/ /
/ __ / __/ | | (_) | \ /\ / (_) | | | | (_| /\_/
\/ /_/ \___|_|_|\___( ) \/ \/ \___/|_| |_|\__,_\/
|/
```
Using `FiggleFonts.Rectangles`:
```
__
_____ _ _ _ _ _ _ _| |
| | |___| | |___ | | | |___ ___| |_| | |
| | -_| | | . |_ | | | | . | _| | . |__|
|__|__|___|_|_|___| | |_____|___|_| |_|___|__|
|_|
```
Using `FiggleFonts.Slant`:
```
__ __ ____ _ __ __ ____
/ / / /__ / / /___ | | / /___ _____/ /___/ / /
/ /_/ / _ \/ / / __ \ | | /| / / __ \/ ___/ / __ / /
/ __ / __/ / / /_/ / | |/ |/ / /_/ / / / / /_/ /_/
/_/ /_/\___/_/_/\____( ) |__/|__/\____/_/ /_/\__,_(_)
|/
```
## Loading external fonts
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:
```c#
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
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:
```c#
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:
```c#
namespace MyNamespace
{
partial class MyClass
{
public static string HelloWorldString { get; } = "...rendered text here...";
}
}
```