library-mirrors/sfxr.lua
1
0
Fork 0
mirror of https://github.com/nucular/sfxrlua.git synced 2024-12-24 18:44:20 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
A port of the sfxr sound effect synthesizer to Lua
108 Commits 1 Branch 1 Tag 212 KiB
Lua 100%
fdbfe2d6d2
Go to file
geoffbeier fdbfe2d6d2 use non-deprecated function to check for sounds directory and assert that it was created/exists
2020-06-05 03:45:04 -04:00
demo use non-deprecated function to check for sounds directory and assert that it was created/exists 2020-06-05 03:45:04 -04:00
docs Moved /doc to /docs; Added docs to copy_directories 2016-09-18 23:48:42 +02:00
rockspec Set rockspec tag 2016-09-19 00:05:09 +02:00
.gitignore Removed docs from .gitignore 2016-03-02 00:40:31 +01:00
.gitmodules move to maintained fork of LoveFrames 2020-06-05 03:01:08 -04:00
config.ld Moved /doc to /docs; Added docs to copy_directories 2016-09-18 23:48:42 +02:00
LICENSE Initial commit 2014-04-11 10:31:10 -07:00
README.md Updated README 2016-09-19 00:11:18 +02:00
sfxr.lua replace reference to globals freq and bits with rate and depth 2020-06-05 03:34:28 -04:00

README.md

sfxr.lua

luarocks install sfxr

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 update --init
love demo

Note: Due to LoveFrames only supporting LÖVE 0.9.x, this dependency is inherited by the demo. A move to a new GUI framework is pending.

Example usage

The following code examples demonstrate how to play a randomly generated sound:

With LÖVE:

local sfxr = require("sfxr")

function love.load()
    local sound = sfxr.newSound()
    sound:randomize()
    local sounddata = sound:generateSoundData()
    local source = love.audio.newSource(sounddata)
    source: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()

device:play(sound:generateString())

Documentation

The latest documentation build is available here

This project uses LDoc for autogenerated API documentation.