Skip to content

Latest commit

 

History

History
49 lines (27 loc) · 3.47 KB

README.md

File metadata and controls

49 lines (27 loc) · 3.47 KB

flowkey-scraper

I WILL NOT BE PROVIDING SUPPORT FOR THIS TOOL IN MOST CASES. THERE ARE NO GUARANTEES THIS TOOL WILL WORK IN THE FUTURE.


Flowkey scraping to generate sheet music pdf / music xml for a song.

Screenshot from 2021-03-08 22-29-01

Important Notes

Currently I have found it to work at about 95% accuracy on the beginner songs that I am learning. If there are parsing errors, your best bet is to edit the score in Noteflight as needed.

Right now, only 6/8, 2/4, 3/4 and 4/4 time signatures work (as that is all of the music I have looked at so far). If you want a different one, please make an Issue and provide clear info about the piece you are looking at.

I WILL NOT provide support for most erroneous parsing errors. If you are getting such errors, you will need to fix the sheet music yourself as I have not written the music parser being used here. That work is from Audiveris. If you are getting a crash / error before parsing, I might be able to help, but there are no guarantees as music is very difficult to parse properly...

This tool most likely violates the flowkey TOS, so please use at your own risk and please do not abuse the tool. I have made this tool for educational purposes (as I learn piano) since it is a useful way for me to use the flowkey arrangements.

I have heard that if you ask for sheet music from the flowkey support team that they usually will give it to you, so that might be a better approach if you are not tech-savvy or are not sure about the risks.

Getting Started

It is really easy to use this tool, just download the latest version from the Releases Page and make sure you have Java 11 - either JDK 11 OR OpenJDK 11 installed.

Screenshot from 2021-03-08 22-25-59

Screenshot from 2021-03-08 22-26-59

After you've downloaded the latest, just open flowkey and choose a song. There will be a new icon once you have opened a song that looks like a download icon. Just click that icon and you are all set to go.

If something goes wrong, click the little terminal (>_ symbol in the bottom right) icon to get some useful debugging info to share with me.

Dependencies

In order to use this project, you will need to have JDK 11 / OpenJDK 11 installed.

Build Dependencies

To build, you will need nodejs (12+) installed.

Useful Libraries Used