diff --git a/README.md b/README.md index 3887095..c9d7dac 100644 --- a/README.md +++ b/README.md @@ -1,45 +1,36 @@ A simply remake of [HeadsetControl-GUI](https://github.com/LeoKlaus/HeadsetControl-GUI) by @LeoKlaus # HeadsetControl-GUI [![Github All Releases](https://img.shields.io/github/downloads/nicola02nb/headsetcontrol-gui/total.svg)]() [![license](https://img.shields.io/github/license/nicola02nb/HeadsetControl-GUI)]() +This is a GUI for [Sapds great HeadsetControl](https://github.com/Sapd/HeadsetControl/).
+It's just a frontend to graphically interact with the original HeadsetControl and has no functionality by itself.
-This is a GUI for [Sapds great HeadsetControl](https://github.com/Sapd/HeadsetControl/). It's just a frontend to graphically interact with the original HeadsetControl and has no functionality by itself. -I have to give a huge thank you to Sapd for doing all the heavy lifting and developing the command line tool HeadsetControl without which this project wouldn't be possible. +## Platforms -**Disclaimer**: -This program is in no way affiliated with Sapd or HeadsetControl. -All issues regarding the functionality of HeadsetControl (like compatiblity with devices) are beyond the scope of this project. +OS | Compiled | Tested +:------------ | :-------------| :------------- +Windows | ✅ | ✅ +Linux | ✅ | ❌ +MacOS | ❌ | ❌ + +If you are on Linux or Mac and try to build the app and test it, I'd be happy to hear if it did or didn't work. -## Installation (Windows only for now) -Download the [latest release](https://github.com/LeoKlaus/HeadsetControl-GUI/releases/latest/) of HeadsetControl-GUI from the [releases section](https://github.com/nicola02nb/HeadsetControl-GUI/releases) of this page. -Download the corresponding version of [Sapds HeadsetControl from their GitHub page](https://github.com/Sapd/HeadsetControl/releases/). +## Installation (Windows) +1. Download the [latest release](https://github.com/nicola02nb/HeadsetControl-GUI/releases/latest/) of HeadsetControl-GUI from the [releases section](https://github.com/nicola02nb/HeadsetControl-GUI/releases) of this page. +2. Extract HeadsetControl-GUI to any folder. -Extract HeadsetControl-GUI to any folder of your choice and drop HeadsetControl into the same folder. The finished folder should look something like this: ![image](https://github.com/user-attachments/assets/0145ca37-6e59-4170-ba26-804e8856dbc8) -You HAVE to download a version of the [original headsetcontrol](https://github.com/Sapd/HeadsetControl/releases/) and put it in the same folder. -The executable of headsetcontrol has to be called "HeadsetControl". -Only if both these requirements are met, the GUI can work. - -### Auto startup (Windows) - -1. Press on your keyboard `win` + `R` and write on prompt `shell:common startup`; after pressing `ok` button your file explorer will open on the startup folder. -2. There you can create a link to the HeadsetControl-GUI.exe executable. -3. If you want it to startup as minimized, you can press `right click` on the file `link` and you can set `Run:` as `Minimized`. - -## Usage -Start HeadsetControl-GUI by double-clicking "HeadsetControl-GUI.exe", and if your headset is supported and everything was set up correctly, you will be greeted by the following screen HeadsetControl-GUI has. - -It updates ui values every ⁓30s, including the trayIcon. +### Usage +Start HeadsetControl-GUI by double-clicking "HeadsetControl-GUI.exe", and if your headset is supported and everything was set up correctly, you will be greeted by the following screen HeadsetControl-GUI has.. If you don't find some features in you ui, probably it's not supported by your headset or it has not been implemented by [HeadsetControl](https://github.com/Sapd/HeadsetControl/). ![image](https://github.com/nicola02nb/HeadsetControl-GUI/assets/61830443/ce6a9628-4705-4a79-a262-8c43db2c92b0) Here you can adjust all settings supported by your headset. -In my experience, these changes persist even after rebooting the system or turning the headset off. -If you have a wired headset and are finished changing settings, you can close the GUI and call it day. Yay! +Changes may or may not persist even after rebooting the system or turning the headset off(It depends on how headsets stores their own settings). If you have a wireless headset with support for battery levels, you can also minimize HeadsetControl-GUI to the system tray. @@ -50,21 +41,21 @@ Hovering over the tray icon will show you the current battery percentage. You ca ![image](https://github.com/nicola02nb/HeadsetControl-GUI/assets/61830443/0213a37c-806c-44d5-b8d7-5cc6b5d69407) -## Performance +### Performance While the concept of calling another app for every single interaction has some inherit overhead, HeadsetControl-GUI is very light on ressources. Being open in the background, HeadsetControl-GUI consists of a single process that uses virtually no CPU time and about 8-10MB of system memory. ![image](https://github.com/user-attachments/assets/3171e62d-8a0c-49b6-88bd-e5b03393c7fe) ## Building from source -To build HeadsetControl-GUI from source, you have to have a proper QT-ready development environment. -I developed, built and tested the program with Qt 6.7.0, though there's no apparent reason why it wouldn't work with older or newer versions of Qt. -Clone the source code, import the project into Qt creator or your favourite IDE and build it. - -## Support for other platforms -I haven't used any platform-specific code, so generally, you should be able to build and run this app on Linux or MacOS just fine. -I haven't taken the time to build and test on neither Linux nor MacOS (yet), so I can't make any definitive claims on what is supported and what isn't. -If you are on Linux or Mac and try to build the app, I'd be happy to hear if it did or didn't work. +To build HeadsetControl-GUI from source, you have to have a proper QT-ready development environment.
+I developed, built and tested the program with Qt 6.7.0 and [Qt Creator](https://www.qt.io/product/development-tools) as IDE.
+Clone the source code, import the project into [Qt Creator](https://www.qt.io/product/development-tools) or your favourite IDE and build it. ## Additional information -This software comes with no warranty whatsoever. It's not properly tested for memory leakage and may or may not work with configurations other than those I've tested. +This software comes with no warranty whatsoever.
+It's not properly tested for memory leakage and may or may not work with configurations other than those I've tested. + +**Disclaimer**: +This program is in no way affiliated with Sapd or HeadsetControl. +All issues regarding the functionality of HeadsetControl (like compatiblity with devices) are beyond the scope of this project.