clockfort / jummbox

An online tool for sketching and sharing instrumental melodies.

Home Page:https://jummbus.bitbucket.io/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

JummBox

JummBox is an online tool for sketching and sharing instrumental music. Try it out here! It is a modification of the original BeepBox, focused on improving ease-of-use.

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, and JummBox by extension, are passion projects and will always be free to use. If you find it valuable and have the means, please support the original creator, John Nesky, via PayPal! JummBox is developed by Jummbus.

Compiling

The compilation procedure is identical to the repository for BeepBox. I will include the excerpt on compiling from that page's readme below for convenience:

The source code is available under the MIT license. The code is written in TypeScript, which requires node & npm, so install those first. Then to build this project, open the command line and run:

git clone https://github.com/jummbus/jummbox.git
cd jummbox
npm install
npm run build

A note for JummBox: You may also have to install these additional dependencies if they are not picked up automatically.

npm install select2
npm install @types/select2
npm install @types/jquery

Code

The code is divided into several folders. This architecture is identical to BeepBox's.

The synth/ folder has just the code you need to be able to play JummBox 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 JummBox also has an indirect, optional dependency on lamejs via jsdelivr for exporting .mp3 files. If the user attempts to export an .mp3 file, JummBox will direct the browser to download that dependency on demand.

About

An online tool for sketching and sharing instrumental melodies.

https://jummbus.bitbucket.io/

License:MIT License


Languages

Language:TypeScript 62.2%Language:HTML 37.7%Language:Shell 0.1%Language:JavaScript 0.0%