mirror of
https://github.com/nucular/sfxrlua.git
synced 2024-12-24 18:44:20 +00:00
Added links and issues to the README
This commit is contained in:
parent
39a001a1a4
commit
f271d7a627
17
README.md
17
README.md
@ -10,7 +10,7 @@ Example usage
|
|||||||
|
|
||||||
These examples should play a randomly generated sound.
|
These examples should play a randomly generated sound.
|
||||||
|
|
||||||
With Löve2D 0.9:
|
With [Löve2D](http://love2d.org) 0.9:
|
||||||
```lua
|
```lua
|
||||||
local sfxr = require("sfxr")
|
local sfxr = require("sfxr")
|
||||||
|
|
||||||
@ -21,7 +21,7 @@ function love.load()
|
|||||||
end
|
end
|
||||||
```
|
```
|
||||||
|
|
||||||
With lao:
|
With [lao](https://github.com/TheLinx/lao):
|
||||||
```lua
|
```lua
|
||||||
require("ao")
|
require("ao")
|
||||||
local sfxr = require("sfxr")
|
local sfxr = require("sfxr")
|
||||||
@ -35,3 +35,16 @@ sound:randomize()
|
|||||||
local buffer = sound:generateString()
|
local buffer = sound:generateString()
|
||||||
device:play(buffer, #buffer)
|
device:play(buffer, #buffer)
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Known Issues
|
||||||
|
------------
|
||||||
|
|
||||||
|
Issues marked with an exclamation mark should be prioritized to be fixed before
|
||||||
|
adding any more complicated features. These marked with a question mark either
|
||||||
|
are of less priority or it is unknown if they should be handled as a bug.
|
||||||
|
|
||||||
|
- ! The sine wave sound distorts when played with a frequency lower than 0.33.
|
||||||
|
- ! The phaser offset has no audible effect, the phaser sweep however has.
|
||||||
|
- ! The Lowpass and Highpass filters sounds distorted.
|
||||||
|
- ! Changing is broken when the amount is < 0.
|
||||||
|
- ? `Sound.repeatSpeed`, `Sound.waveType` and `Sound.frequency.deltaSlide` should be lowercased instead of camelcased.
|
||||||
|
Loading…
Reference in New Issue
Block a user