Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Soundux/Soundux

πŸ”Š A cross-platform soundboard
https://github.com/Soundux/Soundux

cross-platform-soundboard discord flathub flatpak free-software gui linux pipewire play-sounds pulseaudio soundboard soundux teamspeak vb-cable webkit2gtk windows

Last synced: about 2 months ago
JSON representation

πŸ”Š A cross-platform soundboard

Awesome Lists containing this project

README

        

⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️

> [!NOTE]
> Soundux is undergoing a major rewrite right now, for more information see https://github.com/Soundux/Soundux/issues/591

⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️




Read the documentation in:


[English]
[French]
[Russian]








A cross-platform soundboard πŸ”Š




Latest Stable Release




GitHub Repo stars


GitHub issues


GitHub pull requests




License


Discord


Matrix




Windows Build


Linux Build


Flatpak Build




Discord Invite


Translation status


# πŸ‘€ Preview
| ![Dark Interface](https://raw.githubusercontent.com/Soundux/screenshots/screenshots/home-dark.png) | ![Light Interface](https://raw.githubusercontent.com/Soundux/screenshots/screenshots/home-light.png) |
| -------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| ![Settings Dark](https://raw.githubusercontent.com/Soundux/screenshots/screenshots/settings-dark.png) | ![Settings Light](https://raw.githubusercontent.com/Soundux/screenshots/screenshots/settings-light.png) |
| ![Search Dark](https://raw.githubusercontent.com/Soundux/screenshots/screenshots/search-dark.png) | ![Search Light](https://raw.githubusercontent.com/Soundux/screenshots/screenshots/search-light.png) |
| ![Application Passthrough](https://raw.githubusercontent.com/Soundux/screenshots/screenshots/pass-through-dark.png) | ![Application Passthrough](https://raw.githubusercontent.com/Soundux/screenshots/screenshots/pass-through-light.png) |
| ![Seek/Pause/Stop Dark](https://raw.githubusercontent.com/Soundux/screenshots/screenshots/multiple-playing-dark.png) | ![Seek/Pause/Stop Light](https://raw.githubusercontent.com/Soundux/screenshots/screenshots/multiple-playing-light.png) |
| ![Grid View Dark](https://raw.githubusercontent.com/Soundux/screenshots/screenshots/grid-view-dark.png) | ![Grid View Light](https://raw.githubusercontent.com/Soundux/screenshots/screenshots/grid-view-light.png) |

# πŸ‘‹ Introduction
Soundux is a cross-platform soundboard that features a simple user interface.
With Soundux you can play audio to a specific application on Linux and to your VB-CABLE sink on Windows.

# πŸƒ Runtime Dependencies
These are required to run the program

## 🐧 Linux
Please refer to your distro instructions on how to install
- [pulseaudio](https://gitlab.freedesktop.org/pulseaudio/pulseaudio) / [pipewire](https://pipewire.org/) >= 0.3.26
- Xorg
- Libwnck3 (optional, for icon support)
- Webkit2gtk
- libappindicator3
- [youtube-dl](https://youtube-dl.org/) & [ffmpeg](https://www.ffmpeg.org/) (optional, for downloader support)
## Windows
- [VB-CABLE](https://vb-audio.com/Cable/) (Our installer automatically installs VB-CABLE)
- [Webview2 Runtime](https://developer.microsoft.com/microsoft-edge/webview2/) (Is also shipped with the installer)
- [youtube-dl](https://youtube-dl.org/) & [ffmpeg](https://www.ffmpeg.org/) (optional, for downloader support)

# πŸ“₯ Installation

## 🐧 Linux

### Arch Linux and derivatives
You can install our package with your AUR helper of choice which will automatically compile and install the latest release version
```sh
yay -S soundux
```
We also provide a `soundux-git` package which compiles from the master branch

### Ubuntu and derivatives
You can install Soundux via [pacstall](https://github.com/pacstall/pacstall)
```sh
pacstall -I soundux
```

### Fedora
Soundux can be installed via this [COPR repository](https://copr.fedorainfracloud.org/coprs/rivenirvana/soundux/)
```sh
sudo dnf copr enable rivenirvana/soundux
sudo dnf install soundux pipewire-devel
```

### Distro-agnostic packages
You can grab the latest release from the Snap Store or Flathub

[![Get it from the Snap Store](https://snapcraft.io/static/images/badges/en/snap-store-black.svg)](https://snapcraft.io/soundux)


Download on Flathub

## Windows
Download our installer or portable from [the latest release](https://github.com/Soundux/Soundux/releases/latest)

# πŸ”¨ Compilation

## πŸ”— Build Dependencies

### 🐧 Linux
- Webkit2gtk
- PulseAudio development headers
- PipeWire development headers
- X11 client-side development headers
- libappindicator3 development headers
- OpenSSL development headers
- G++ >= 9
- Some distros still have G++ versions < 9 in their repos, using them will result in a build failure (for more information refer to [#71](https://github.com/Soundux/Soundux/issues/71)).

#### Debian / Ubuntu and derivatives
```sh
sudo apt install git build-essential cmake libx11-dev libxi-dev libwebkit2gtk-4.0-dev libappindicator3-dev libssl-dev libpulse-dev libpipewire-0.3-dev
```
> If you're on Ubuntu 20.04 or lower you might have to add the PipeWire PPA:
> `sudo add-apt-repository ppa:pipewire-debian/pipewire-upstream`
#### Fedora and derivatives
```sh
sudo dnf install git webkit2gtk3 cmake llvm clang libXi-devel gtk3-devel webkit2gtk3-devel libappindicator-gtk3-devel pulseaudio-libs-devel pipewire-devel
```

### Windows
- Nuget
- MSVC
- CMake
- OpenSSL

## πŸ‘· Build
Clone the repository
```sh
git clone https://github.com/Soundux/Soundux.git
cd Soundux
git submodule update --init --recursive
```
Create a build folder and start compilation
```sh
mkdir build
cd build
cmake ..
cmake --build . --config Release
```
To start the program
```sh
./soundux # .\soundux.exe on Windows
```

## πŸ–₯️ Install

### 🐧 Linux
```sh
sudo make install
```

# πŸ“ Why _Soundux_?

The project started as a **Sound**board for Lin**ux**

# πŸ—’οΈ License
The code is licensed under [GPLv3](LICENSE)

# ✍️ Contributing
The contribution guidelines can be found [here](CONTRIBUTING.md), please check them out if you're planning to contribute!

# ✨ Contributors

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):



Noah

πŸ› πŸ’Ό πŸ’» 🎨 πŸ€” πŸš‡ 🚧 πŸ“¦ πŸ“† πŸ’¬ πŸ‘€ ⚠️

Nico

πŸ› πŸ’Ό πŸ’» 🎨 πŸ€” πŸš‡ 🚧 πŸ“¦ πŸ“† πŸ’¬ πŸ‘€ ⚠️ 🌍 ️️️️♿️



Michael

πŸ› πŸ€” 🌍 ⚠️

BrandonKMLee

πŸ€”



Toadfield

πŸ€” πŸ›

fubka

πŸ›



TheOriginalTripleD

πŸ”¬

UltraBlackLinux

πŸ›



bendem

πŸ›

Edgar Onghena

πŸ› πŸ”¬



moggesmith10

πŸ€”

Bilal Elmoussaoui

πŸ“¦



Thomas Finstad Larsen

πŸ€”

Arthur Melton

πŸ€”



Serkan Γ–NDER

🌍

PizzaDude

πŸ› πŸ”¬



Kylianalex

πŸ›

Greger

πŸ›



Arvin Verain

πŸ“¦

EinfachEinAlex

πŸ’» πŸ”¬ ⚠️



MeblIkea

🌍

Nathan Bonnemains

🌍



Lucas van Beek

🌍

Timotej S.

πŸ› ⚠️



3JlOy_PYCCKUi

🌍

FuRyQC

🌍



Scott Percival

πŸ› ⚠️ πŸ’»

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!