OpenSheetMusicDisplay (OSMD) ### A MusicXML renderer for the Browser [opensheetmusicdisplay.org](https://opensheetmusicdisplay.org/)
[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/opensheetmusicdisplay/opensheetmusicdisplay?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Appveyor Build status](https://ci.appveyor.com/api/projects/status/r88lnffso55nq1ko?svg=true)](https://ci.appveyor.com/project/sebastianhaas/opensheetmusicdisplay/branch/master) [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
[About OSMD](#about-osmd) • [Demo](#demo) • [Key Features](#key-features) • [Limitations](#limitations) • [How to Use OSMD](#how-to-use-osmd) • [Sponsor OSMD](#sponsor-osmd) • [About Us](#about-us) • [Get In Touch](#get-in-touch) :star: - Star us on Github - It really helps us a lot!
:pray: - [Become our Sponsor](#sponsor-osmd) - Support our work and receive awesome perks! ## About OSMD How OSMD can look in the browser
(Mockup, OSMD on its own does not support playback)

How OSMD can look in the browser
(Mockup, OSMD on its own does not support playback)

OpenSheetMusicDisplay renders MusicXML sheet music in the browser. It is the missing link between [MusicXML](https://www.musicxml.com/) and [VexFlow](https://www.vexflow.com/). Built upon many years of experience in both sheet music interactivity and engraving, it is the perfect solution for app developers seeking to build digital sheet music services. [MusicXML](https://www.musicxml.com/) is the de facto standard for exchanging sheet music between music software.
[VexFlow](https://www.vexflow.com/) is widely used for rendering sheet music. It features an extensive library of musical elements, but each measure and symbol has to be created and positioned by hand in Javascript. OpenSheetMusicDisplay brings the two together and offers an open source turnkey solution for your digital sheet music project. ## Demo Try the [Public Demo](https://opensheetmusicdisplay.github.io/demo/) to see what OSMD can do.
[Learn more about the demo](https://github.com/opensheetmusicdisplay/opensheetmusicdisplay/wiki/Exploring-the-Demo) and OSMD in [the OSMD Wiki](https://github.com/opensheetmusicdisplay/opensheetmusicdisplay/wiki). Developers can also run a [local development demo (see Wiki)](https://github.com/opensheetmusicdisplay/opensheetmusicdisplay/wiki/Debugging-(VSCode)): Local OSMD Developer Demo

## Key Features * Displays MusicXML sheet music in a browser(less) environment (Javascript, Typescript, server-side: browserless NodeJS script) * *Soon: Audio Playback (work in progress, early access build available for [Github sponsors](https://github.com/sponsors/opensheetmusicdisplay))* * Uses [Vexflow](https://www.vexflow.com/) for rendering and (partly) layout * Parses most MusicXML tags and integrates it into an accessible and modifiable data model (e.g. to change a note's color) * Offers many options ([OSMDOptions](https://opensheetmusicdisplay.github.io/classdoc/classes/OSMDOptions.html) / [EngravingRules](https://github.com/opensheetmusicdisplay/opensheetmusicdisplay/blob/master/src/MusicalScore/Graphical/EngravingRules.ts)): Page Format, Font Family, Positioning, not rendering certain elements like the title or lyrics, etc. * Allows modification of the displayed score, like hiding parts or instruments, hiding instrument names, title or composer, a more compact layout, or coloring notes * Outputs SVG or PNG, also via nodejs script in the command line, completely browserless (e.g. for server-side rendering) * Written in [Typescript](https://www.typescriptlang.org/) with complete type information, 100% compatible with Javascript (minified build is .js) * Can display tablature (guitar tabs) from MusicXML, including effects like bends and glissandi. Can be combined with treble clef.

OSMD in the Browser OSMD on Mobile (or server-side rendering)

## Limitations Not all MusicXML tags are (fully) supported: * Pedal marks (currently in early access for sponsors) * Glissando lines * Wavy-line (currently in early access for sponsors) * Etc, see [OSMD 1.0 Project](https://github.com/opensheetmusicdisplay/opensheetmusicdisplay/projects/3) Also, **OSMD is a renderer, not an interactive sheet music editor.** Rendering takes some time, and you can't easily/quickly move notes, place new notes, etc.
(You can, however, manipulate the SVG nodes for instant changes like note re-coloring, see [Exploring the Demo | Wiki](https://github.com/opensheetmusicdisplay/opensheetmusicdisplay/wiki/Exploring-the-Demo)) ## How to Use OSMD * Available as [NPM module](https://www.npmjs.com/package/opensheetmusicdisplay), can be used with plain javascript or module managers like webpack * [Getting Started: Detailed instructions in our Wiki](https://github.com/opensheetmusicdisplay/opensheetmusicdisplay/wiki/Getting-Started) * If you have further technical questions, you can: * [Leave a comment in our Discussions section](https://github.com/opensheetmusicdisplay/opensheetmusicdisplay/discussions/950) (especially for questions of understanding) * [Browse through our Issues](https://github.com/opensheetmusicdisplay/opensheetmusicdisplay/issues?&q=is%3Aissue) * [Open a new issue](https://github.com/opensheetmusicdisplay/opensheetmusicdisplay/issues/new/choose) (may be moved to Discussions). ## Sponsor OSMD

It would be great if free software were sustainable on its own. But to keep on improving and developing OpenSheetMusicDisplay we need your support. Your monthly sponsorship subscription - especially if you are already actively using OSMD - would mean everything to us - it’s a stable way of enabling us to continue our work, and improve and expand OSMD.
New features currently in the making are: * OSMD Audio Player * Transposing Plugin * Annotations (Add custom text, music symbols, etc. to the score and export to and import from XML) Our awesome sponsors get awesome perks, like: * Early Access to features like the Audio Player and a transposition plugin for OSMD * A postcard from Vienna and others. Check them out at [our GitHub sponsors page](https://github.com/sponsors/opensheetmusicdisplay).

OSMD Sponsor perks like this t-shirt OSMD button sponsor perk

And there are other ways to contribute to the community - we plan on starting a blog and newsletter, and sharing our knowledge. We encourage our sponsors to bring up their desired features and pitch blog post ideas. Though we highly recommend the sponsor route, you can also donate via Paypal:
[![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=FPHCYVV2HH8VU)
Any support is highly appreciated. ## About Us OSMD is made by [Phonicscore](https://phonicscore.com/) - a music-tech company based in Vienna. We create solutions for musicians, sheet music publishers, app developers, music stores and researchers: * Open source software * Sheet Music Rendering Software * Native & web apps: [PracticeBird for iOS](https://itunes.apple.com/us/app/practice-bird-pro/id1253492926?ls=1&mt=8) and [Android](https://play.google.com/store/apps/details?id=phonicscore.phonicscore_lite) Our mission is to provide state of the art software solutions for building MusicXML apps and to include the community in a constant thrive for improvement. We want to take away the pain of building music software from scratch and offer a shortcut when it comes to building your next MusicXML sheet music application. We also want to thank [our Github Contributors](https://github.com/opensheetmusicdisplay/opensheetmusicdisplay/graphs/contributors), who show that with open source many people come together to not only share but improve software. ## Get In Touch

To contact us directly, you can: * Use the [Contact form on opensheetmusicdisplay.org](https://opensheetmusicdisplay.org/contact/) to send a mail * Send a mail to support@opensheetmusicdisplay.org * Leave a (public) comment in our [Discussions section](https://github.com/opensheetmusicdisplay/opensheetmusicdisplay/discussions) * [Join our Discord (chat) Server](https://fwd.osmd.org/discord) * [Join the chat on Gitter](https://gitter.im/opensheetmusicdisplay/opensheetmusicdisplay).

	Stars	Issues	Version	Updated	Created
opensheetmusicdisplay	1,365	111	1.8.8	2 months ago	8 years ago
sharp11	333	1	2.0.2	7 years ago	8 years ago
teoria	1,309	25	2.5.0	7 years ago	11 years ago
vexflow	3,805	52	4.2.4	4 days ago	9 years ago

opensheetmusicdisplay vs sharp11 vs teoria vs vexflow

Downloads in past1 Month3 Months6 Months1 Year2 Years5 YearsAll time

Stats

Popular Searches

Sick of boring JavaScript newsletters?

Downloads in past