Merge pull request #110 from nathan-fiscaletti/wayland-support

Arch Linux & Wayland support

Author: nathan-fiscaletti

.github/workflows/dev-build.yml

@@ -4,9 +4,10 @@ on:
     push:
       branches:
         - dev
-        - linux-desktop
+        - wayland-support
       paths:
         - 'application/**'
+        - '.github/**'
 
 jobs:
   build-windows-app:
@@ -120,6 +121,8 @@ jobs:
       uses: actions/setup-python@v2
       with:
         python-version: '3.12'
+    - name: Install libarchive-tools
+      run: sudo apt-get install -y libarchive-tools
     - name: Install Python dependencies
       run: |
         python -m pip install --upgrade pip
@@ -148,11 +151,19 @@ jobs:
       working-directory: ./application
       env:
         GH_TOKEN: ${{secrets.GITHUB_TOKEN}}
-    - name: Rename Installer
-      run: mv dist/kbs_*_amd64.deb dist/Keyboard-Sounds-amd64.deb
+    - name: Rename deb installer
+      run: mv dist/kbs_*_amd64.deb dist/Keyboard-Sounds-Setup-linux-x64.deb
       working-directory: ./application
-    - name: Upload artifacts
+    - name: Rename pacman installer
+      run: mv dist/kbs-*.pacman dist/Keyboard-Sounds-Setup-linux-x64.pacman
+      working-directory: ./application
+    - name: Upload deb installer
+      uses: actions/upload-artifact@v4
+      with:
+        name: build-artifacts-deb
+        path: application/dist/Keyboard-Sounds-Setup-linux-x64.deb
+    - name: Upload pacman installer
       uses: actions/upload-artifact@v4
       with:
-        name: build-artifacts-linux
-        path: application/dist/Keyboard-Sounds-amd64.deb
+        name: build-artifacts-pacman
+        path: application/dist/Keyboard-Sounds-Setup-linux-x64.pacman

.github/workflows/release-build.yml

@@ -137,6 +137,8 @@ jobs:
       uses: actions/setup-python@v2
       with:
         python-version: '3.12'
+    - name: Install libarchive-tools
+      run: sudo apt-get install -y libarchive-tools
     - name: Install Python dependencies
       run: |
         python -m pip install --upgrade pip
@@ -165,11 +167,15 @@ jobs:
       working-directory: ./application
       env:
         GH_TOKEN: ${{secrets.GITHUB_TOKEN}}
-    - name: Rename Installer
-      run: mv dist/kbs_*_amd64.deb dist/Keyboard-Sounds-amd64.deb
+    - name: Rename debian installer
+      run: mv dist/kbs_*_amd64.deb dist/Keyboard-Sounds-Setup-linux-x64.deb
+      working-directory: ./application
+    - name: Rename pacman installer
+      run: mv dist/kbs-*.pacman dist/Keyboard-Sounds-Setup-linux-x64.pacman
       working-directory: ./application
     - name: Upload Artifacts
       uses: softprops/action-gh-release@v2
       with:
         files: |
-          application/dist/Keyboard-Sounds-amd64.deb
+          application/dist/Keyboard-Sounds-Setup-linux-x64.deb
+          application/dist/Keyboard-Sounds-Setup-linux-x64.pacman

.gitignore

@@ -3,4 +3,5 @@ dist
 keyboardsounds.egg-info
 build
 app-version.txt
-version.py
+version.py
+venv/

README.md

@@ -26,6 +26,7 @@ Keyboard Sounds is a free application that makes any keyboard sound like a Mecha
 ### Helpful Links
 
 - [Uninstall Keyboard Sounds](#uninstalling)
+- [Linux Support](./docs/linux-support.md)
 - [Developer Documentation](#development)
 
 <br><br>

application/package.json

@@ -32,9 +32,30 @@
       "icon": "./app_icon.ico"
     },
     "linux": {
-      "target": "deb",
+      "target": [
+        "deb",
+        "pacman"
+      ],
       "category": "AudioVideo",
       "icon": "./app_icon.icns"
+    },
+    "pacman": {
+      "compression": "xz",
+      "depends": [
+        "c-ares",
+        "ffmpeg",
+        "gtk3",
+        "libevent",
+        "libvpx",
+        "libxslt",
+        "libxss",
+        "minizip",
+        "nss",
+        "re2",
+        "snappy",
+        "libnotify",
+        "libappindicator-gtk3"
+      ]
     }
   },
   "scripts": {
@@ -62,7 +83,7 @@
     "cross-env": "^7.0.3",
     "css-loader": "^6.0.0",
     "electron": "29.2.0",
-    "electron-builder": "^24.13.3",
+    "electron-builder": "^26.0.12",
     "file-loader": "^6.2.0",
     "node-loader": "^2.0.0",
     "style-loader": "^3.0.0"

docs/linux-support.md

@@ -1,18 +1,37 @@
-# Keyboard Sounds: Desktop Linux Support
+# Keyboard Sounds: Linux Support
 
 <img align="right" src="../images/linux.png" width="300px">
 
-> [!NOTE]\
-> This documentation is related to the **Desktop** Linux distribution of [Keyboard Sounds](https://keyboardsounds.net). It is not related to the Linux distribution of the [Keyboard Sounds command line application](../#command-line-macos-linux-or-windows)
+## Command Line
+
+The Keyboard Sounds **command line** application is supported on Linux through [`pip`](https://packaging.python.org/en/latest/tutorials/installing-packages/). 
+
+```
+pip install keyboardsounds
+```
+
+## Desktop Application
 
 > [!WARNING]\
 > The Linux distribution of the Keyboard Sounds Desktop Application is currently in beta.
 
 [Download the latest release here](https://github.com/nathan-fiscaletti/keyboardsounds/releases/latest)
 
-### Official Support
+### Using with Wayland
+
+On Wayland, the application will use the libevdev library to listen for keyboard and mouse events. This is necessary because Wayland does not support the X11 event model. 
+
+> [!IMPORTANT] 
+> In order for libevdev to work, your user must be added to the `input` group through `usermod`.
+
+You can add your user to the `input` group by running the following command:
+```bash
+sudo usermod -aG input $USER
+```
+Then, log out and log back in for the changes to take effect.
+
+Keyboard Sounds is not officially supported when running as root.
 
-- Supports x86_64 Debian-based Linux distributions (e.g. Ubuntu, Debian, etc.)
-- Supports X Window System (X11) -- does not support Wayland.
+---
 
-I'm interested in supporting other Linux distributions and Window managers, but I need help! As I'm unable to test the application on other Linux distributions, I'm looking for volunteers to help me test the application on other Linux distributions. If you are interested in helping, please [DM me on Discord](https://discord.gg/gysskqts6z).
+To expand support for other Linux distributions and window managers, I'm seeking volunteers to test the application in different environments. As I'm unable to personally test on all setups, your contributions would be invaluable to the project. If you are interested in helping, please [DM me on Discord](https://discord.gg/gysskqts6z).

keyboardsounds/daemon.py

@@ -27,8 +27,9 @@
 
 from pygame import mixer
 
-from pynput.keyboard import Listener
-from pynput.mouse import Listener as MouseListener, Button
+from pynput.mouse import Button
+
+from keyboardsounds.listener import KeyboardListener, MouseListener
 
 from keyboardsounds.profile import Profile, OneShotProfile
 from keyboardsounds.audio_manager import AudioManager
@@ -59,7 +60,7 @@
 __num_sound_workers = 8
 
 # Keep references to listeners so they can be started/stopped dynamically
-__kb_listener: Optional[Listener] = None
+__kb_listener: Optional[KeyboardListener] = None
 __mouse_listener: Optional[MouseListener] = None
 try:
     # Ensure pydub knows where ffmpeg is, even if not on PATH
@@ -165,7 +166,7 @@ def on_command(command: dict) -> None:
                             __am = AudioManager(Profile(profile))
                             # Start keyboard listener if not running
                             if __kb_listener is None:
-                                __kb_listener = Listener(
+                                __kb_listener = KeyboardListener(
                                     on_press=__on_press, on_release=__on_release
                                 )
                                 __kb_listener.start()
@@ -593,7 +594,7 @@ def run(
     mixer.init()
     mixer.set_num_channels(32)
     __kb_listener = (
-        Listener(on_press=__on_press, on_release=__on_release)
+        KeyboardListener(on_press=__on_press, on_release=__on_release)
         if __am is not None
         else None
     )