Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sparronator9999/yamdcc

Yet Another MSI Dragon Center Clone - A fast, lightweight alternative to MSI Center for MSI laptops, written in C#.
https://github.com/sparronator9999/yamdcc

csharp fan-control msi msi-center msi-laptop net-framework net-framework-480 open-source windows windows-forms

Last synced: about 2 months ago
JSON representation

Yet Another MSI Dragon Center Clone - A fast, lightweight alternative to MSI Center for MSI laptops, written in C#.

Awesome Lists containing this project

README 

        
# YAMDCC - Yet Another MSI (Dragon) Center Clone



A fast, lightweight alternative to MSI Center for MSI laptops, written in C#.



**Please read the whole README (or at least the [Supported Laptops](#supported-laptops) and [FAQ](#faq) sections) before downloading.**



## Disclaimers



- While this program is mostly complete, I still consider it to be **alpha-quality software!**

- While measures are taken to reduce the program crash chance, you *will* still likely encounter

  bugs while using this program, especially if feeding the program garbage configs.

- This program requires low-level access to some of your computer hardware to apply settings. While

  no issues should arise from this, **I (Sparronator9999) and any other contributers**

  **shall not be held responsible if this program fries your computer.**

- Additionally, if you do something silly with the program like turn off all your fans while

  running under full load, **we *will not* be held responsible for *any* damage you cause to your**

  **own hardware from your use of this program.**

- Linux is not yet supported. Please don't beg me for Linux support, it will come when I can be

  bothered (and when I figure out how to run background services/daemons on Linux).

- This program, repository and its authors are not affiliated with Micro-Star International Co., Ltd. in any way, shape, or form.



## Features



- **Fan control:** Change the fan curves for your CPU and GPU fans, including fan speeds,

  temperature thresholds, and Full Blast (a.k.a. Cooler Boost in MSI Center). This allows you to

  fix a curve that is not aggressive enough under full load, or to turn your fans off when your

  computer is idle.

- **Performance mode:** MSI laptops have their own performance mode setting (not to be confused

  with Windows' built-in power plans). You can change it here.

- **Charging threshold:** This program can limit how much your laptop's battery charges to, which

  can help reduce battery degradation, especially if you leave your laptop plugged in all the time.

- **Lightweight:** YAMDCC takes up less than a megabyte of disk space when installed, and is

  designed to be light on your laptop's CPU.

- **Configurable:** Almost all settings (including those not accessible through the config GUI) can

  be changed with the power of XML.



## Screenshots



![A screenshot of YAMDCC's fan control interface](Media/YAMDCC-FanControlTab.png)



![A screenshot of YAMDCC's extra options interface](Media/YAMDCC-ExtrasTab.png)



## Supported Laptops



Currently, there is only a config for the MSI GF63 Thin 11SC, but other MSI laptops with a 10th-gen

or later Intel CPU should also work, just with an incorrect default fan curve.



An update will add support for reading the default fan curve of more MSI laptops (including 9th-gen and older).



Other laptop brands are not officially supported. You can still try and make your own config, but chances

are you're looking for [NoteBook FanControl](https://github.com/UraniumDonut/nbfc-revive) instead.



### Community tested laptops



The following laptops have been tested by the community and are confirmed to be working:



- MSI Katana GF66 12UG (thanks @porkmanager)

- MSI Vector GP78 HX 13V (thanks @Twisted6)

- MSI Raider GE66 12UGS (thanks @grimy400)



### Config disclaimers



- The config format is very likely to change multiple times during YAMDCC's development before

  release, and as such will break in new updates. Check the git history before updating.

- **Please avoid asking me (or other people) in the issue tracker to create a config for you.**

  **Unless we have your specific laptop model (which we probably don't), we will not be able to**

  **help you outside of the general instructions.**



## Comparison



| Feature                   | MSI Center | YAMDCC   |

|---------------------------|------------|----------|

| Installed size            | ~950 MB¹   | ~1 MB¹   |

| Fan control               | ✔          | ✔        |

| Temp. threshold control   | ❌          | ✔        |

| Multi-fan profile support | ❌          | ✔        |

| Charge threshold setting  | Limited²   | ✔        |

| Perf. mode setting        | ✔          | ✔        |

| Win/Fn key swap           | ✔          | ✔        |

| Win key disable           | ✔          | ❌        |

| Hardware monitoring       | ✔          | Limited³ |

| Other MSI Center features | ✔          | ❌        |

| Open source               | ❌          | ✔        |



1: As of v2.0.38, MSI Center takes about 950 MB of storage space when counting the UWP app (749 MB) and the files installed on first launch to `C:\Program Files (x86)\MSI` (205 MB). YAMDCC's installed size is based on the Release build of [commit 0422376](https://github.com/Sparronator9999/YAMDCC/commit/0422376), and includes all unzipped program files, but excludes config XMLs.



2: MSI Center only supports setting the charge threshold to 60%, 80%, or 100%, while YAMDCC can set this to anything between 0 and 100% (with 0 meaning charge to 100% always).



3: YAMDCC only supports monitoring the CPU/GPU temperatures and fan speeds via EC.



## Roadmap



Below are some changes I would like to make before a 1.0 release of YAMDCC:



- [ ] Config generation for MSI laptops *(implemented in service, UI in progress)*

  - This would only work because many MSI laptops have almost identical EC register locations

    for all the relevent settings we change

  - The only thing we need to do is get the default fan curve from the user's laptop, and add

    it to the default fan profile.

- [ ] Revamp IPC between service and config applications *(started)*

  - Currently, there is no "acknowledgement" system for commands sent to the service,

    even for commands that expect data to be returned. This means no errors if the service

    crashes before fulfilling a received command.

- [ ] Fix any remaining bugs before the 1.0 release.

  - I will start releasing betas once the above points are complete.



Below are some planned features for potential future releases:



- [ ] Keyboard shortcut support (requested by @grimy400)

- [ ] CLI support

  - Development of a CLI application for YAMDCC has started, but isn't publicly available yet

    - It hasn't been updated for quite a while (to the point where it still has the

      project's original name) and is missing a *lot* of features.

- [ ] Support for editing laptop config registers using the GUI/CLI

  - This would allow for creating configs for other laptop brands from the config UI

  - Currently, the only way to do this is to edit the XML directly

- [ ] Plugin system for additional optional features

- [ ] .NET support

  - Mandatory for Linux support

  - The GUI *should* compile on .NET 8 (and in fact *has* been compiled on .NET 8 before).

  - The Windows service on the other hand... is going to be interesting. Even

    with the `Microsoft.Windows.Compatibility` package installed, I still

    wasn't able to get the service to run without issues.

- [ ] Linux support *(not guaranteed)*

  - Now this would require some figuring out, and may end up being a seperate

    project that's compatible with this project's configs.



## Download



Development builds are available through [GitHub Actions](https://github.com/Sparronator9999/YAMDCC/actions).



Alternatively, if you don't have a GitHub account, you can download the latest build from

[nightly.link](https://nightly.link/Sparronator9999/YAMDCC/workflows/build/main?preview).



(You probably want the `Release` build, unless you're debugging issues with the program)



Alternatively, you can [build the program yourself](#build).



## Build



### Using Visual Studio



1.  Install Visual Studio 2022 with the `.NET Desktop Development` workload checked.

2.  Download the code repository, or clone it with `git`.

3.  Extract the downloaded code, if needed.

4.  Open `YAMDCC.sln` in Visual Studio.

5.  Click `Build` > `Build Solution` to build everything.

6.  Your output, assuming default build settings, is located in `YAMDCC.GUI\bin\Debug\net48\`.

7.  ???

8.  Profit!



Make sure to only use matching `yamdccsvc.exe` and `YAMDCC.exe` together, otherwise you

may encounter issues (that means `net stop yamdccsvc` first, then compile).



### From the command line



1.  Follow steps 1-3 above to install Visual Studio and download the code.

2.  Open `Developer Command Prompt for VS 2022` and `cd` to your project directory.

3.  Run `msbuild /t:restore` to restore the solution, including NuGet packages.

4.  Run `msbuild YAMDCC.sln /p:platform="Any CPU" /p:configuration="Debug"` to build

    the project, substituting `Debug` with `Release` (or `Any CPU` with `x86` or `x64`)

    if you want a release build instead.

5.  Your output should be located in `YAMDCC.GUI\bin\Debug\net48\`, assuming you built

    with the above unmodified command.

6.  ???

7.  Profit!



## Issues



If your question isn't already answered in the [FAQ](#faq) or [issues megathread](https://github.com/Sparronator9999/YAMDCC/issues/1),

feel free to open an issue. Please make sure to use the correct issue template for your problem.



## Contributing



See the [build instructions](#build) to build this project.



If you would like to contribute to the project with bug fixes, new features,

or new configs, feel free to open a pull request. Please include the following:



- **Bug Fixes/Improvements:** Describe the changes you made and why they

  are important or useful.

- ~~**New Config:**~~ Not currently accepting new configs. Wait for the config

  generation feature to be finished.



## FAQ



### What versions of Windows do you support?



Windows 10 and 11 (64-bit).



32-bit Windows 10 should also work, but you really should be using 64-bit Windows when possible in 2024.



Older versions of Windows that support .NET Framework 4.8 may also work, but with no support from me.



### Can you please make a Linux version?



Soon™.



Use one of the [many](https://github.com/dmitry-s93/MControlCenter) [other](https://github.com/gourav1100/isw)

[projects](https://github.com/YoCodingMonster/OpenFreezeCenter) on GitHub instead while you wait.



### How does this program work?



YAMDCC works by accessing your laptop's embedded controller (aka, the EC). Many settings that

can be configured with MSI Center are stored here, including fan curve, performance mode,

and the Win/Fn key swap setting.



### Why do I need administrator privileges to run this program?



1. Because admin privileges are required to install kernel drivers, and...



2. For security reasons, only programs with admin privileges are allowed to communicate with the

YAMDCC service once it's running.



### Why does this program need a kernel driver?



Because communicating with the EC requires low-level hardware access, something only possible from

within the kernel. This program achieves this with [WinRing0](https://github.com/GermanAizek/WinRing0).



### Doesn't WinRing0 have security issues?



[Yes](https://voidsec.com/crucial-mod-utility-lpe-cve-2021-41285/), however YAMDCC mitigates this

by installing the driver such that only programs run with administrator privileges can communicate

with the driver.



Why wasn't this done by the driver itself in the first place, you might ask? Honestly, I don't know

how this slipped through during development, but here we are. Unfortunately the

[updated fork of WinRing0](https://github.com/GermanAizek/WinRing0) that *does* fix this

vulnerability driver-side doesn't have a binary release due to Microsoft's strict driver signing

requirements.



NOTE:

If YAMDCC finds the driver already installed, it may try to use that (potentially vulnerable)

driver instead. If it was installed with, e.g. [LibreHardwareMonitor](https://github.com/LibreHardwareMonitor/LibreHardwareMonitor),

you should be fine, as they implement the same fix that YAMDCC does.



Please read the [disclaimer](#disclaimers), especially the bold text, if you haven't already.



### My laptop isn't supported! What do I do?



[See above](#supported-laptops).



### Can you write a config for my laptop?



Again, [see above](#supported-laptops).



### Help! My laptop stopped booting/is doing weird stuff!



Reset your EC (MSI laptops only):



Shut down the laptop if it's on (force shut down if needed), then find the EC reset button

(on the GF63 Thin 11SC, it's a small hole located on the bottom of the laptop next to the charge port)

and press it with the end of a paperclip, SIM ejector, or similarly small tool for at least 5 seconds,

then try rebooting.



If the issue persists, try disconnecting all power sources, including the laptop's CMOS/clock

battery and "main" battery (requires disassembly of laptop). Leave disconnected for a few seconds,

then re-connect everything, re-assemble and attempt a reboot. This will reset your BIOS settings.



Users of other laptop brands will need to look up instructions for their laptop.



### Dark mode?



Due to WinForms limitations, no.



Technical explanation: A few specific WinForms controls used by YAMDCC look really bad

when trying to recolour them to be dark themed. Also, built-in dialog boxes (for C# programmers,

think `MessageBox.Show`) cannot be recoloured from their default white theme. Also, I have little

to no experience with other UI kits (e.g. WPF).



### .NET (Core) 5/6/8/!



Probably not for Windows (unless it goes EOL, which I doubt will happen for a while).



If Linux support ever comes, it will be using .NET (since .NET Framework isn't supported on Linux).



## License and Copyright



Copyright © 2023-2024 Sparronator9999.



This program is free software: you can redistribute it and/or modify it under

the terms of the GNU General Public License as published by the Free Software

Foundation, either version 3 of the License, or (at your option) any later

version.



This program is distributed in the hope that it will be useful, but WITHOUT ANY

WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A

PARTICULAR PURPOSE. See the [GNU General Public License](LICENSE.md) for more

details.



## Third-party Libraries



This project makes use of the following third-party libraries:



- [My fork of Named Pipe Wrapper](https://github.com/Sparronator9999/NamedPipeWrapper) for

  communication between the service and UI program (called `YAMDCC.IPC` in the source files).

- [WinRing0](https://github.com/QCute/WinRing0) for low-level hardware access required to

  read/write the EC.