Giter Club home page Giter Club logo

godot-ui-sound-controller's Introduction

Godot UI Sound Controller

For Godot 4.2

This script and autoload automatically attaches sounds to buttons, tab bars, sliders, and line edits.

Example on itch.io
Example is of Maaack's Game Template, which includes additional features.

Use Case

For adding SFX to all your project's UI elements from one node.

Features

  • Centralizes control of SFX for buttons, tab bars, sliders, and line edits.
  • Automatically detects supported UI nodes added to scenes, and attaches sounds.
  • Works as a script attached to a node in a scene, or as the project's autoload.

How it Works

  • The UISoundController node automatically attaches sounds to buttons, tab bars, sliders, and line edits in the scene. ProjectUISoundController.tscn is an autload used to apply UI sounds project-wide.

Installation

Godot Asset Library

This package is available as a plugin, meaning it can be added to an existing project.

Package Icon

When editing an existing project:

  1. Go to the AssetLib tab.
  2. Search for "Maaack's UI Sound Controller".
  3. Click on the result to open the plugin details.
  4. Click to Download.
  5. Check that contents are getting installed to addons/ and there are no conflicts.
  6. Click to Install.
  7. Reload the project (you may see errors before you do this).
  8. Enable the plugin from the Project Settings > Plugins tab.

GitHub

  1. Download the latest release version from GitHub.
  2. Extract the contents of the archive.
  3. Move the addons/maaacks_ui_sound_controller folder into your project's addons/ folder.
  4. Open/Reload the project.
  5. Enable the plugin from the Project Settings > Plugins tab.

Extras

Users that want additional features can try Maaack's Game Template.

Usage

Attach the UISoundController.gd script to a node that is in your UI scene, under the root node. Select the node, and assign your audio streams to the various supported UI events.

Alternatively, open ProjectUISoundController.tscn, select the root node, and assign audio streams to UI events project-wide.

Links

Attribution
License

godot-ui-sound-controller's People

Contributors

maaack avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar

Forkers

r2d2m

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.