Guidance for Bards

Bards are HabitRPG contributors who specialize in designing custom musical effects for coming site updates. These effects may include background music, hatching sounds for pets, or simple icon interaction sounds like receiving gold or finding a new drop.

Add a New Sound Theme
First of all, you'll need to clone the git repository and get set up HabitRPG locally. Instructions can be found on the Guidance for Blacksmiths page.

You'll want to do something like this:

$ git checkout -b audio upstream/audio # get your fork of the branch $ git checkout -b add_business_theme audio # create a new feature branch

Now, what code exactly needs to be changed in order to add a new theme?


 * public/js/controllers/settingsCtrl.js. At the bottom of the file, you will find a variable $scope.soundThemes. Simply add a new line for your new theme:

$scope.soundThemes = { 'browserquest': 'BrowserQuest', 'business': 'New Business Theme !', };


 * public/audio/. Create a new directory for your theme (in our example business), and add all the audio files in there.

Note that filenames are important: please name your files the same way files are named in public/audio/browserquest/. Moreover, each file must have 2 extensions, ogg and mp3, in order to be supported in all browsers.

List of Sounds

 * achievement
 * chest
 * downscore
 * heal
 * kill1
 * loot
 * revive
 * upscore
 * to-do:** Add description to each sound (when are they called)

wav to ogg
$ oggenc -q 3 filename.wav

wav to mp3
$ lame -V 5 filename.wav