mrdoob/soundbox

SoundBox is an HTML5 synth music tracker/editor, suitable for creating music for small JavaScript demos (4K / 8K).

SoundBox

SoundBox is a tool for composing synthetic music, in your browser. Its design is basically that of a music tracker, which means that the music is organized in tracks and patterns.

The latest version of SoundBox is served at: sb.bitsnbites.eu.

Running locally

To run your own copy of SoundBox locally, you need to serve it via a web server (using the file:// protocol is not supported).

A simple method is to use Python SimpleHTTPServer (that usually comes preinstalled on Unix-like systems such as macOS and Linux):

cd path/to/soundbox
python -m http.server 8008

Now point your browser to http://localhost:8008/.

License

The SoundBox editor is licensed under the GNU General Public License version 3.

However, the minimal player routine, player-small.js, is released under the zlib/libpng license. This makes it suitable for inclusion in your own software.

Contributing

You are very welcome to contribute with pull requests. When doing so, follow these conventions:

Git commits

• Use proper commit messages, in imperative form.
• Let the Git history of your feature branch follow the recipe model.
• If your commit fixes a reported issue, add "Fixes #14" (where "14" is the issue number) on a separate line in the commit message (in the body part of the comment, not in the summary part).

These are simple, conventional practices that make it easier to keep track of different patches.

Code

• All code is written in pure HTML/JavaScript/CSS, without any third party toolkits or frameworks (though some shims are used for portability). Keep it so.
• Use spaces for indentation (not tabs).
• The player routine is special - it is designed and tuned for being as small and easily compressible (e.g. using GCC and DEFLATE) as possible. Do not add or alter the player routine without careful consideration.