britzl/blip

Blip is a library to procedurally generate and play sound effects for games

Blip

Blip is a library to procedurally generate and play sound effects for games. The library is based on the Sfxr project by Dr.Petter.

Installation

You can use Blip in your own project by adding this project as a Defold library dependency. Open your game.project file and in the dependencies field under project add:

https://github.com/britzl/blip/archive/master.zip

Or point to the ZIP file of a specific release.

Usage

You generate a sound by calling one of the predefined sound effect groups:

local seed = 1234
local wav = blip.explosion(seed)

This will generate a sound effect as a WAV sample using the specified seed. The seed is a number that is used to generate a specific version of the sound effect. Passing in a certain seed will always result in the same sound. Use the example app to find seeds that you like and use them in your own project.

Once you have a sound effect that you like you set it on an existing sound component and play the sound:

-- set the sound data on the sound component #sound
local resource_path = go.get("#sound", "sound")
resource.set_sound(resource_path, wav)

-- play the sound
sound.play("#sound")

Try it!

Try the HTML5 version of the example app.

blip's Issues

No sound on Mac

Demo on web doesn't play sound.

Added it as library to my own project, executed code. Originally errors - those are gone with the recent update. Still no actual sound. Rebooted to ensure no local issue...

Several of the sounds seem to crash the example project

jump, explosion, laser all crash
clicking random seed also causes crashes

tested on Windows 11

Having a sound component and using blip crashes the game

First, thank you for create a great asset :)

I'm having a problem where I'm using a sound component to play bg-music.
As soon as I call blip from a script e.g. local hurt_sound = blip.hurt(3185);, my game crashes.
If I remove either blip or the sound component, the games runs just file.

INFO:ENGINE: Defold Engine 1.2.164 (2be2687)
INFO:ENGINE: Loading data from: build/default
INFO:ENGINE: Initialised sound device 'default'

Registered lua_script_instance Extension
INFO:DLIB: SSDP: Started on address 192.168.178.16
INFO:BLIP: newSource alGenSources
ERROR:SOUND: Invalid Name
Assertion failed: (Capacity() - Size() > 0), function Push, file /Users/builder/ci/builds/engine-darwin-64-master/build/tmp/dynamo_home/sdk/include/dmsdk/dlib/array.h, line 471.
INFO:CRASH: Successfully wrote Crashdump to file: /Users/wilcoverhoeven/Library/Application Support/Defold/_crash
ERROR:CRASH: CALL STACK:

# 0 pc   0x17f1fb3d DSExternalDisplay _sigtramp+29

Example project has a sounds folder set in the custom resources but it's not included in the repo

Causes editor to complain when building, user needs to create folder themselves, can include a dummy file in the folder to include it, it can be a readme.txt saying to edit the source to enable saving of generated files which is disabled by default

Passing own sound data?

Is there a way to pass my own sound data rather than use the presets? blip.create?

Most of the seeds cause error on Windows 10

I cloned this project to try to find a seed for my project that uses blip, but on Windows, practically every seed causes the error both in my project and example project from this repo:

bad argument #1 to 'play' (userdata expected, got nil)