Skip to content

Commit 5df2776

Browse files
committed
Update README.md
1 parent 010dee6 commit 5df2776

1 file changed

Lines changed: 65 additions & 36 deletions

File tree

README.md

Lines changed: 65 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,61 +1,90 @@
1-
# ThreadPilot
1+
# ThreadPilot ✈️ <sup><kbd>v1.0.0</kbd></sup>
22

3-
ThreadPilot is a Windows process and power plan manager built with WPF and .NET 8.
4-
It is focused on deterministic performance workflows for power users, gamers, and admins.
3+
[![Status](https://img.shields.io/badge/Status-v1.0.0-success.svg)]()
4+
[![Windows](https://img.shields.io/badge/Windows-10%2F11-blue?logo=windows&logoColor=white)](https://www.microsoft.com/windows)
5+
[![.NET](https://img.shields.io/badge/.NET-8.0-purple?logo=dotnet&logoColor=white)](https://dotnet.microsoft.com/)
6+
[![WPF](https://img.shields.io/badge/WPF-Windows%20Presentation%20Foundation-blue?logo=microsoft&logoColor=white)](https://docs.microsoft.com/en-us/dotnet/desktop/wpf/)
7+
[![License](https://img.shields.io/badge/License-GPLv3-blue.svg)](LICENSE)
8+
[![Release](https://img.shields.io/badge/Release-Latest-brightgreen)](../../releases)
9+
[![Architecture](https://img.shields.io/badge/Architecture-x64-red?logo=windows&logoColor=white)](https://docs.microsoft.com/en-us/windows/win32/)
510

6-
## Highlights
11+
**ThreadPilot** is a Windows application for advanced **process management**, **CPU affinity control**, and **power plan automation**.
12+
Built with WPF and .NET 8, it is focused on deterministic performance workflows for power users, gamers, and system admins who want precise control over system resources.
713

8-
- Process management with CPU affinity and priority controls.
9-
- Rule-based automation for process-triggered power plan behavior.
10-
- Global power plan management with explicit separation from per-process actions.
11-
- System tweaks panel for advanced Windows performance settings.
12-
- Performance Intelligence dashboard with hotspots, rule impact, and timeline events.
13-
- Light/Dark theming with runtime switching.
14+
[![Thread-Pilotbanner.png](https://i.postimg.cc/sDZLXMqr/Thread-Pilotbanner.png)](https://postimg.cc/cr0hkLd9)
1415

15-
## Requirements
16+
## ✨ Features & Highlights
1617

17-
- Windows 10/11 (x64)
18-
- .NET 8 SDK for building from source
19-
- Administrator privileges for full functionality
18+
- **Advanced Process Management:** Real-time monitoring with CPU affinity and priority controls.
19+
- **Enterprise-Grade Rules & Automation:** Rule-based automation for process-triggered power plan behavior, featuring graceful failure handling for Anti-Cheat protected games (Vanguard, EAC, BattlEye).
20+
- **Performance Intelligence Dashboard:** Interactive dashboard with process hotspots, rule impact analysis, and timeline events.
21+
- **Global vs. Per-Process Control:** Explicit visual separation of global power plan management from per-process actions.
22+
- **System Tweaks:** Advanced Windows performance settings panel.
23+
- **Dynamic Theming:** Light/Dark theming with seamless runtime switching.
24+
- **Profile-based Configuration:** Persistent settings, customizable notification levels, and low-overhead minimized tray mode.
2025

21-
## Build
26+
<img width="1474" height="920" alt="Screenshot 2025-12-21 044753" src="https://github.com/user-attachments/assets/77fc944e-d2a1-4cc7-9915-e01b0776106c" />
2227

23-
```bash
24-
dotnet build "ThreadPilot_1.sln" --configuration Release
25-
```
28+
## ⚙️ Requirements
29+
30+
- **OS:** Windows 10 / 11 (x64)
31+
- **Privileges:** Administrator privileges required for full WMI functionality and process control.
32+
- **SDK:** .NET 8.0 SDK (only required for building from source).
2633

27-
## Run
34+
---
2835

36+
## 📦 Installation
37+
38+
### Portable / Setup (Recommended)
39+
1. Download the latest `ThreadPilot_v1.0.0` release from [GitHub Releases](../../releases)
40+
2. Extract the archive
41+
3. Run `ThreadPilot.exe` **as Administrator**
42+
43+
### Build from source
2944
```bash
45+
git clone [https://github.com/PrimeBuild-pc/ThreadPilot.git](https://github.com/PrimeBuild-pc/ThreadPilot.git)
46+
cd ThreadPilot
47+
dotnet build "ThreadPilot_1.sln" --configuration Release
3048
dotnet run --project "ThreadPilot.csproj" --configuration Release
31-
```
49+
````
3250

33-
Useful arguments:
51+
*Useful startup arguments: `--start-minimized`, `--autostart`, `--test`*
3452

35-
- `--start-minimized`
36-
- `--autostart`
37-
- `--test` (console test mode)
53+
-----
3854

39-
## Test Mode
55+
## 🧪 Test Mode
4056

41-
Console test mode runs via the app entrypoint and uses `TestRunner.cs`.
57+
Console test mode runs via the app entrypoint and uses the integrated `TestRunner.cs`.
58+
*(Note: `dotnet test` will only execute tests in dedicated test projects; this repository currently uses an integrated runtime test runner).*
4259

4360
```bash
4461
dotnet run --project "ThreadPilot.csproj" --configuration Release -- --test
4562
```
4663

47-
Notes:
64+
*Note: In environments where elevation is required to start the app process, test mode requires an elevated terminal.*
65+
66+
-----
67+
68+
## 🛠️ Architecture & Tech Stack
69+
70+
* **.NET 8.0** & **WPF**
71+
* **MVVM** pattern using `CommunityToolkit.Mvvm`
72+
* **Dependency Injection** (`Services/ServiceConfiguration.cs`)
73+
* **Rules & Automation Engine** (`Services/ProcessPowerPlanAssociationService.cs` & `ViewModels/ProcessPowerPlanAssociationViewModel.cs`)
74+
* **Performance Dashboard** (`Views/PerformanceView.xaml` & `ViewModels/PerformanceViewModel.cs`)
75+
76+
-----
77+
78+
## 📄 License
4879

49-
- In environments where elevation is required to start the app process, test mode may need an elevated terminal.
50-
- `dotnet test` will only execute tests in dedicated test projects; this repository currently uses an integrated runtime test runner.
80+
This project is licensed under the **GNU General Public License v3.0**.
81+
See [LICENSE](https://www.google.com/search?q=LICENSE) for details.
5182

52-
## Architecture Notes
83+
-----
5384

54-
- MVVM with CommunityToolkit.Mvvm.
55-
- DI configuration in `Services/ServiceConfiguration.cs`.
56-
- Rules and automation in `Services/ProcessPowerPlanAssociationService.cs` and `ViewModels/ProcessPowerPlanAssociationViewModel.cs`.
57-
- Performance dashboard in `Views/PerformanceView.xaml` and `ViewModels/PerformanceViewModel.cs`.
85+
## 📞 Support
5886

59-
## License
87+
**Made for Windows power users☕** [](https://paypal.me/PrimeBuildOfficial?country.x=IT&locale.x=it_IT)
6088

61-
GPLv3. See `LICENSE`.
89+
* **Issues**: [https://github.com/PrimeBuild-pc/ThreadPilot/issues](https://github.com/PrimeBuild-pc/ThreadPilot/issues)
90+
* **Discussions**: [https://github.com/PrimeBuild-pc/ThreadPilot/discussions](https://github.com/PrimeBuild-pc/ThreadPilot/discussions)

0 commit comments

Comments
 (0)