Relintai/gdfxr
1
0
Fork 0
mirror of https://github.com/Relintai/gdfxr.git synced 2024-11-10 00:52:12 +01:00
Code Issues Packages Projects Releases Wiki Activity
timothyqiu's sfxr editor plugin ported to Pandemonium.
7 Commits 2 Branches 6 Tags 274 KiB
GDScript 99.3%
Makefile 0.7%
36c647c263
Go to file
Haoyu Qiu 36c647c263 1.1 Release
2022-03-10 17:31:29 +08:00
.github Create FUNDING.yml 2022-03-07 19:41:01 +08:00
addons/gdfxr Keep several recently generated sounds in the menu 2022-03-10 17:24:12 +08:00
example Initial Commit 2022-02-25 20:29:14 +08:00
screenshots Add extra options menu 2022-03-07 18:50:24 +08:00
.gitattributes Create CHANGELOG.md 2022-03-07 19:44:14 +08:00
.gitignore Initial Commit 2022-02-25 20:29:14 +08:00
babel.cfg Initial Commit 2022-02-25 20:29:14 +08:00
CHANGELOG.md 1.1 Release 2022-03-10 17:31:29 +08:00
icon.png Initial Commit 2022-02-25 20:29:14 +08:00
icon.png.import Initial Commit 2022-02-25 20:29:14 +08:00
icon.svg Initial Commit 2022-02-25 20:29:14 +08:00
icon.svg.import Initial Commit 2022-02-25 20:29:14 +08:00
LICENSE Initial Commit 2022-02-25 20:29:14 +08:00
Makefile Initial Commit 2022-02-25 20:29:14 +08:00
project.godot Initial Commit 2022-02-25 20:29:14 +08:00
README-zh_CN.md Create CHANGELOG.md 2022-03-07 19:44:14 +08:00
README.md Create CHANGELOG.md 2022-03-07 19:44:14 +08:00

README.md

gdfxr

MIT license 中文 README

A Godot plugin that ports sfxr, the popular program of choice to make retro sound effects for games.

You can use sfxr sound files like regular audio files in Godot and edit sound files like in the original sfxr.

Installation

This is a regular plugin for Godot. To install, download the ZIP archive, extract it, and move the addons/ folder it contains into your project folder. Then, enable the plugin in project settings.

Usage

After enabling the plugin, you'll see a bottom panel named "gdfxr" appear. This is the sound editor.

Buttons on the left are sound generators of 7 different categories. There are also an option to mutate the current sound slightly, and an option to generate a completely random sound. These are the buttons you'll be working with most of the time.

After a random sound is generated with the generator buttons, you can fine-tune the sound with the controls on the right.

The generated sound can be saved and edited later as an .sfxr file. These files only contain the generator parameters, so they are only about 100 bytes. But they can be used directly as regular AudioStreams.

If you want to reuse an existing sound from the original sfxr, make sure to save it with an .sfxr extension. You can also load & edit the .sfxr file with the original sfxr.

Note: Due to performance constraints with GDScript, the editor may freeze a bit when generating long sounds. This only happens in-editor. Using .sfxr files in-game won't generate anything at runtime.

Changelog

See CHANGELOG.