Skip to content

LU1GYX/PySoundboard

Repository files navigation

PySoundboard

An Almost-Without dependencies Python Soundboard! (WINDOWS ONLY!)

Disclamer

This isn't finished, it can be optimized in many ways! If you want to help, you're Welcome to contribute!

Requirements

  • Python 3.13

For python, verify you installed python correctly and check the PATH if it contains the Python path.

Installation

Clone the repo, open a terminal inside the repo folder and run:

python -r requirements.txt

This will install all the dependencies needed to run the Soundboard.

After the installation, run this command to start the Soundboard:

python .

N.B:! RUN THIS COMMAND INSIDE THE REPO FOLDER!

After the startup, the program will check automatically for the Virtual Cable presence and will load the configured Binds

How to Use

Overlay

  • The overlay is toggleable, you can choose to disable it or not.
  • You can change the position of it by clicking MIDDLE MOUSE while on the window.
  • When the cursor is over the window, it will change the opacity of it.

Soundboard

  • The Soundboard is toggleable.
  • To play a sound, you need to add new Bindings. There are 2 ways to add a bind:

GUI

By left-clicking on the TrayIcon, an option called "Add Bind" will show. To add a valid bind, you need to provide 4 informations:

  • Path: A valid path to an '.MP3' file.
  • Process: A process name, it will provide a list of the current active processes. When 'default' is setted, the audio will play every time you hit the key.
  • Volume: The volume value for the Audio. The range is -100 (silent) to +100 (LOUD)
  • Key: The name of the key. If you select the textbox, the key will be automatically inserted.

Manual

The bindings inserted in the 'binds.json' is formatted this way:

"default": { #Process Name
    "q": { #Key
        "filename": "./sounds/Qiguanchanghong.mp3", #Path to filename
        "volume": -15 #Volume value
    }
},

Simply copy this and modify the values you need to change.

To see the current configured bindings, you can use the "List Binds" option under the "Add Bind"!

TODO

  • Add presistent setting file
  • Revamp for tk windows
  • Overlay Customization
    • Size
    • Text
    • Colors

About

A All-in Python Soundboard with simple Overlay and TrayIcon.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages