2020-11-12 20:02:14 +01:00
< div align = "center" >
< p >
2021-02-24 10:28:51 +01:00
< img src = "assets/logo.gif" height = "200" / >
< br >
2021-02-24 11:31:14 +01:00
< h6 > A cross-platform soundboard 🔊< / h6 >
2021-05-24 21:26:17 +02:00
< br >
< a href = "https://github.com/Soundux/Soundux/releases" >
< img src = "https://img.shields.io/github/release/Soundux/Soundux.svg?style=flat-square" alt = "Latest Stable Release" / >
< / a >
2021-02-24 10:28:51 +01:00
< br >
2021-03-23 09:21:59 +01:00
< a href = "https://github.com/Soundux/Soundux/stargazers" >
< img src = "https://img.shields.io/github/stars/Soundux/soundux?style=flat-square" alt = "GitHub Repo stars" >
< / a >
< a href = "https://github.com/Soundux/Soundux/issues" >
< img src = "https://img.shields.io/github/issues/Soundux/soundux?style=flat-square" alt = "GitHub issues" >
< / a >
< a href = "https://github.com/Soundux/Soundux/pulls" >
< img src = "https://img.shields.io/github/issues-pr-raw/Soundux/soundux?label=pulls&style=flat-square" alt = "GitHub pull requests" >
< / a >
2021-02-24 10:28:51 +01:00
< br >
2021-05-23 14:33:20 +02:00
< a href = "https://github.com/Soundux/Soundux/blob/master/LICENSE" >
< img src = "https://img.shields.io/github/license/Soundux/Soundux.svg?style=flat-square" alt = "License" / >
< / a >
< a href = "https://discord.gg/4HwSGN4Ec2" >
< img src = "https://img.shields.io/discord/697348809591750706?label=discord&style=flat-square" alt = "Discord" / >
< / a >
< a href = "https://matrix.to/ #/ !XlIlRgKzoRavKnurkt:matrix.org" >
< img src = "https://img.shields.io/badge/chat-matrix%20space-blue?style=flat-square" alt = "Matrix" / >
< / a >
2021-05-24 21:26:17 +02:00
< br >
< a href = "https://github.com/Soundux/Soundux/actions?query=workflow%3A%22Build+on+Windows%22" >
< img src = "https://img.shields.io/github/workflow/status/Soundux/Soundux/Build%20on%20Windows?label=windows%20build&style=flat-square" alt = "Windows Build" / >
< / a >
< a href = "https://github.com/Soundux/Soundux/actions?query=workflow%3A%22Build+on+Linux%22" >
< img src = "https://img.shields.io/github/workflow/status/Soundux/Soundux/Build%20on%20Linux?label=linux%20build&style=flat-square" alt = "Linux Build" / >
< / a >
< a href = "https://github.com/Soundux/Soundux/actions?query=workflow%3A%22Build+Flatpak%22" >
< img src = "https://img.shields.io/github/workflow/status/Soundux/Soundux/Build%20Flatpak?label=flatpak%20build&style=flat-square" alt = "Flatpak Build" / >
< / a >
2021-05-25 16:48:25 +02:00
< hr >
< a href = "https://hosted.weblate.org/engage/soundux/" >
< img src = "https://hosted.weblate.org/widgets/soundux/-/frontend/287x66-black.png" alt = "Translation status" / >
< / a >
2020-11-12 20:02:14 +01:00
< / p >
< / div >
2021-03-13 13:55:37 +01:00
# 👀 Preview
2021-04-03 01:47:22 +02:00
|  |  |
| -------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
|  |  |
|  |  |
|  |  |
2021-04-02 20:31:17 +02:00
|  |  |
2021-04-03 01:47:22 +02:00
|  |  |
2020-11-12 20:02:14 +01:00
2021-03-13 13:55:37 +01:00
# 👋 Introduction
2020-11-12 20:02:14 +01:00
Soundux is a cross-platform soundboard that features a simple user interface.
2021-03-02 09:19:07 +01:00
With Soundux you can play audio to a specific application on Linux and to your VB-CABLE sink on Windows.
2020-11-12 20:02:14 +01:00
2021-03-13 13:55:37 +01:00
# 🏃 Runtime Dependencies
2020-12-24 13:54:54 +01:00
These are required to run the program
2021-03-13 13:55:37 +01:00
## 🐧 Linux
2020-11-12 20:02:14 +01:00
Please refer to your distro instructions on how to install
2021-05-18 12:14:50 +02:00
- [pulseaudio ](https://gitlab.freedesktop.org/pulseaudio/pulseaudio ) / [pipewire ](https://pipewire.org/ )
2020-12-15 13:53:10 +01:00
- Xorg
2021-04-08 18:34:24 +02:00
- Libwnck3 (optional, for icon support)
2021-02-23 00:05:16 +01:00
- Webkit2gtk
2021-03-29 18:20:34 +02:00
- libappindicator3
2021-04-03 01:47:22 +02:00
- [youtube-dl ](https://youtube-dl.org/ ) & [ffmpeg ](https://www.ffmpeg.org/ ) (optional, for downloader support)
2021-03-13 13:55:37 +01:00
## 🪟 Windows
2020-12-24 13:54:54 +01:00
- [VB-CABLE ](https://vb-audio.com/Cable/ ) (Our installer automatically installs VB-CABLE)
2021-03-02 22:35:53 +01:00
- [Webview2 Runtime ](https://developer.microsoft.com/microsoft-edge/webview2/ ) (Is also shipped with the installer)
2021-04-03 01:47:22 +02:00
- [youtube-dl ](https://youtube-dl.org/ ) & [ffmpeg ](https://www.ffmpeg.org/ ) (optional, for downloader support)
2020-11-12 20:02:14 +01:00
2021-03-13 13:55:37 +01:00
# 📥 Installation
2020-11-12 20:02:14 +01:00
2021-03-13 13:55:37 +01:00
## 🐧 Linux
2020-12-24 13:54:54 +01:00
2021-03-13 13:55:37 +01:00
### ❤️ Arch Linux and derivatives
2020-12-24 02:31:53 +01:00
You can install our package with your AUR helper of choice which will automatically compile and install the latest release version
2020-11-12 20:02:14 +01:00
```sh
2020-12-24 02:29:07 +01:00
yay -S soundux
2020-11-12 20:02:14 +01:00
```
2020-12-24 02:31:53 +01:00
We also provide a `soundux-git` package which compiles from the master branch
2020-11-12 20:02:14 +01:00
2021-05-11 16:12:04 +02:00
### 🗃️ Ubuntu and derivatives
You can install Soundux via [pacstall ](https://github.com/Henryws/pacstall )
```sh
sudo pacstall -I soundux
```
### 📜 Distro-agnostic packages
2021-04-06 17:37:16 +02:00
You can grab the latest release from the Snap Store or Flathub
[](https://snapcraft.io/soundux)
2020-12-24 02:29:07 +01:00
2021-04-03 14:36:21 +02:00
< a href = 'https://flathub.org/apps/details/io.github.Soundux' >
< img width = '240' alt = 'Download on Flathub' src = 'https://flathub.org/assets/badges/flathub-badge-en.png' / >
< / a >
2020-12-24 02:29:07 +01:00
2021-03-13 13:55:37 +01:00
## 🪟 Windows
2020-12-24 13:54:54 +01:00
Download our installer or portable from [the latest release ](https://github.com/Soundux/Soundux/releases/latest )
2020-11-12 20:02:14 +01:00
2021-03-13 13:55:37 +01:00
# 🪛 Compilation
2020-11-12 20:02:14 +01:00
2021-03-13 13:55:37 +01:00
## 🔗 Build Dependencies
2020-11-12 20:02:14 +01:00
2021-03-13 13:55:37 +01:00
### 🐧 Linux
2021-02-23 00:05:16 +01:00
This list may not be accurate. Contact me if you find missing dependencies so that I can update this list
- Webkit2gtk
2021-05-17 00:28:20 +02:00
- PulseAudio development headers
- PipeWire development headers
2020-12-18 09:29:41 +01:00
- X11 client-side development headers
2021-03-29 18:20:34 +02:00
- libappindicator3 development headers
2021-04-06 17:37:16 +02:00
- OpenSSL development headers
2021-03-02 22:12:08 +01:00
- 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 )).
2020-12-18 09:29:41 +01:00
2021-03-13 13:55:37 +01:00
#### 📜 Debian/Ubuntu and derivatives
2020-11-12 20:02:14 +01:00
```sh
2021-05-17 00:28:20 +02:00
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
2020-11-12 20:02:14 +01:00
```
2021-05-19 09:23:51 +02:00
> If you're on Ubuntu 20.04 or lower you might have to add the PipeWire PPA:
2021-05-17 00:28:20 +02:00
> `sudo add-apt-repository ppa:pipewire-debian/pipewire-upstream`
2021-03-15 11:26:11 +01:00
#### 📜 Fedora and derivatives
```sh
2021-05-17 00:28:20 +02:00
sudo dnf install git webkit2gtk3 pulseaudio-utils cmake llvm clang libXi-devel gtk3-devel webkit2gtk3-devel libappindicator-gtk3-devel pulseaudio-libs-devel pipewire-devel
2021-03-15 11:26:11 +01:00
```
2020-11-12 20:02:14 +01:00
2021-03-13 13:55:37 +01:00
### 🪟 Windows
2021-02-23 00:05:16 +01:00
- Nuget
2020-12-24 13:54:54 +01:00
- MSVC
- CMake
2021-04-06 17:37:16 +02:00
- OpenSSL
2020-12-24 13:54:54 +01:00
2021-03-13 13:55:37 +01:00
## 👷 Build
2020-11-12 20:02:14 +01:00
Clone the repository
```sh
2020-12-15 12:49:35 +01:00
git clone https://github.com/Soundux/Soundux.git
2020-11-12 20:02:14 +01:00
cd Soundux
git submodule update --init --recursive
```
Create a build folder and start compilation
```sh
mkdir build
cd build
cmake ..
2020-12-25 13:50:46 +01:00
cmake --build . --config Release
2020-11-12 20:02:14 +01:00
```
To start the program
```sh
2020-12-24 13:54:54 +01:00
./soundux # .\soundux.exe on Windows
2020-11-12 20:02:14 +01:00
```
2021-03-13 13:55:37 +01:00
## 🖥️ Install
2020-12-24 13:54:54 +01:00
2021-03-13 13:55:37 +01:00
### 🐧 Linux
2020-12-17 23:06:39 +01:00
```sh
sudo make install
```
2020-11-12 20:02:14 +01:00
2021-03-13 13:55:37 +01:00
# 📝 Why _Soundux_?
2020-11-12 20:02:14 +01:00
2020-11-12 20:41:48 +01:00
The project started as a **Sound**board for Lin**ux**
2020-11-12 20:02:14 +01:00
2021-03-13 13:55:37 +01:00
# 🗒️ License
2020-11-12 20:02:14 +01:00
The code is licensed under [GPLv3 ](LICENSE )
2021-03-13 11:58:54 +01:00
2021-03-13 15:53:59 +01:00
# ✨ Contributors
2021-03-13 11:58:54 +01:00
Thanks goes to these wonderful people ([emoji key ](https://allcontributors.org/docs/en/emoji-key )):
<!-- ALL - CONTRIBUTORS - LIST:START - Do not remove or modify this section -->
<!-- prettier - ignore - start -->
<!-- markdownlint - disable -->
< table >
< tr >
2021-03-13 13:37:19 +01:00
< td align = "center" >< a href = "https://github.com/Curve" >< img src = "https://avatars.githubusercontent.com/u/37805707?v=4?s=50" width = "50px;" alt = "" />< br />< sub >< b > Noah</ b ></ sub ></ a >< br />< a href = "https://github.com/Soundux/Soundux/issues?q=author%3ACurve" title = "Bug reports" > 🐛</ a > < a href = " #business -Curve" title = "Business development" > 💼</ a > < a href = "https://github.com/Soundux/Soundux/commits?author=Curve" title = "Code" > 💻</ a > < a href = " #design -Curve" title = "Design" > 🎨</ a > < a href = " #ideas -Curve" title = "Ideas, Planning, & Feedback" > 🤔</ a > < a href = " #infra -Curve" title = "Infrastructure (Hosting, Build-Tools, etc)" > 🚇</ a > < a href = " #maintenance -Curve" title = "Maintenance" > 🚧</ a > < a href = " #platform -Curve" title = "Packaging/porting to new platform" > 📦</ a > < a href = " #projectManagement -Curve" title = "Project Management" > 📆</ a > < a href = " #question -Curve" title = "Answering Questions" > 💬</ a > < a href = "https://github.com/Soundux/Soundux/pulls?q=is%3Apr+reviewed-by%3ACurve" title = "Reviewed Pull Requests" > 👀</ a > < a href = "https://github.com/Soundux/Soundux/commits?author=Curve" title = "Tests" > ⚠️</ a ></ td >
< td align = "center" >< a href = "https://github.com/D3SOX" >< img src = "https://avatars.githubusercontent.com/u/24937357?v=4?s=50" width = "50px;" alt = "" />< br />< sub >< b > Nico</ b ></ sub ></ a >< br />< a href = "https://github.com/Soundux/Soundux/issues?q=author%3AD3SOX" title = "Bug reports" > 🐛</ a > < a href = " #business -D3SOX" title = "Business development" > 💼</ a > < a href = "https://github.com/Soundux/Soundux/commits?author=D3SOX" title = "Code" > 💻</ a > < a href = " #design -D3SOX" title = "Design" > 🎨</ a > < a href = " #ideas -D3SOX" title = "Ideas, Planning, & Feedback" > 🤔</ a > < a href = " #infra -D3SOX" title = "Infrastructure (Hosting, Build-Tools, etc)" > 🚇</ a > < a href = " #maintenance -D3SOX" title = "Maintenance" > 🚧</ a > < a href = " #platform -D3SOX" title = "Packaging/porting to new platform" > 📦</ a > < a href = " #projectManagement -D3SOX" title = "Project Management" > 📆</ a > < a href = " #question -D3SOX" title = "Answering Questions" > 💬</ a > < a href = "https://github.com/Soundux/Soundux/pulls?q=is%3Apr+reviewed-by%3AD3SOX" title = "Reviewed Pull Requests" > 👀</ a > < a href = "https://github.com/Soundux/Soundux/commits?author=D3SOX" title = "Tests" > ⚠️</ a > < a href = " #translation -D3SOX" title = "Translation" > 🌍</ a > < a href = " #a11y -D3SOX" title = "Accessibility" > ️️️️♿️</ a ></ td >
2021-03-13 13:40:10 +01:00
< / tr >
< tr >
2021-03-13 13:37:19 +01:00
< td align = "center" >< a href = "https://github.com/MrKingMichael" >< img src = "https://avatars.githubusercontent.com/u/30067605?v=4?s=50" width = "50px;" alt = "" />< br />< sub >< b > Michael</ b ></ sub ></ a >< br />< a href = "https://github.com/Soundux/Soundux/issues?q=author%3AMrKingMichael" title = "Bug reports" > 🐛</ a > < a href = " #ideas -MrKingMichael" title = "Ideas, Planning, & Feedback" > 🤔</ a > < a href = " #translation -MrKingMichael" title = "Translation" > 🌍</ a > < a href = "https://github.com/Soundux/Soundux/commits?author=MrKingMichael" title = "Tests" > ⚠️</ a ></ td >
< td align = "center" >< a href = "https://github.com/BrandonKMLee" >< img src = "https://avatars.githubusercontent.com/u/58927531?v=4?s=50" width = "50px;" alt = "" />< br />< sub >< b > BrandonKMLee</ b ></ sub ></ a >< br />< a href = " #ideas -BrandonKMLee" title = "Ideas, Planning, & Feedback" > 🤔</ a ></ td >
2021-03-13 11:58:54 +01:00
< / tr >
2021-03-13 12:01:35 +01:00
< tr >
2021-03-13 13:40:10 +01:00
< td align = "center" >< a href = "https://github.com/Toadfield" >< img src = "https://avatars.githubusercontent.com/u/68649672?v=4?s=50" width = "50px;" alt = "" />< br />< sub >< b > Toadfield</ b ></ sub ></ a >< br />< a href = " #ideas -Toadfield" title = "Ideas, Planning, & Feedback" > 🤔</ a > < a href = "https://github.com/Soundux/Soundux/issues?q=author%3AToadfield" title = "Bug reports" > 🐛</ a ></ td >
2021-03-13 13:39:04 +01:00
< td align = "center" > < a href = "https://github.com/fubka" > < img src = "https://avatars.githubusercontent.com/u/44064746?v=4?s=50" width = "50px;" alt = "" / > < br / > < sub > < b > fubka< / b > < / sub > < / a > < br / > < a href = "https://github.com/Soundux/Soundux/issues?q=author%3Afubka" title = "Bug reports" > 🐛< / a > < / td >
2021-03-13 13:40:10 +01:00
< / tr >
< tr >
2021-03-13 13:39:04 +01:00
< td align = "center" >< a href = "https://github.com/TheOriginalTripleD" >< img src = "https://avatars.githubusercontent.com/u/6907054?v=4?s=50" width = "50px;" alt = "" />< br />< sub >< b > TheOriginalTripleD</ b ></ sub ></ a >< br />< a href = " #research -TheOriginalTripleD" title = "Research" > 🔬</ a ></ td >
2021-03-13 13:37:19 +01:00
< td align = "center" > < a href = "https://github.com/UltraBlackLinux" > < img src = "https://avatars.githubusercontent.com/u/62404294?v=4?s=50" width = "50px;" alt = "" / > < br / > < sub > < b > UltraBlackLinux< / b > < / sub > < / a > < br / > < a href = "https://github.com/Soundux/Soundux/issues?q=author%3AUltraBlackLinux" title = "Bug reports" > 🐛< / a > < / td >
2021-03-13 13:40:10 +01:00
< / tr >
< tr >
2021-03-13 13:37:19 +01:00
< td align = "center" > < a href = "https://bendem.be/" > < img src = "https://avatars.githubusercontent.com/u/2681677?v=4?s=50" width = "50px;" alt = "" / > < br / > < sub > < b > bendem< / b > < / sub > < / a > < br / > < a href = "https://github.com/Soundux/Soundux/issues?q=author%3Abendem" title = "Bug reports" > 🐛< / a > < / td >
< td align = "center" >< a href = "https://edgar.bzh/" >< img src = "https://avatars.githubusercontent.com/u/46636609?v=4?s=50" width = "50px;" alt = "" />< br />< sub >< b > Edgar Onghena</ b ></ sub ></ a >< br />< a href = "https://github.com/Soundux/Soundux/issues?q=author%3Aedgarogh" title = "Bug reports" > 🐛</ a > < a href = " #research -edgarogh" title = "Research" > 🔬</ a ></ td >
2021-03-13 13:39:04 +01:00
< / tr >
< tr >
2021-03-13 13:37:19 +01:00
< td align = "center" >< a href = "https://github.com/moggesmith10" >< img src = "https://avatars.githubusercontent.com/u/33375517?v=4?s=50" width = "50px;" alt = "" />< br />< sub >< b > moggesmith10</ b ></ sub ></ a >< br />< a href = " #ideas -moggesmith10" title = "Ideas, Planning, & Feedback" > 🤔</ a ></ td >
< td align = "center" >< a href = "https://belmoussaoui.com/" >< img src = "https://avatars.githubusercontent.com/u/7660997?v=4?s=50" width = "50px;" alt = "" />< br />< sub >< b > Bilal Elmoussaoui</ b ></ sub ></ a >< br />< a href = " #platform -bilelmoussaoui" title = "Packaging/porting to new platform" > 📦</ a ></ td >
2021-03-13 12:01:35 +01:00
< / tr >
2021-05-11 18:53:30 +00:00
< tr >
< td align = "center" >< a href = "https://github.com/thomasfinstad" >< img src = "https://avatars.githubusercontent.com/u/5358752?v=4?s=50" width = "50px;" alt = "" />< br />< sub >< b > Thomas Finstad Larsen</ b ></ sub ></ a >< br />< a href = " #ideas -thomasfinstad" title = "Ideas, Planning, & Feedback" > 🤔</ a ></ td >
2021-05-11 18:54:58 +00:00
< td align = "center" >< a href = "http://arthurmelton.me" >< img src = "https://avatars.githubusercontent.com/u/29708070?v=4?s=50" width = "50px;" alt = "" />< br />< sub >< b > Arthur Melton</ b ></ sub ></ a >< br />< a href = " #ideas -AMTitan" title = "Ideas, Planning, & Feedback" > 🤔</ a ></ td >
2021-05-11 18:53:30 +00:00
< / tr >
2021-05-11 19:02:02 +00:00
< tr >
< td align = "center" >< a href = "https://github.com/serkan-maker" >< img src = "https://avatars.githubusercontent.com/u/63740626?v=4?s=50" width = "50px;" alt = "" />< br />< sub >< b > Serkan ÖNDER</ b ></ sub ></ a >< br />< a href = " #translation -serkan-maker" title = "Translation" > 🌍</ a ></ td >
2021-05-17 12:49:33 +02:00
< td align = "center" >< a href = "https://github.com/pizzadude" >< img src = "https://avatars.githubusercontent.com/u/1454420?v=4?s=50" width = "50px;" alt = "" />< br />< sub >< b > PizzaDude</ b ></ sub ></ a >< br />< a href = "https://github.com/Soundux/Soundux/issues?q=author%3Apizzadude" title = "Bug reports" > 🐛</ a > < a href = " #research -pizzadude" title = "Research" > 🔬</ a ></ td >
2021-05-11 19:02:02 +00:00
< / tr >
2021-05-23 22:28:42 +00:00
< tr >
< td align = "center" > < a href = "https://github.com/Kylianalex" > < img src = "https://avatars.githubusercontent.com/u/66625058?v=4?s=50" width = "50px;" alt = "" / > < br / > < sub > < b > Kylianalex< / b > < / sub > < / a > < br / > < a href = "https://github.com/Soundux/Soundux/issues?q=author%3AKylianalex" title = "Bug reports" > 🐛< / a > < / td >
2021-05-24 00:28:08 +00:00
< td align = "center" > < a href = "http://gregerstoltnilsen.net/" > < img src = "https://avatars.githubusercontent.com/u/1364443?v=4?s=50" width = "50px;" alt = "" / > < br / > < sub > < b > Greger< / b > < / sub > < / a > < br / > < a href = "https://github.com/Soundux/Soundux/issues?q=author%3Agregersn" title = "Bug reports" > 🐛< / a > < / td >
2021-05-23 22:28:42 +00:00
< / tr >
2021-03-13 11:58:54 +01:00
< / table >
<!-- markdownlint - restore -->
<!-- prettier - ignore - end -->
<!-- ALL - CONTRIBUTORS - LIST:END -->
2021-03-13 13:55:37 +01:00
This project follows the [all-contributors ](https://github.com/all-contributors/all-contributors ) specification. Contributions of any kind welcome!
