Read the documentation in:
[English]
[French]
[Russian]
A cross-platform soundboard 🔊
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
[](https://snapcraft.io/soundux)
## 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)):
