SpdUp/README.md

# ⚡ SpdUp – Gaming Booster for Windows

<p align="center">
  <img src="https://img.shields.io/badge/.NET-8.0-512BD4?logo=dotnet" alt=".NET 8">
  <img src="https://img.shields.io/badge/WPF-Desktop-blue?logo=windows" alt="WPF">
  <img src="https://img.shields.io/badge/License-MIT-green" alt="MIT License">
  <img src="https://img.shields.io/badge/Platform-Windows%2010%2F11-0078D6?logo=windows" alt="Windows">
  <img src="https://img.shields.io/badge/Made%20with-%E2%9D%A4%EF%B8%8F%20by%20Mandy-ff69b4" alt="Made with love by Mandy">
</p>

<p align="center">
  <b>A free, open-source Windows gaming optimizer that boosts your PC's performance with a single click.</b>
</p>

---

## 🚀 Features

| Feature | Description |
|---|---|
| **One-Click Boost** | CPU priority, RAM cleanup, timer resolution, GPU power profiles, network tuning, and service management — all in one click |
| **RAM Optimizer** | Deep working-set trimming + Windows Standby List purge via kernel-level calls |
| **Real-Time Monitor** | Live CPU, GPU, RAM, temperatures, fan speeds, and network latency via LibreHardwareMonitor |
| **Network Optimizer** | TCP registry tweaks (Nagle's algorithm, ACK frequency, auto-tuning) for low-latency gaming |
| **Service Manager** | Identifies and safely disables non-essential Windows services during gaming |
| **Game Detection** | Auto-detects 30+ popular games (Steam, Epic, Riot, Blizzard, EA) and applies boost automatically |
| **Shader Cache Cleaner** | Clears DirectX, NVIDIA, AMD, and Intel shader caches to fix stuttering |
| **Process Manager** | View and manage processes with CPU priority and affinity controls |
| **Desktop Widget** | Always-on-top floating overlay with live metrics and quick-boost button |
| **Debug Log** | Built-in live log viewer with filtering, copy, and file logging |

## 📸 Screenshots

<p align="center">
  <i>Dark gaming UI with custom window chrome, sidebar navigation, and live system metrics</i>
</p>

> Add your screenshots to the `website/screenshots/` folder and reference them here.

## 🏗️ Tech Stack

- **.NET 8** — Latest runtime, self-contained deployment (no framework install needed)
- **WPF** — Windows Presentation Foundation with full MVVM architecture
- **LibreHardwareMonitor** — Accurate CPU/GPU temps, fan speeds, and clock readings
- **P/Invoke** — Kernel-level calls for RAM cleanup, timer resolution, and privilege elevation
- **Custom Dark Theme** — Styled scrollbars, buttons, data grids, and window chrome
- **Inno Setup** — Single-file installer with LZMA2 compression

## 📦 Installation

### Option 1: Installer (Recommended)
1. Download `SpdUp_Setup_1.0.0.exe` from [Releases](../../releases)
2. Run the installer
3. Launch SpdUp from the Start Menu or Desktop

### Option 2: Build from Source
```bash
git clone https://github.com/immissmandy/SpdUp.git
cd SpdUp
dotnet build SpdUp.csproj -c Release
```

### Build the Installer
```powershell
# Publish self-contained
.\build-installer.ps1

# Publish + compile Inno Setup installer
.\build-installer.ps1 -Installer
```

> Requires [Inno Setup 6](https://jrsoftware.org/isdl.php) for the `-Installer` flag.

## 🧪 Tests

```bash
dotnet test SpdUp.Tests
```

**84 unit tests** covering:
- Core infrastructure (ObservableObject, RelayCommand, Logger)
- All model classes and computed properties
- WPF value converters (7 converters, 13 tests with Theory data)
- Service layer (Network, GameDetection, Optimization, ServiceManagement)
- ViewModel logic (DebugLogViewModel with STA thread support)

## 📁 Project Structure

```
SpdUp/
├── Core/                    # ObservableObject, RelayCommand, Logger, NativeMethods (P/Invoke)
├── Models/                  # AppSettings, GameEntry, ProcessEntry, ServiceEntry, SystemMetrics
├── Services/                # Optimization, RAM, Network, GameDetection, Monitoring, ShaderCache
├── ViewModels/              # MVVM ViewModels for each page
├── Views/                   # WPF XAML Views + code-behind
├── Themes/                  # DarkTheme.xaml (full custom dark gaming theme)
├── Converters/              # WPF value converters
├── Installer/               # Inno Setup script (SpdUpSetup.iss)
├── SpdUp.Tests/             # xUnit test project (84 tests)
├── website/                 # Landing page (index.html)
├── build-installer.ps1      # Build + package script
└── SpdUp.csproj             # .NET 8 WPF project
```

## ⚙️ How It Works

1. **Install & Launch** — SpdUp runs with administrator privileges for deep system access
2. **Hit Boost** — Optimizes CPU, RAM, GPU, network, timer resolution, and disables unnecessary services
3. **Game On** — Play with maximum performance; click Restore when done to revert all changes

All changes are **fully reversible**. SpdUp saves previous states and restores them on deactivation.

## 💻 System Requirements

| Requirement | Minimum |
|---|---|
| OS | Windows 10/11 (64-bit, version 1809+) |
| RAM | 4 GB (8 GB recommended) |
| Disk Space | ~200 MB |
| Privileges | Administrator (for RAM cleanup, service control, timer resolution) |

## 🏳️‍⚧️ Made with ❤️ by Mandy

<p align="center">
  <img src="https://img.shields.io/badge/%F0%9F%8F%B3%EF%B8%8F%E2%80%8D%E2%9A%A7%EF%B8%8F-Trans%20Pride-5bcefa?labelColor=f5a9b8" alt="Trans Pride">
</p>

## 📄 License

This project is licensed under the MIT License — see the [LICENSE](LICENSE) file for details.