Slarmoo's Box

Slarmoo's Box is an online tool for sketching and sharing instrumental music. You can find it here. It is a modification of Ultrabox, which is a modification of JummBox, which inturn is a modification of the original BeepBox.

Slarmoo's Box is a mod of Ultrabox that aims to advance Beepbox's capabilities. Feel free to contribute!

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!

Slarmoo's Box, as well as the beepmods which it's based on, are free projects. If you ever feel so inclined, please support the original creator, John Nesky, via PayPal!

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 a command line (Git Bash) and run:

git clone https://github.com/slarmoo/slarmoosbox.git
cd slarmoosbox
npm install
npm run build

JummBox (and by extension, Slarmoo's Box) makes a divergence from BeepBox that necessitates an additional dependency: rather than using the (rather poor) default HTML select implementation, the custom library select2 is employed. select2 has an explicit dependency on jQuery as well, so you may need to install the following 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 Slarmoo's Box 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 Slarmoo's Box also has an indirect, optional dependency on lamejs via jsdelivr for exporting .mp3 files. If the user attempts to export an .mp3 file, Slarmoo's Box will direct the browser to download that dependency on demand. Additionally, random envelopes rely on js-xxhash for fast hashing.

Offline version

If you'd like to BUILD the offline version, enter the following into the command line of your choice:

npm run build-offline

After building, you can then enter the following to run it for testing purposes:

cd offline
npm run start

And to package, run (do npm run package-host for your host platform; you may need to run git bash as an administrator for non-host platforms):

cd offline
npm run package