Consolonia.Imaging
12.1.4.17
dotnet add package Consolonia.Imaging --version 12.1.4.17
NuGet\Install-Package Consolonia.Imaging -Version 12.1.4.17
<PackageReference Include="Consolonia.Imaging" Version="12.1.4.17" />
<PackageVersion Include="Consolonia.Imaging" Version="12.1.4.17" />
<PackageReference Include="Consolonia.Imaging" />
paket add Consolonia.Imaging --version 12.1.4.17
#r "nuget: Consolonia.Imaging, 12.1.4.17"
#:package Consolonia.Imaging@12.1.4.17
#addin nuget:?package=Consolonia.Imaging&version=12.1.4.17
#tool nuget:?package=Consolonia.Imaging&version=12.1.4.17
Consolonia.Imaging
Real pixels for pictures in Consolonia apps, on terminals that support the kitty graphics protocol or sixel.
Without this package, Consolonia draws an Image as block glyphs: each cell shows a quarter-block
character in two of the picture's colours. With it, terminals that can show images get the picture
itself:
- Kitty graphics (kitty, WezTerm, Ghostty, Konsole and others): pictures are placed below the text, so text, borders and the mouse cursor show over them.
- Sixel (Windows Terminal, foot, mlterm, xterm with sixel and others): each cell is either picture or text; a glyph over a picture sits on the picture's colour.
Which one is used is detected when the console starts. Terminals with neither keep block glyphs.
Getting started
Enable it in your app startup, anywhere in the builder chain:
using Avalonia;
using Consolonia;
public static class Program
{
public static void Main(string[] args)
{
BuildAvaloniaApp().StartWithConsoleLifetime(args);
}
public static AppBuilder BuildAvaloniaApp() =>
AppBuilder.Configure<App>()
.UseConsolonia()
.UseAutoDetectedConsole()
.UseConsoloniaImaging(); // <= pictures as pixels where the terminal can show them
}
Choosing the protocol
Detection can be overridden with the CONSOLONIA_GRAPHICS environment variable, for terminals that
show a protocol without answering its query, or to force the fallback:
| Value | Effect |
|---|---|
kitty |
Use kitty graphics. |
sixel |
Use sixel, even if the terminal also has kitty graphics. |
quad |
Use block glyphs. |
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
-
net8.0
- Avalonia (>= 12.1.4)
- Consolonia.Controls (>= 12.1.4.17)
- Consolonia.Core (>= 12.1.4.17)
- JeremyAnsel.ColorQuant (>= 3.0.74)
- System.IO.Hashing (>= 8.0.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
| Version | Downloads | Last Updated |
|---|---|---|
| 12.1.4.17 | 53 | 11/16/2026 |