AlphaTab 1.9.0-alpha.1963

alphaTab

Music notation, rendered as a first-class SDK.

alphaTab renders interactive sheet music and guitar tablature from Guitar Pro, MusicXML, Capella and alphaTex files, and plays it back with a built-in synthesizer or in sync with your own audio and video. One TypeScript core ships for the web, .NET and Android, with no runtime dependencies and TypeScript types included. Open source since 2010.

Website · Documentation · Playground · Features · Release notes · Discussions

alphaTab draws the score, cursor and selection. The player around it is your own UI, built on alphaTab's API and events.

Highlights

• One score, every notation. Standard notation, guitar and bass tablature, drum tabs, slash notation and numbered notation (jianpu), alone or side by side.
• Plays what it shows. A built-in SoundFont2/SoundFont3 synthesizer, or playback synced to a backing track, an audio file or a video.
• Interactive by design. Beat-accurate cursor, click to seek, range selection and looping, tempo control, count-in and metronome, all exposed as events you subscribe to.
• Layouts that adapt. Page, horizontal and parchment layouts that reflow on resize, down to phone widths.
• Multi-track control. Show, hide, mute and solo tracks at runtime, with per-track volume and transposition.
• Make it yours. Colors per notation element, interchangeable SMuFL music fonts and fine-grained control over what is displayed.
• Edit and export. Modify the data model in code and export to Guitar Pro, alphaTex, MIDI or rendered audio.

Quick start

Install the package:

npm install @coderline/alphatab

Or skip the install and try it from a CDN. Save this as an HTML file and open it in a browser:

<div id="alphaTab">
  \title "Hello alphaTab"
  .
  :4 0.6 1.6 3.6 0.5 2.5 3.5 0.4 2.4 |
     3.4 0.3 2.3 0.2 1.2 3.2 0.1 1.1 |
     3.1.1
</div>
<script type="module">
  import * as alphaTab from 'https://cdn.jsdelivr.net/npm/@coderline/alphatab@latest/dist/alphaTab.min.mjs';
  const api = new alphaTab.AlphaTabApi(document.getElementById('alphaTab'), { tex: true });
</script>

The music inside the <div> is alphaTex, alphaTab's plain-text notation format. Edit it live in the Playground, or continue with the web tutorial to add playback and a player UI.

Using a bundler? The Vite and webpack plugins set up the web workers, audio worklets, fonts and SoundFont for you.

Platforms

The .NET and Kotlin libraries are transpiled from the same TypeScript source, so features and behavior match across platforms.

Packages in this repository

Documentation

• Getting started: installation and configuration for web, .NET and Android.
• Feature catalog: every capability with a live example.
• alphaTex: the syntax reference for writing music as text.
• API reference: settings, events, methods and the data model.
• Tutorials: build a complete player step by step.
• llms.txt: an index of the documentation for AI assistants.

Community

• Built with alphaTab: browse community projects, from practice apps to score editors, in Show and tell.
• Questions and ideas: start a thread in GitHub Discussions or ask on Stack Overflow.
• Bugs: open an issue using the bug template.
• Contributing: read the contribution guidelines and the code of conduct. AI-assisted contributions follow AGENTS.md.

Supporting alphaTab

Due to tax regulations in Austria, where alphaTab is developed, we unfortunately cannot accept donations. If alphaTab is useful to you, please consider donating to a charity of your choice instead. And share what you built in Show and tell: we love to see alphaTab in the wild. A star on GitHub also helps others discover the project.

License

alphaTab is licensed under the Mozilla Public License 2.0. The bundled music fonts Bravura and Petaluma (© Steinberg Media Technologies) and the Noto fonts are licensed under the SIL Open Font License. The bundled SONiVOX SoundFont is licensed under the Apache License 2.0.

Thanks

• BrowserStack for a free plan to test alphaTab on all browsers and operating systems.
• Bernhard Schelling, author of TinySoundFont, and Steve Folta, author of SFZero, whose work forms the core of alphaTab's synthesizer.
• Everyone who contributes code, reports bugs and suggests features.