Home

Welcome to the Wiki and Documentation for OpenSheetMusicDisplay (OSMD).

Getting Started

For instructions on how to use OSMD in your software, see Getting Started.

Demo

There's an Online Demo of OSMD's current release version with sample MusicXML files.
In your Browser console, you can access the osmd object.

See Exploring the Demo for some experiments that can help you start coding with OSMD.

To run a local demo and see our latest improvements in the develop branch, see Debugging.

Documentation

• Build Instructions - how to build OSMD for your project
• Debugging (VSCode) - How to debug OSMD using the demo in the browser, with VSCode
• Directory Layout and Code Structure - how code and resources are organised in the repo.
  Also contains descriptions of classes.
• Class Documentation (autogenerated from source code)
• Testing - all about OSMD code testing, visual regression tests, and how to test your changes to the code

These pages could help understanding how OSMD works internally:

• Exploring the Demo - an interactive approach to getting to know OSMD
• How OSMD processes Sheet music - how OSMD transforms MusicXML documents to fully rendered sheet music
• Music Sheet Object Model - for the differences between the music models of OSMD and VexFlow