ninthdesertdude / beepbox

An online tool for sketching and sharing instrumental melodies.

BeepBox

BeepBox is an online tool for sketching and sharing instrumental melodies. Try it out here!

All song data is packaged into the URL at the top of your browser. When you make changes to the song, the URL is updated to reflect your changes. When you are satisfied with your song, just copy and paste the URL to save and share your song!

BeepBox is a passion project, and will always be free to use. If you find it valuable and have the means, any gratuity via PayPal would be appreciated!

BeepBox is developed by John Nesky. This source code is available under the MIT license.

Compiling

The code is written in TypeScript, which requires Node & npm so install those first. To contribute changes, you'll also need git. Then to build this project, open the command line and run:

git clone https://github.com/johnnesky/beepbox.git
cd beepbox
npm install
npm run build

Code

The code is divided into several folders.

The synth/ folder has just the code you need to be able to play BeepBox songs out loud, and you could use this code in your own projects, like a web game. After compiling the synth code, open website/synth_example.html to see a demo using it. To rebuild just the synth code, run:

npm run build-synth

The editor/ folder has additional code to display the online song editor interface. After compiling the editor code, open website/index.html to see the editor interface. To rebuild just the editor code, run:

npm run build-editor

The player/ folder has a miniature song player interface for embedding on other sites. To rebuild just the player code, run:

npm run build-player

The website/ folder contains index.html files to view the interfaces. The build process outputs JavaScript files into this folder.

Dependencies

Most of the dependencies are listed in package.json, although I'd like to note that BeepBox also has an indirect, optional dependency on lamejs via jsdelivr for exporting .mp3 files. If the user attempts to export an .mp3 file, BeepBox will direct the browser to download that dependency on demand.