/NeuBox

BeepBox for the desktop, running on Neutralino.JS.

Primary LanguageTypeScriptMIT LicenseMIT

NeuBox

NeuBox is BeepBox repackaged as a desktop application.

NeuBox is currently in very early development. More awesomeness coming soon. View the roadmap to learn more.

BeepBox is developed by John Nesky/shaktool. If you like this project, go throw money at him on his PayPal. NeuBox is developed by TheParadoxBox. I don't have a fancy website.

Compiling

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

git clone https://github.com/TheParadoxBox/NeuBox.git
cd NeuBox
neu update
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 song editor interface. Building the online editor is deprecated, however, and may not work. If for some reason you still want to build the online editor, run:

npm run build-editor

To build the desktop editor, run:

npm run build-client

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 NeuBox 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.