2020-11-27 19:14:02 +01:00
# == THE URL HAS CHANGED ==
2020-12-12 21:07:02 +01:00
This **PianoBooster** repository has now been transferred to @pianobooster as the new owner.
2020-11-27 19:14:02 +01:00
Please update all your bookmarks and [update ](https://docs.github.com/en/free-pro-team@latest/github/using-git/changing-a-remotes-url ) any existing local clones to point to the new repository URL https://github.com/pianobooster/PianoBooster
2019-06-03 00:24:15 +02:00
![logo ](logo/Logotype_horizontal.png )
2018-05-20 22:25:42 +02:00
2018-05-11 17:20:43 +02:00
2020-11-25 22:17:20 +01:00
# INTRODUCTION
2018-05-11 17:20:43 +02:00
2020-12-12 21:07:02 +01:00
**PianoBooster** is a MIDI file player that displays the musical notes AND teaches you how to
2020-11-25 22:29:32 +01:00
play the piano.
2020-11-25 22:17:20 +01:00
The difference between playing along to a CD or a standard MIDI file
is that Piano Booster listens and reacts to what you are playing on a
MIDI piano keyboard.
2020-12-12 21:07:02 +01:00
You can play along to any track in the MIDI file and Piano Booster will
2020-11-25 22:17:20 +01:00
follow your playing. Piano Booster makes learning to sight read fun!
2020-12-12 21:07:02 +01:00
Piano Booster is a free (Open Source) program, available from: < https: / / www . pianobooster . org / >
2020-11-25 22:17:20 +01:00
# FEATURES
* The musical accompaniment follows your playing, if you stop then so does the music.
* Play a single hand and Piano Booster will play the other hand in time with you.
* Change the speed of playback to match your playing ability.
* Transpose +/- 12 semitones without stopping the play back.
* Plays any standard MIDI or KAR file.
* Play along to any instrument in the MIDI file.
* Adjust the volume of the current part or the volume of your piano part.
* Measures the accuracy of your playing.
* Timing markers show if you are playing ahead or behind the beat.
* A different instrument sound is used for the right and wrong notes that you play on the piano.
# GETTING STARTED
2020-12-12 21:07:02 +01:00
Binary executable version of **PianoBooster** are available for Windows, MacOS and Linux, which can be downloaded from the [Piano Booster website ](<https://www.pianobooster.org/> ).
Piano Booster now includes a built in version of the FluidSynth sound generator.
In order for FluidSynth to work and to hear sound a `.sf2` (sound font) file is required which must be loaded using the MIDI Setup/Fluidsynth menu of Piano Booster.
A recommended General Midi (GM) sound font file is the `FluidR3_GM.sf2`
2020-11-25 22:17:20 +01:00
2020-12-12 21:07:02 +01:00
To play along with **PianoBooster** you will need a MIDI Piano Keyboard.
If you don't have a MIDI keyboard you can still try out Piano Booster using the PC keyboard, 'x' is middle C - but a MIDI piano is highly recommended.
2020-11-25 22:17:20 +01:00
After connecting the MIDI keyboard you need to setup the midi input device using
the Piano Booster MIDI setup menu.
2020-12-12 21:07:02 +01:00
**PianoBooster** now comes with a music teaching course called Booster Music.
2020-11-25 22:17:20 +01:00
The MIDI files for this course are in a folder called `BoosterMusicBooks` located in the `Music` folder on your PC.
2020-12-12 21:07:02 +01:00
The Booster Music teaching course is also available on the [Piano Booster website ](<https://www.pianobooster.org/> ).
2020-11-25 22:17:20 +01:00
Use the File/Open from the Piano Booster menu to load the MIDI file ".mid" or a karaoke ".kar" file.
Finally choose the skill level, if you want to
just listen to the MIDI music - select 'listen', to play along with a MIDI keyboard with
the music following your playing - select 'follow you' and then click on the Play icon to
2018-05-11 17:20:43 +02:00
start.
2020-11-25 22:17:20 +01:00
# TRANSLATIONS
2018-05-24 20:07:04 +02:00
2020-12-12 21:07:02 +01:00
**PianoBooster** isn't translated in your language? Help us, and we will gladly ship
2020-02-06 16:00:19 +01:00
new translations with it.
2019-07-08 14:47:27 +02:00
2020-11-25 22:17:20 +01:00
Please see the [Web-based continuous localisation ](https://hosted.weblate.org/projects/pianobooster/ ) (Weblate) to contribute to the language translations.
The translation required for the Piano Booster app are located [here ](https://hosted.weblate.org/projects/pianobooster/pianobooster/ ) and the translation for the Booster Music course are located [here ](https://hosted.weblate.org/projects/pianobooster/boostermusic/ ).
2018-05-11 17:20:43 +02:00
2020-11-25 22:17:20 +01:00
# LICENSE
2020-12-12 21:07:02 +01:00
**PianoBooster** is fully copyrighted by the authors and all rights are reserved.
2018-05-11 17:20:43 +02:00
2020-12-12 21:07:02 +01:00
**PianoBooster** is free software (Open Source software): you can redistribute it and/or modify
2018-05-11 17:20:43 +02:00
it under the terms of the GNU General Public License as published by the Free Software
Foundation, either version 3 of the License, or (at your option) any later version.
2020-12-12 21:07:02 +01:00
**PianoBooster** is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
2018-05-11 17:20:43 +02:00
without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU General Public License in the file "gplv3.txt" or from the web site
2019-06-06 08:57:18 +02:00
< http: // www . gnu . org / licenses /> or [gplv3.txt ](gplv3.txt ).
2018-05-11 17:20:43 +02:00
2020-12-12 21:07:02 +01:00
The **PianoBooster** documentation and music are released under the Creative Commons License (CC-BY).
2019-06-21 05:42:38 +02:00
2019-06-06 08:57:18 +02:00
[PianoBooster License ](license.txt )
2018-05-11 17:20:43 +02:00
2023-06-27 20:09:45 +02:00
## Attribution for 3rd party content
The icons found under `images/breeze` are taken from the
[KDE/Breeze ](https://invent.kde.org/frameworks/breeze-icons ) project. The icon
`media-playback-from-start.svg` is not an exact copy but made of elements from Breeze icons.
2020-11-25 22:17:20 +01:00
# SOURCE CODE
2019-06-13 07:55:18 +02:00
2020-12-12 21:07:02 +01:00
As part of GNU General Public License the source code for **PianoBooster** is available from
2020-11-25 22:29:32 +01:00
the GitHub site < https: // github . com / pianobooster / PianoBooster > . See the [BUILD.md ](BUILD.md ) for
2018-05-11 17:20:43 +02:00
instructions on how to build the source code.
2019-06-03 04:14:51 +02:00
2020-12-12 21:07:02 +01:00
This source code URL has recently changed so please update all your bookmarks and change any existing local clones to point to the new repository URL.
2019-06-03 04:14:51 +02:00
2020-11-25 22:17:20 +01:00
# BUGTRACKER
2019-06-03 04:14:51 +02:00
2020-11-25 22:29:32 +01:00
[Issues ](https://github.com/pianobooster/PianoBooster/issues )
2019-06-03 04:14:51 +02:00
2020-11-25 22:17:20 +01:00
# CONTRIBUTING
2019-06-03 04:14:51 +02:00
2020-12-12 21:07:02 +01:00
**PianoBooster** is community developing project. You're welcome with patches:
2019-06-03 04:52:55 +02:00
2020-11-25 22:29:32 +01:00
[Pull Requests ](https://github.com/pianobooster/PianoBooster/pulls )
2019-06-06 09:22:50 +02:00
2020-11-25 22:29:32 +01:00
We have many [issues ](https://github.com/pianobooster/PianoBooster/issues ) always.
2019-06-06 09:22:50 +02:00
2021-01-08 07:06:05 +01:00
We are looking for musicians to make music for pianobooster. It can be educational courses or other melodies: [music sources ](https://github.com/pianobooster/BoosterMusic ).
2019-06-13 01:13:26 +02:00
2019-06-06 09:22:50 +02:00
2020-11-25 22:17:20 +01:00
Thanks to everyone who has already made contributions to the Piano Booster project.