Skip to content

Latest commit

 

History

History
53 lines (27 loc) · 2.66 KB

README.md

File metadata and controls

53 lines (27 loc) · 2.66 KB

GodotSfxr

Godot plugin that adds the SfxrStreamPlayer node and SfxrAudioStream Resource to generate sound effects inside the editor.

SfxrStreamPlayer Node

Ported from jsfxr (by Eric Fredricksen), which is a port from the original sfxr (by DrPetter).

Installation

  • Install options:

    1. Install from the Godot Asset Library*.

    2. Clone or download this repository, and copy the contents of the "addons" directory to the "addons" directory of your Godot Project.

    * The download from the Godot Asset Library might not be up to date. You can use Github to always get the latest version.

  • After installing the plugin you need to enable it on the menu: Project > Project Settings... > Plugins > GodotSfxr.

Usage

Add the desired node: SfxrStreamPlayer, SfxrStreamPlayer2D, or SfxrStreamPlayer3D.

Node selection

Select a preset sound effect under the Generators group in the inspector.

That will generate and save an AudioStreamSample resource with the audio data (embedded on the node).

Node options

You can adjust the sound parameters on the inspector as needed.

The sound will play automatically after being generated, but you can also click on the Playing property to make it play.

If for some reason you need to regenerate the sound (maybe you deleted the stream resource), you can use the Force Rebuild option under the Actions group.

Node regen

Everything else works as in the regular AudioStreamPlayer* nodes.

For example, you can call the play function on the node, or connect to the finished signal.

Code example

Depending on your needs, you can also create a SfxrAudioStream Resource that will contain the audio data, and has all the same options as the nodes above.

Resource Creation

Then you can use that resource by setting it to the stream parameter of any AudioStreamPlayer.

Node with resource