Skip to content

wearereasonablepeople/bold-sounds

Repository files navigation

Bold sounds

Module to play ambient and effect sounds for the game.

Usage

  1. Get the module

    npm install git+https://github .com/wearereasonablepeople/bold-sounds.git

  2. Copy sprites.mp3 and sprites.webm to your app public folder (e.g /build/audio/) manually or using Webpack.

    cp node_modules/bold-sounds/dist/sprites.* /build/audio/
    
  3. Import the module of your choice (.cjs, .umd or .esm) from /dist folder and play some sounds

import BoldSounds from 'bold-sounds';
const boldSounds = new BoldSounds({src: ['/audio/sprites.mp3', '/audio/sprites.webm']});

boldSounds.init()
.then(() => {
    // at this point audio files are loaded
    // for a list of available sounds see src/sprites.js
    boldSounds.play('badge');

    //to mute all sounds we can do
    boldSounds.mute(true);

    //to unmute all sounds we can do
    boldSounds.mute(false);
});

Logic

  • All ambience- sounds would play in a loop until a different ambience starts to play.

  • All other sounds would just play once and can be combined with ambience or other sounds.

Build

Requires ffmpeg to build sprites

brew install ffmpeg --with-theora --with-libvorbis
npm run build

Sounds loudness normalization

  • For normalizing loudness we can use ffmpeg-normalize tool
  • this command overwrites original file
  • for ambient sounds we use -t -16
  • for effect sounds we use -t -10
pip3 install ffmpeg-normalize
ffmpeg-normalize sounds/input.wav -of ./sounds -ext wav -f -t -16

About

Play ambient and effect sounds for the game

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published