Skip to content

User-friendly GUI for OptiScaler - making AMD FSR, Intel XeSS and NVIDIA DLSS accessible to all gamers. One-click installation, automatic game detection, robust multi-tier architecture.

Notifications You must be signed in to change notification settings

King4s/OptiScaler-GUI

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

35 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

OptiScaler GUI 🎮🚀

Release License: MIT Platform OptiScaler Python

Feature Status
📦 Portable Version ✅ v0.3.5
🎮 Steam Auto-Detection ✅ Full
🎮 Epic Games Auto-Detection ✅ Full
� GOG Galaxy Auto-Detection ✅ Full
� Xbox Game Pass Auto-Detection ✅ Full
� Manual Path Selection ✅ All Platforms
🚀 FSR / DLSS / XeSS ✅ All 3
🐍 Python Runtime ✅ Bundled
🌍 Multi-language UI ✅ DA / EN / PL

An easy-to-use installer and manager for OptiScaler - helps you install the graphics enhancement mod with just a few clicks!

🤔 What is this project?

📸 GUI Preview

Coming soon: Animated GIF showing the interface in action

Quick Visual Guide:

  1. 🔍 Scan Games → Automatically detects Steam library
  2. 🎯 Select Game → Choose from detected games list
  3. 📦 Pick Version → Latest OptiScaler recommended
  4. One Click Install → GUI handles everything!
  5. 🎮 Launch & Play → Enhanced graphics ready!

How OptiScaler and OptiScaler-GUI Work Together

These are NOT competing tools - they work together!

🎮 OptiScaler (the main project):

  • Graphics enhancement mod that improves game performance
  • Provides in-game overlay (Insert key) for runtime settings
  • Adjust FSR/DLSS/XeSS settings while playing
  • Configure upscaling in real-time

🛠️ OptiScaler-GUI (this installer):

  • Makes installing OptiScaler easier for everyone
  • Automatically downloads latest OptiScaler releases
  • Detects your games and installs OptiScaler for you
  • Manages OptiScaler across multiple games

Simple workflow: Use this GUI to install OptiScaler → Then use OptiScaler's in-game overlay to adjust settings

What this GUI does

  • Installs OptiScaler into your games (replaces manual file copying)
  • Downloads latest OptiScaler releases automatically
  • Detects Steam games and suggests installation targets
  • Manages OptiScaler versions across multiple games
  • Provides user-friendly installation for non-technical users

What this GUI does NOT do

  • ❌ Replace OptiScaler's built-in overlay
  • ❌ Change in-game upscaling settings
  • ❌ Modify OptiScaler's core functionality
  • ❌ Work without the official OptiScaler files

Think of it as: A desktop installer/manager, like how Steam manages game installations.

Version: 0.3.5 | Status: Early Development | 🚀 NEW: Ultra-Compact Portable Version!

🆕 What's New in v0.3.5

📦 Ultra-Compact Portable Version - 66% Smaller!

  • 🎯 Download & Run: Get the portable ZIP, extract, and run - no Python installation needed!
  • 📋 Complete Package: All dependencies bundled including Python runtime and 7z.exe
  • 🔧 Self-Contained: Works on any Windows system without additional software
  • 💿 Size: ~48 MB portable package (down from 143 MB - 66% smaller!)

🚀 Download Options

🎯 For End Users (Recommended)

📥 Download Portable Version v0.3.5

Package Type Size Checksum Notes
📦 Portable ZIP ~48 MB See release page No installation required - 66% smaller!
🛠️ Future: .EXE Installer TBD Coming soon Auto-install + shortcuts

Features:

  • ✅ No Python installation required
  • ✅ No dependencies to install
  • ✅ Just download, extract, and run!
  • ✅ Bundled 7z.exe for archive extraction
  • ✅ Includes Python runtime (3.8+)

🛠️ For Developers

  • Clone repository and run from source (see Development section below)

✨ What is OptiScaler GUI?

This is an INSTALLATION MANAGER for OptiScaler - not a replacement for its built-in features!

🔧 Technical Architecture

What happens when you use this GUI:

  1. Download Process:

    • Fetches latest OptiScaler releases from official GitHub
    • Downloads .7z archives (e.g., OptiScaler_v0.7.7-pre9_Daria.7z)
    • Extracts using bundled 7z.exe or system 7-Zip
  2. Installation Process:

    • Copies OptiScaler.dll to your game directory
    • Renames it to appropriate proxy DLL (dxgi.dll, nvngx.dll, etc.)
    • Copies additional files (OptiScaler.ini, FSR/XeSS libraries)
    • Creates basic configuration for your game
  3. Integration:

    • OptiScaler becomes active when you launch the game
    • Use Insert key in-game to access OptiScaler's built-in overlay
    • All runtime configuration happens through OptiScaler's native UI

Technology Stack:

  • Language: Python 3.8+ with Tkinter GUI
  • Architecture: Desktop application (not web-based)
  • Distribution: PyInstaller portable executable
  • File Handling: 7z.exe + py7zr + zipfile fallbacks
  • Game Detection: Steam registry scanning + manual path selection
  • OptiScaler Integration: File-based installation (no API/injection)

🎯 Key Features

  • 🔍 Automatic Game Detection: Scans Steam library and detects installed games
  • 📦 One-Click Installation: Download and install OptiScaler with a single click
  • 🔧 Intelligent Configuration: Smart setup for AMD FSR, Intel XeSS, and NVIDIA DLSS
  • 🛡️ Robust Architecture: Multi-tier fallback systems for maximum compatibility
  • 🌐 Complete Portable Support: Bundled 7z.exe and all dependencies included
  • 🎮 Unreal Engine Support: Enhanced detection for UE games (Engine/Binaries/Win64)
  • 💾 Backup & Restore: Safe installation with automatic backup of original files
  • 📊 Real-Time Progress: Visual feedback during downloads and installations
  • 🔄 Update Management: Automatic checking for latest OptiScaler releases
  • 🌍 Multi-Language: Support for Danish, English, and Polish

🎮 What is OptiScaler?

OptiScaler is a DirectX proxy DLL that enables:

  • AMD FSR 1.0, 2.0, 3.0 - FidelityFX Super Resolution
  • Intel XeSS - Xe Super Sampling
  • NVIDIA DLSS - Deep Learning Super Sampling

This GUI makes OptiScaler installation accessible to everyone - no more manual file copying or configuration editing!

🔄 Workflow: Before vs After

Manual Installation (Before)

  1. Download OptiScaler .7z from GitHub releases
  2. Extract archive using 7-Zip
  3. Navigate to game installation directory
  4. Manually copy OptiScaler.dll
  5. Rename it to correct proxy DLL name
  6. Copy additional FSR/XeSS libraries
  7. Create/edit OptiScaler.ini configuration
  8. Test game launch and troubleshoot issues

Time: 10-15 minutes per game + troubleshooting

GUI Installation (After)

  1. Launch OptiScaler-GUI.exe
  2. Click "Scan for Games"
  3. Select game from detected list
  4. Click "Install OptiScaler"
  5. Launch game and use Insert key for OptiScaler overlay

Time: 30 seconds per game

🚀 Quick Start

🎯 Option 1: Portable Version (Recommended for Users)

  1. 📥 Download the Portable Version
  2. Extract the ZIP file to your desired location
  3. Run OptiScaler-GUI.exe inside the extracted folder
  4. Done! No installation or Python setup required

⚠️ Note: This is an early development version (0.3.5) - test thoroughly before using on important games!

🛠️ Option 2: Development Setup

Prerequisites

  • Windows 10/11
  • Python 3.8+ (Download Python)
  • Steam (for automatic game detection)

Installation

  1. Clone the repository:

    git clone https://github.com/King4s/OptiScaler-GUI.git
    cd OptiScaler-GUI
  2. Install dependencies:

    pip install -r requirements.txt
  3. Check system requirements (optional):

    python check_requirements.py
  4. Launch the GUI:

    python src/main.py

🏃‍♂️ Quick Launch Scripts

For convenience, you can also use:

  • start_gui.bat - Direct launch of the GUI
  • run_progress_tests.bat - Run system tests

🎯 Usage

For Portable Version Users:

  1. Launch OptiScaler-GUI.exe from the extracted folder
  2. Scan for games - Automatically detects your Steam library
  3. Select a game from the detected list
  4. Choose OptiScaler version (latest recommended)
  5. Click Install - GUI handles everything automatically!
  6. Configure settings for optimal performance
  7. Launch your game and enjoy enhanced performance!

Additional Features:

  • 📁 Manual Path Selection: Browse for games not automatically detected
  • 🌍 Multi-Language Support: Danish, English, Polish (auto-detection)
  • 🔄 Auto-Updates: OptiScaler version checking and updates
  • 📋 Progress Tracking: Real-time installation progress with detailed logs

🏗️ Architecture Highlights

Robust Multi-Tier Systems

  • Archive Extraction: System 7z.exe → py7zr → zipfile fallback
  • Installation Methods: Direct install → backup & restore → fallback modes
  • Error Handling: Comprehensive error detection and user guidance
  • Compatibility: Works on all Windows systems regardless of installed tools

Staying Updated with OptiScaler

This project tracks the official OptiScaler releases. To check for updates to the main project:

git fetch upstream
git log --oneline upstream/master --since="1 week ago"

🛠️ Development

Project Structure

OptiScaler-GUI/
├── src/
│   ├── gui/              # User interface components
│   ├── optiscaler/       # OptiScaler management
│   ├── scanner/          # Game detection system
│   ├── utils/            # Utility functions
│   └── translations/     # Multi-language support
├── cache/                # Downloaded files and cache
├── assets/               # GUI assets and icons
└── tests/                # Test suite

Running Tests

# Test core functionality
python test_archive_extractor.py    # Test archive extraction
python test_progress_simple.py      # Test progress systems
python check_requirements.py        # Validate environment

# Run comprehensive tests
./run_progress_tests.bat            # Full test suite

Building Portable Version

# Build executable with PyInstaller
python build.py                     # Creates portable .exe in dist/

📦 Release Information

Current Version: 0.3.5 (Development Release)

  • Portable Version Available: Self-contained executable with all dependencies
  • Size: ~48 MB (includes Python runtime and all libraries - 66% size reduction!)
  • Compatibility: Windows 10/11, no Python installation required

🔄 OptiScaler Version Compatibility

GUI Version Compatible OptiScaler Versions Status
v0.3.5 v0.7.0 - v0.7.7-pre9 ✅ Current
v0.3.0 v0.7.0 - v0.7.7-pre9 🟡 Legacy
v0.2.0 v0.6.0 - v0.7.0 🟡 Legacy
v0.1.0 v0.5.0 - v0.6.5 ❌ Deprecated

🔧 Supported Installation Methods

  • Proxy DLL Installation: dxgi.dll, winmm.dll, nvngx.dll
  • Direct Installation: OptiScaler.dll placement
  • Configuration Management: Automatic OptiScaler.ini generation
  • Library Support: FSR, XeSS, and DLSS companion files
  • Backup System: Automatic backup before installation

🎮 Tested Game Engines

Engine Support Level Notes
Unreal Engine ✅ Full Enhanced detection for UE4/UE5 games
Unity ✅ Full Standard proxy DLL installation
Custom Engines ✅ Good Manual path selection supported
DirectX 11/12 ✅ Full Primary target platform
Vulkan ✅ Good OptiScaler handles API translation

For full release notes and downloads, visit: GitHub Releases

Frequently Asked Questions

Q: How is this different from OptiScaler's built-in overlay?

A: OptiScaler has a built-in overlay (Insert key) for in-game configuration. This GUI is a separate desktop application that helps you install OptiScaler into your games. They serve different purposes:

  • OptiScaler overlay: Configure FSR/DLSS settings while playing
  • This GUI: Install OptiScaler files into game directories

Q: Is this officially supported by the OptiScaler team?

A: No, this is a community project that makes OptiScaler installation easier. It's not affiliated with or endorsed by the official OptiScaler developers.

Q: Will this interfere with OptiScaler's functionality?

A: No, this GUI only handles installation. Once installed, OptiScaler works exactly as designed - you still use the Insert key for the in-game overlay.

Q: What if I already installed OptiScaler manually?

A: The GUI can detect existing installations and help you update or manage them. It won't break existing setups.

Q: Do I still need to configure OptiScaler settings?

A: Yes! After installation, launch your game and press Insert to access OptiScaler's built-in configuration overlay. This GUI doesn't replace that functionality.

Q: Which OptiScaler versions are supported?

A: Currently supports v0.7.0 through v0.7.7-pre9. The GUI automatically downloads from the official OptiScaler releases.

Q: Can I use this for games not on Steam?

A: Yes! While it auto-detects Steam games, you can manually browse and select any game directory.

🛣️ Project Status & Roadmap

Current Status (v0.3.5)

  • Stable Installation: Reliable OptiScaler installation for most games
  • Ultra-Compact Distribution: 48 MB self-contained executable (66% size reduction)
  • Steam Integration: Automatic game detection from Steam library
  • Multi-Language: Danish, English, and Polish translations
  • Error Recovery: Robust fallback systems for edge cases

Known Limitations

  • 🟡 Configuration Limited: Basic INI generation only (use OptiScaler overlay for advanced settings)
  • 🟡 Windows Only: No Linux/Mac support (follows OptiScaler platform limitations)
  • 🟡 Steam Focused: Epic Games Store and GOG detection not yet implemented
  • 🟡 Manual Updates: GUI updates require manual download (no auto-updater)

Planned Features (Future Versions)

  • 🔮 Enhanced Game Detection: Epic Games Store, GOG, and custom launcher support
  • 🔮 Backup Management: Better backup/restore functionality with versioning
  • 🔮 Installation Profiles: Save and reuse installation configurations
  • 🔮 OptiScaler INI Editor: Basic configuration editor (complementary to overlay)
  • 🔮 Auto-Update System: Automatic GUI updates and OptiScaler tracking

Community Feedback Needed

  • 📊 Compatibility Reports: Which games work well vs need fixes?

  • 🐛 Bug Reports: Installation failures or edge cases

  • 💡 Feature Requests: What would make installation easier?

  • 🌍 Language Support: Additional translation requests

  • OptiScaler is developed by the talented team at optiscaler/OptiScaler

  • This GUI is an independent installation manager created by King4s

  • All credit for the actual upscaling technology goes to the OptiScaler team

  • For OptiScaler support, issues, or questions, please visit the official repository

Relationship to OptiScaler

┌─────────────────────────────────────────────────────────────┐
│                     OptiScaler Ecosystem                     │
├─────────────────────────────────────────────────────────────┤
│                                                             │
│  📦 Official OptiScaler                                     │
│  ├── Core upscaling technology (FSR, DLSS, XeSS)           │
│  ├── In-game overlay (Insert key)                          │
│  ├── Runtime configuration                                 │
│  └── DirectX/Vulkan integration                            │
│                                                             │
│  🖥️ This GUI (Community Project)                           │
│  ├── Installation manager                                  │
│  ├── Steam game detection                                  │
│  ├── File download/extraction                              │
│  └── Basic configuration setup                             │
│                                                             │
└─────────────────────────────────────────────────────────────┘

🤝 Community & Support

📢 Get Help & Report Issues

🎯 Supported Games & Compatibility

  • Steam Games - Automatic detection
  • Unreal Engine - Enhanced support for UE games
  • DirectX 11/12 - Full compatibility
  • ⚠️ Non-Steam Games - Manual path selection required
  • Game not working? - Report compatibility issue

🔒 Security & Trust

  • 📝 Open Source - All code is public and auditable
  • 🛡️ No Data Collection - GUI works completely offline
  • Official Sources - Downloads OptiScaler from official GitHub only
  • 🔍 Checksums - Verify download integrity (coming soon)

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

  • OptiScaler Team - For the incredible upscaling technology
  • Python Community - For the amazing libraries that make this possible
  • Gaming Community - For feedback and testing

Made with ❤️ for the gaming community

Bringing cutting-edge upscaling technology to everyone, one click at a time.


Made with ❤️ for the gaming community

Making OptiScaler installation accessible to everyone, one click at a time.

About

User-friendly GUI for OptiScaler - making AMD FSR, Intel XeSS and NVIDIA DLSS accessible to all gamers. One-click installation, automatic game detection, robust multi-tier architecture.

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published