sfxr.lua/README.md

sfxr.lua

A port of the sfxr sound effect synthesizer to pure Lua, designed to be used together with the awesome LÖVE game framework.

Demo

To run the demo application you first need to download LoveFrames as a submodule:

git submodule init
love demo

Example usage

These examples should play a randomly generated sound.

With Löve 0.9.x:

local sfxr = require("sfxr")

function love.load()
    local sound = sfxr.newSound()
    sound:randomize()
    sound:play()
end

With lao:

require("ao")
local sfxr = require("sfxr")

local driverId = ao.defaultDriverId()
local device = ao.openLive(driverId, {bits = 16, rate = 44100, channels = 1})

local sound = sfxr.newSound()
sound:randomize()

local buffer = sound:generateString()
device:play(buffer, #buffer)

More documentation is available at the Project Wiki