Iciclecreek.Avalonia.SixelBuffer 1.0.1

dotnet add package Iciclecreek.Avalonia.SixelBuffer --version 1.0.1
                    
NuGet\Install-Package Iciclecreek.Avalonia.SixelBuffer -Version 1.0.1
                    
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.
<PackageReference Include="Iciclecreek.Avalonia.SixelBuffer" Version="1.0.1" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Iciclecreek.Avalonia.SixelBuffer" Version="1.0.1" />
                    
Directory.Packages.props
<PackageReference Include="Iciclecreek.Avalonia.SixelBuffer" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Iciclecreek.Avalonia.SixelBuffer --version 1.0.1
                    
#r "nuget: Iciclecreek.Avalonia.SixelBuffer, 1.0.1"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package Iciclecreek.Avalonia.SixelBuffer@1.0.1
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Iciclecreek.Avalonia.SixelBuffer&version=1.0.1
                    
Install as a Cake Addin
#tool nuget:?package=Iciclecreek.Avalonia.SixelBuffer&version=1.0.1
                    
Install as a Cake Tool

Build and TestNuGet

Logo

Iciclecreek.Avalonia.SixelBuffer

Screenshot

Run your Avalonia applications directly in a terminal using Sixel graphics. This library provides a custom windowing and rendering subsystem that converts Avalonia's Skia output into Sixel image sequences, enabling full GUI applications to run inside a terminal emulator that supports Sixel graphics.

Overview

Iciclecreek.Avalonia.SixelBuffer replaces Avalonia's native windowing platform with a terminal-based implementation:

  • Sixel rendering -- Avalonia controls are rendered via Skia, quantized to a 256-color palette, and output as Sixel escape sequences.
  • Input handling -- Keyboard and mouse input are read from stdin using VT/ANSI escape sequence parsing (including SGR extended mouse tracking).
  • Frame diffing -- Only changed regions are re-rendered, with dirty-rect tracking and SIMD-optimized sixel band construction for performance.
  • Software cursor -- A composited software cursor is drawn into the frame since hardware cursors aren't available in terminal mode.

Requires a Sixel-capable terminal emulator such as Windows Terminal, WezTerm, iTerm2, etc. See https://www.arewesixelyet.com/ for a list of compatible terminals.

Install

dotnet add package Iciclecreek.Avalonia.SixelBuffer 

Configuring Program.cs

Create a new target console application and replace the contents of Program.cs with the following code to initialize Avalonia with the SixelBuffer platform:

using Avalonia;
using Avalonia.Terminal;

internal static class Program
{
    [STAThread]
    private static void Main(string[] args)
    {
        BuildAvaloniaApp()
            .StartWithConsoleLifetime(args);
    }

    public static AppBuilder BuildAvaloniaApp()
    {
        return AppBuilder.Configure<App>()
            .UseStandardRuntimePlatformSubsystem()
            .WithInterFont()
            .UseSixelBuffer();
    }
}

Notes

  • Terminal compatibility -- Your terminal must support Sixel graphics. Tested with Windows Terminal, WezTerm,
  • Render rate -- The default render timer runs at 10 FPS to balance responsiveness with terminal throughput. NOTE: If you set too high input will be starved.
  • No native Menus -- Don't use NativeMenu/NativeMenuItem as they won't work in terminal mode. Use Avalonia's Menu control instead.
  • No native popups -- Popups and dropdown overlays are managed within the single terminal frame rather than as separate OS windows.
  • Avalonia version pinning -- The library uses Avalonia private APIs and must be pinned to the exact Avalonia version (currently 12.0.2).
  • Mouse resolution -- Mouse input is limited to the terminal's reporting resolution, which is the same as the character cell grid. This
  • means you won't get pixel-level mouse coordinates, only the cell coordinates of the terminal.
Product 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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

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
1.0.1 162 4/29/2026
1.0.0 132 4/29/2026