Skip to content

King4s/OptiScaler-GUI

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

86 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

OptiScaler GUI ๐ŸŽฎ๐Ÿš€

Release License: MIT Platform OptiScaler Python

Feature Status
๐Ÿ“ฆ Portable Version โœ… v0.5.0
๐ŸŽฎ 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 supported game libraries
  2. ๐ŸŽฏ Select Game โ†’ Choose from detected games list
  3. ๐Ÿ“ฆ Download OptiScaler โ†’ Latest official release is used
  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, Epic Games, GOG, Xbox Game Pass, and manual game paths
  • Manages OptiScaler installations 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.5.0 | Status: Release | ๐Ÿš€ Release: v0.5.0

๐Ÿ†• What's New in v0.5.0

๐Ÿ”„ OptiScaler v0.9.2 Compatibility

  • Support for latest OptiScaler v0.9.2 (XeSS 3.0.1 SDK, Depth Aware sharpening, FSR 4.1 + FSR-FG 4.0.0)
  • DlssOverrides removed from payload (removed upstream in v0.9.0)
  • Fixed stale file cleanup to preserve FFX 2.2 SDK DLLs (still shipped in v0.9.x)
  • Range: v0.7.0 โ†’ v0.9.2

๐Ÿš€ Download Options

๐ŸŽฏ For End Users (Recommended)

๐Ÿ“ฅ Download Portable Version v0.5.0

Package Type Size Checksum Notes
๐Ÿ“ฆ Portable ZIP ~14 MB See release page No installation required
๐Ÿ› ๏ธ 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!

๐ŸŽฏ Key Features

  • ๐Ÿ” Automatic Game Detection: Scans supported launchers 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)
  • ๐Ÿงน Update Cleanup: Removes stale legacy OptiScaler files during overwrite installs
  • ๐Ÿ“Š 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

For implementation details, see Technical Overview.

๐ŸŽฎ What is OptiScaler?

OptiScaler is a DirectX proxy DLL that enables:

  • AMD FSR 1.x/2.x/3.x/4.x - FidelityFX Super Resolution and frame generation
  • 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 a stable release (0.4.3) - test thoroughly before using on important games!

๐Ÿ› ๏ธ Option 2: Development Setup

Prerequisites

  • Windows 10/11
  • Python 3.8+ (Download Python)
  • Steam, Epic Games, GOG, or Xbox Game Pass (optional, 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 supported game libraries
  3. Select a game from the detected list
  4. Click Install - GUI downloads the latest official OptiScaler release and installs it
  5. Launch your game and use OptiScaler's in-game overlay for runtime settings

Additional Features:

  • ๐Ÿ“ Manual Path Selection: Browse for games not automatically detected
  • ๐ŸŒ Multi-Language Support: Danish, English, Polish (auto-detection)
  • ๐Ÿ”„ Update Checks: OptiScaler release checking and per-game update flow
  • ๐Ÿ“‹ Progress Tracking: Real-time installation progress with detailed logs

๐Ÿ—๏ธ Architecture Highlights

Robust Multi-Tier Systems

  • Archive Extraction: Bundled/system 7z.exe for .7z โ†’ zipfile for .zip
  • Installation Methods: Direct proxy DLL install with manifest-based uninstall/update tracking
  • Error Handling: Comprehensive error detection and user guidance
  • Compatibility: Portable release bundles required extraction tooling

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

pytest -q                           # Run the test suite
python check_requirements.py         # Validate environment

Building Portable Version

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

๐Ÿ“ฆ Release Information

Current Version: 0.4.3 (Release)

  • Portable Version Available: Self-contained executable with all dependencies
  • Size: ~14 MB portable ZIP (includes Python runtime and bundled 7z.exe)
  • Compatibility: Windows 10/11, no Python installation required

๐Ÿ”„ OptiScaler Version Compatibility

GUI Version Compatible OptiScaler Versions Status
v0.5.0 v0.7.0 - v0.9.2 โœ… Current
v0.4.3 v0.7.0 - v0.9.1 ๐ŸŸก Legacy
v0.4.2 v0.7.0 - v0.9.1 ๐ŸŸก Legacy
v0.3.6 v0.7.0 - v0.7.9 ๐ŸŸก Legacy
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
  • Update Cleanup: Removes stale legacy OptiScaler files on overwrite installs

๐ŸŽฎ 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.9.2. The GUI automatically downloads from the official OptiScaler releases.

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

A: Yes. The GUI can auto-detect several launchers, and you can manually browse and select any game directory.

๐Ÿ›ฃ๏ธ Project Status & Roadmap

Current Status (v0.5.0)

  • โœ… Stable Installation: Reliable OptiScaler installation for most games
  • โœ… Portable Distribution: Self-contained Windows package with bundled 7z.exe
  • โœ… Multi-Launcher Detection: Steam, Epic Games, GOG, Xbox Game Pass, and manual paths
  • โœ… 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)
  • ๐ŸŸก Manual Updates: GUI updates require manual download (no auto-updater)

Planned Features (Future Versions)

  • ๐Ÿ”ฎ 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                                  โ”‚
โ”‚  โ”œโ”€โ”€ Multi-launcher game detection                         โ”‚
โ”‚  โ”œโ”€โ”€ File download/extraction                              โ”‚
โ”‚  โ””โ”€โ”€ Basic configuration setup                             โ”‚
โ”‚                                                             โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

๐Ÿค Community & Support

๐Ÿ“ข Get Help & Report Issues

๐ŸŽฏ Supported Games & Compatibility

  • โœ… Steam Games - Automatic detection
  • โœ… Epic/GOG/Xbox Games - Automatic detection where library metadata is available
  • โœ… Unreal Engine - Enhanced support for UE games
  • โœ… DirectX 11/12 - Full compatibility
  • โš ๏ธ Other launchers/custom installs - Manual path selection may be 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 - Verifies GitHub SHA256 asset digests when available

๐Ÿ“„ 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

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

 
 
 

Contributors