search

FreekDS / GodotAudioEvents

A simple solution to generate events while playing a sound resource
MIT License
6 stars 0 forks source link

readme

Godot Audio Events

A simple solution to generate events while playing a sound resource.

Ever wanted to recreate the silly koopa dance that is timed with the music (BAH BAH)?

BahBah

With this solution that is possible!

Installation

AudioEvents is available from the offical asset library!

  1. Open Godot
  2. Navigate to AssetLib on the top
  3. Search for AudioEvents
  4. Download!

Alternatively, clone the repository and copy the addons/AudioEvents to your own addons/ directory in the project. Do not forget to enable the plugin in the Project settings!

How to use?

  1. Create an AudioEventPlayer
  2. Attach an AudioStreamPlayer. (alternatively, add the AudioEventPlayer as child to the AudioStreamPlayer)
  3. Create an AudioEventStream resource under the AudioStreamPlayer.
  4. Give the AudioEventStream resource an audio file as resource and (optionally) a name.
  5. Fill the Event Times array with float numbers that indicate the time at which an event needs to be fired.
    TIP: use the Audio preview feature on the audio source to have an idea of the timings.
  6. Connect to the soundEvent signal from the AudioEventPlayer

Example

Open example.tscn for a simple example.

Contributing

If anything is not working, please open an issue via the issue tracker on GitHub.
Feel free to create a pull request with suggestions/bug fixes!

License

This project is MIT licensed, you can do whatever you want with it :)