README.md

Soundbeard - A simple REST based soundboard in nodeJS.

---

Installation

To download all dependencies just run:

$ npm install

Requirements

Due to the usage of mplayer you have to install the MPlayer CLI. For further information look here:

• Install on Ubuntu
• Install on OSX via Homebrew
• Install on Raspberry PI

Get started

Create a config/default.json config file from the sample config and adjust the properties as you like. For example the host and port properties hold the information which ip and port the server binds himself to. The sounds property is the location for the sound files.

After doing that, simply start the server by running:

$ npm start

The board itself

[GET] /

List all available snippets

[GET] /list

Sample response:

{
    "foo.mp3": "http://127.0.0.1:8080/play/foo.mp3",
    "bar.wav": "http://127.0.0.1:8080/play/bar.wav"
}

Play a snippet

[GET] /play/:snippet (:snippet equals the filename i.e. /play/foo.mp3)

Sample response:

{"playing":"foo.mp3"}

Stop playback

[GET] /stop

Text to speech

[POST] /say/

Post data example:

text=hello

Sample response:

{"speaking":"hello"}

Help

[GET] /help.html

License

MIT

Thanks

The bearded cat icon is made with love by Denis Sazhin