Skip to main content

Platforms and packages

alphaTab ships for three ecosystems from one TypeScript source. This page lists every package, what it contains, and which package to install for your runtime.

At a glanceโ€‹

PackageRuns onUI controlRender enginesAudio output
@coderline/alphatabEvergreen browsers, Node.jsAlphaTabApi on any DOM elementSVG, HTML5 Canvas; alphaSkia in Node.jsWeb Audio (browser)
AlphaTab.NET Standard 2.0โ€”Skia, GDI+, SVGโ€”
AlphaTab.Windows.NET 8 on WindowsWPF and WinForms controlsSkia, GDI+, SVGNAudio
net.alphatab:alphaTab-coreJVM 17+โ€”Skia, SVGโ€”
net.alphatab:alphaTabAndroid 8.0+ (API 26)AlphaTabViewSkia, Android Canvas, SVGAndroid AudioTrack

Packages without a UI control are used through the low-level APIs: load files, render to images or SVG, generate MIDI, synthesize and export audio. Packages without an audio output still run the synthesizer; to play its samples, implement ISynthOutput for the sound API of your platform.

Webโ€‹

Start with Installation (Web).

.NETโ€‹

  • AlphaTab targets .NET Standard 2.0 for console tools, servers and headless rendering.
  • AlphaTab.Windows targets .NET 8.0 on Windows and adds the WPF and WinForms controls and NAudio playback. It depends on AlphaTab.
  • AlphaSkia.Native.Windows, AlphaSkia.Native.Linux and AlphaSkia.Native.MacOs provide the native Skia library per operating system. AlphaTab.Windows brings the Windows one.

Start with Installation (.NET).

Kotlinโ€‹

  • net.alphatab:alphaTab-core runs on any JVM 17 or newer, on servers, in command-line tools and in desktop applications. It is the platform-independent part of alphaTab for Kotlin and Java code.
  • net.alphatab:alphaTab is the Android library. It adds the AlphaTabView, the Android canvas and audio output, bundles the Bravura font and the default SoundFont, and depends on alphaTab-core in exactly the same version.
  • net.alphatab:alphaSkia-windows, alphaSkia-linux and alphaSkia-macos provide the native Skia library on the JVM. The Android library brings alphaSkia-android.

There is no UI control for desktop JVM toolkits such as Swing or JavaFX, and none is planned.

Start with Installation (Kotlin).