OpenTweak

🎮 The Transparent, Open-Source Alternative to Twiki

Automatically optimize your PC games with deterministic tweaks from PCGamingWiki — no black boxes, no guesswork, full transparency.

Features • Installation • Usage • Tech Stack • Architecture • Contributing • License

---

💰 Distribution Model

OpenTweak is source-available and free to build, with pre-built binaries available for purchase.

	Build from Source	Buy Pre-built
Price	Free	$25 USD
Source Code	✅ Full access	✅ Full access
Features	✅ All features	✅ All features
Convenience	Build it yourself	Download and run
Support	Community	Priority

Purchase: BuyMeACoffee - OpenTweak

Why charge for binaries? As a student, I can't afford code signing certificates. The fee helps keep the project sustainable while keeping source code fully open. You're paying for convenience, not access.

---

✨ Why OpenTweak?

Most game optimization tools are black boxes — you don't know what they're doing to your system. OpenTweak is different:

	OpenTweak	Other Tools
Transparency	✅ Full source code available	❌ Closed source
Auditability	✅ Read exactly what each tweak does	❌ Hidden operations
Reversibility	✅ Automatic backups before any change	❌ Often irreversible
Reliability	✅ Deterministic recipes from PCGamingWiki	❌ AI guesswork
Privacy	✅ No telemetry, works offline	❌ Cloud-dependent

"Don't trust, verify." — OpenTweak puts you in control of your gaming experience.

---

🚀 Features

🎯 Multi-Launcher Game Discovery

Automatically discovers installed games from all major PC gaming platforms:

• Steam — Scans library folders and app manifests
• Epic Games Store — Parses .item manifest files
• GOG Galaxy — Reads registry entries
• Xbox Game Pass — Scans WindowsApps folder
• Manual Addition — Add any game by path

📚 Deterministic Tweaks from PCGamingWiki

Fetches structured optimization data directly from PCGamingWiki using the Cargo API — no brittle HTML scraping:

• Video settings (resolution, frame rate, VSync)
• Audio fixes (crackling, latency)
• Input optimizations (raw input, acceleration)
• Performance tweaks (shadow quality, draw distance)
• Bug fixes and workarounds

💾 Automatic Backup & Restore

The "Holy Grail" feature: Every configuration file is backed up before modification:

• One-click snapshot creation
• Full restore to previous state
• Multiple restore points per game
• Never worry about breaking your game

🎨 Windows 11 Modern UI

Built with WPF-UI for a native Windows 11 experience:

• Mica/Acrylic backdrop effects
• List/Grid view toggle
• Animated slide-over detail panel
• Fluent Design System
• Dark mode support

---

📸 Screenshots

Main library view with grid layout and search

Game detail panel showing available tweaks

---

📦 Installation

Option 1: Purchase Pre-built Binary (Recommended)

1. Purchase from BuyMeACoffee — $25 USD
2. Download the executable
3. Run OpenTweak.exe
4. Enjoy optimized gaming!

Option 2: Build from Source

# Clone the repository
git clone https://github.com/nathanielopentweak/opentweak.git
cd opentweak

# Build and run
dotnet build OpenTweak.sln --configuration Release
./OpenTweak/bin/Release/net8.0-windows/OpenTweak.exe

Requirements:

• Windows 10 or later
• .NET 8.0 SDK (Download)

See docs/DISTRIBUTION.md for detailed build instructions.

---

🎮 Usage

1. Launch OpenTweak — Your games are automatically discovered
2. Select a game — Click any game in your library
3. Browse tweaks — See available optimizations from PCGamingWiki
4. Apply tweaks — Click to apply; backups are created automatically
5. Restore if needed — Use the backup panel to undo changes

---

🏗️ Tech Stack

Component	Technology
Framework	.NET 8 + WPF
UI Library	WPF-UI (Windows 11 Fluent Design)
Database	LiteDB (Embedded NoSQL)
Config Parsing	Salaros.ConfigParser (Safe INI/CFG)
MVVM Framework	CommunityToolkit.Mvvm
Data Source	PCGamingWiki Cargo API

---

🏛️ Architecture

OpenTweak follows a layered architecture with clear separation of concerns:

┌─────────────────────────────────────────────────────────────┐
│                        UI Layer (Views)                      │
│              MainWindow, GameDetailView, GridView            │
├─────────────────────────────────────────────────────────────┤
│                    ViewModel Layer                           │
│              MainViewModel, GameDetailViewModel              │
├─────────────────────────────────────────────────────────────┤
│                     Service Layer                            │
│    GameScanner, PCGWService, TweakEngine, BackupService      │
├─────────────────────────────────────────────────────────────┤
│                     Data Layer                               │
│              LiteDB (Game, TweakRecipe, Snapshot)            │
└─────────────────────────────────────────────────────────────┘

See docs/Architecture/Overview.md for detailed architecture documentation.

---

🤝 Contributing

Contributions are welcome! Please read our Contributing Guide for details.

Development Setup

# Clone
git clone https://github.com/nathanielopentweak/opentweak.git
cd opentweak

# Restore
dotnet restore

# Build
dotnet build

# Test
dotnet test

---

📄 License

This project is licensed under the PolyForm Shield License 1.0.0 with Commercial Distribution Addendum.

Quick Summary

• ✅ View source code
• ✅ Build for personal use (free)
• ✅ Modify for personal use
• ❌ Distribute pre-built binaries (without permission)
• ❌ Operate automated build services for others
• ❌ Create competing products

Binary Distribution

Pre-built binaries are available exclusively through:

• BuyMeACoffee: https://buymeacoffee.com/opentweak ($25 USD)

See LICENSE.md for full terms and docs/DISTRIBUTION.md for distribution details.

---

🙏 Acknowledgments

• PCGamingWiki — For maintaining the comprehensive game optimization database
• WPF-UI — For the beautiful Windows 11 UI components
• PolyForm Project — For the Shield license

---

Made with ❤️ by a student developer