joshjcarrier / soundboard

Play your favorite sound bites from a familiar `sbzip` format.

Soundboard 🔊

Play your favorite sound bites from a familiar sbzip format.

Features 📣

• Play sound bites from an uncompressed .sbzip folder
• Hotkey for each sound bite
• Volume for each sound bite
• Color for each sound bite
• Load more than one soundboard archive at a time
• Load directly from .sbzip archive
• Remember last opened archives
• Temporarily lock changes to board
• Edit & save sound bite config back to sbzip
• Create new soundboard

Future Ideas

• Extract sound from Internet source
• Key heatmap/statistics
• Trigger by server API - individual
• Trigger by server API - voting

Install 🔔

Releases not yet available. See Compiling.

Playing an existing soundboard currently requires uncompressing an archive manually to your user's Downloads folder.

unzip MySoundboard.sbzip
mv 0.soundboard/ ~/Downloads/

Resulting directory structure.

+ ~/Downloads/
+-+ 0.soundboard/
  +- Cache/
  | |- ..various..m4a
  +- Prerendered/
  | |- ..various..m4a
  |- Contents.xml

Then launch the app.

If multiple soundboards should be loaded, make a directory structure like this:

+ ~/Downloads/
+-+ 0.soundboard/
+-+ 1.soundboard/
+-+ 2.soundboard/

Contribute 🙉

Compiling

npm install

Both processes have to be started simultaneously in different console tabs:

npm run start-renderer-dev
npm run start-main-dev

This will start the application with hot-reload so you can instantly start developing your application.

You can also run do the following to start both in a single process:

npm run start-dev

Packaging

We use Electron builder to build and package the application. By default you can run the following to package for your current platform:

npm run dist

This will create a installer for your platform in the releases folder.

You can make builds for specific platforms (or multiple platforms) by using the options found here. E.g. building for all platforms (Windows, Mac, Linux):

npm run dist -- -mwl

License 📄

Forked from Robinfr/electron-react-typescript.

MIT © Josh Carrier