• Stars
    star
    163
  • Rank 231,141 (Top 5 %)
  • Language GDScript
  • License
    MIT License
  • Created almost 3 years ago
  • Updated about 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

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

GodotSfxr

Godot plugin that adds the SfxrStreamPlayer node 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.

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