Soundux

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

[!NOTE]
Soundux is undergoing a major rewrite right now, for more information see #591

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

Read the documentation in:
[English] [French] [Russian]

</a>
<br>
<a href="https://github.com/Soundux/Soundux/stargazers" rel="nofollow">

</a>
<a href="https://github.com/Soundux/Soundux/issues" rel="nofollow">

</a>
<a href="https://github.com/Soundux/Soundux/pulls" rel="nofollow">

</a>
<br>
<a href="https://github.com/Soundux/Soundux/blob/master/LICENSE" rel="nofollow">

</a>
<a href="https://discord.gg/4HwSGN4Ec2" rel="nofollow">

</a>
<a href="https://matrix.to/#/!XlIlRgKzoRavKnurkt:matrix.org" rel="nofollow">

</a>
<br>
<a href="https://github.com/Soundux/Soundux/actions?query=workflow%3A%22Build+on+Windows%22" rel="nofollow">

</a>
<a href="https://github.com/Soundux/Soundux/actions?query=workflow%3A%22Build+on+Linux%22" rel="nofollow">

</a>
<a href="https://github.com/Soundux/Soundux/actions?query=workflow%3A%22Build+Flatpak%22" rel="nofollow">

</a>

<a href="https://discord.com/invite/4HwSGN4Ec2" rel="nofollow">

</a>
<a href="https://hosted.weblate.org/engage/soundux/" rel="nofollow">

</a>

👋 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 / pipewire >= 0.3.26
• Xorg
• Libwnck3 (optional, for icon support)
• Webkit2gtk
• libappindicator3
• youtube-dl & ffmpeg (optional, for downloader support)

Windows

• VB-CABLE (Our installer automatically installs VB-CABLE)
• Webview2 Runtime (Is also shipped with the installer)
• youtube-dl & ffmpeg (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

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

pacstall -I soundux

Fedora

Soundux can be installed via this COPR repository

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

Windows

Download our installer or portable from the latest release

🔨 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).

Debian / Ubuntu and derivatives

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

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

git clone https://github.com/Soundux/Soundux.git
cd Soundux
git submodule update --init --recursive

Create a build folder and start compilation

mkdir build
cd build
cmake ..
cmake --build . --config Release

To start the program

./soundux # .\soundux.exe on Windows

sudo make install

The project started as a Soundboard for Linux

🗒️ License

The code is licensed under GPLv3

✍️ Contributing

The contribution guidelines can be found here, please check them out if you're planning to contribute!

✨ Contributors

Thanks goes to these wonderful people (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 specification. Contributions of any kind welcome!