Skip to content

Latest commit

 

History

History
269 lines (187 loc) · 9.02 KB

File metadata and controls

269 lines (187 loc) · 9.02 KB

LetMeReShade 🎮

A community-maintained fork of LetMeReShade by itsOwen.

All credit goes to the original author for his incredible work.
The goal of this fork is to keep the project alive — updating it to support future versions of ReShade, as well as adding quality-of-life improvements and fixes — since itsOwen has mentioned that he won’t have time to maintain the original project anymore.

Initially based on LetMeReShade v1.8, this fork uses semantic versioning via release-please, continuing from v1.8.0 as its baseline.

Contributions and feedback are very welcome!

Decky Plugin License GitHub Release Steam Deck Compatibility Downloads Updates

🚀 Ultimate Steam Deck Graphics Enhancement Suite - Advanced shader customization with ReShade for next-level visual fidelity

LetMeReShade Banner

✨ Features

🛠️ Core Functionality

  • ReShade - Industry-standard post-processing for DirectX/OpenGL games
  • ⚡ One-click installation and management
  • 🎯 Automatic game detection and configuration
  • 🔧 Manual DLL patching capabilities
  • 🌐 Global preset management with custom shader support
  • 🎮 In-game overlay accessible via HOME key
  • ⚙️ Steam Deck-optimized configurations
  • 🖥️ Supports AUTO HDR for OLED Screens
  • 🎪 Full support for Heroic Games (Epic Games, GOG, Amazon Games)

📋 Prerequisites

Requirement Description
🔌 Decky Loader Must be installed on your Steam Deck
🌐 Internet Connection Required for initial setup and shader downloads
💾 Storage Space 500MB+ recommended for shader libraries
🖥️ Compatible OS SteamOS or compatible variants (Bazzite/ChimeraOS)

🚀 Installation

📦 ReShade Installation

  1. 📥 Download Latest Release

    # Navigate to releases and download the latest version
  2. 📁 Extract and Install

    # Extract files to: homebrew/plugins/<LetMeReShade-folder>
  3. 🔄 System Restart

    # Restart Steam Deck to complete installation

⚠️ Important Note: ReShade conflicts with FGMOD due to shared DLL files. Uninstall or unpatch one before enabling the other.

🎮 Usage

🏁 Initial Setup

  1. 🔍 Access Plugin Interface

    • Open Quick Access Menu → Navigate to LetMeReShade
  2. 🎛️ In-Game Access

    • Launch game → Press HOME key for overlay

    💡 Tip: On compact or laptop keyboards, the Home key is often Fn + Left Arrow. If your keyboard lacks a Home key entirely, you can change the overlay key in ReShade.ini under [INPUT]KeyOverlay (see Virtual Key Codes).

🎨 Shader Management

Action Method
Enable Effects Plugin interface toggle
Adjust Settings In-game overlay (HOME key)
Load Presets Global preset manager
Custom Shaders Drop files in designated folders

🔧 Manual Patching

📖 Stardew Valley Example

💡 Use Case: When automatic patching doesn't work out of the box

Step-by-Step Process:

  1. 🔌 Plugin Installation

    # Install latest LetMeReShade version
  2. 🗑️ Clean Installation

    # Uninstall Stardew Valley completely
  3. ⚙️ Compatibility Configuration

    Game Properties → Compatibility → Force Compatibility → Proton Experimental
    
  4. 📥 Windows Version Install

    # Reinstall game (Windows version will download)
  5. 🎨 Manual Patch Application

    LetMeReShade → Manual Patching → Select Game → Select DLL (OpenGL) → Apply Patch
    
  6. 🎪 Additional Enhancements

    # Download Fadedew preset → Place in Stardew Valley folder

🔧 Troubleshooting

📚 Comprehensive Guide: LetMeReShade Complete Wiki Guide

🚨 Common Issues & Solutions

Issue Solution
🚫 Overlay Not Appearing • Verify DLL override selection
• Check Vulkan launch settings
• Confirm HOME key mapping
• Validate engine compatibility
💥 Game Crashes on Launch • Try alternative DLL override
• Check shader compatibility
• Verify game support
🐌 Performance Issues • Disable intensive shaders
• Update plugin version
• Verify shader repositories

🔍 Advanced Troubleshooting

# Check log files
~/.local/share/Steam/logs/

# Verify installation
homebrew/plugins/LetMeReShade/

# Reset configuration
rm ~/.config/vkBasalt/vkBasalt.conf

📺 Video Guide

New video Guide

📹 New Guide Setup Tutorial

Old guide (still relevant)

📹 Complete Setup Tutorial

Click to watch the comprehensive setup and usage tutorial

🤝 Contributing

We welcome community contributions! Here's how you can help:

🐛 Bug Reports

  • Use GitHub Issues with detailed reproduction steps
  • Include system specifications and error logs

💡 Feature Requests

  • Propose new functionality via GitHub Discussions
  • Provide use cases and implementation suggestions

🔧 Pull Requests

  • Fork the repository and create feature branches
  • Follow existing code style and documentation standards

🎨 Shader Presets

  • Share custom presets with the community
  • Include screenshots and compatibility notes

🛠️ Development

📦 Creating a Dev Build

For developers who want to test local changes easily, follow these steps:

  1. 🔨 Build the Plugin

    pnpm run dev-build
  2. 📁 Locate the Build

    The script creates a versioned zip file in the builds/ directory:

    builds/LetMeReShade_v1.8.0-dev.1.zip
    

    The dev counter automatically increments if a build with the same version already exists.

  3. 📲 Install on Steam Deck

    • Extract the zip file contents
    • Copy the LetMeReShade folder to: ~/homebrew/plugins/
    • Enable Developer Mode in Decky Loader settings
    • Install the plugin from the zip file

🔄 Automatic Updates

The plugin provides seamless updates for:

Component Update Method
🎨 ReShade Automatic version checking
📚 Shader Repositories Background synchronization
🔌 Plugin Core Integrated update system

⚖️ License

This project is licensed under the BSD-3-Clause License.

Copyright (c) 2024 LetMeReShade Contributors
All rights reserved.

See the LICENSE file for complete terms and conditions.

🙏 Acknowledgments

👨‍💻 Core Contributors

  • ZigmA - Project inspiration and extensive testing support
  • xXJSONDeruloXx - Foundation framework from Decky Framegen plugin
  • kevinlekiller - reshade-steam-proton repository integration
  • DadSchoorse - VkBasalt repository and Vulkan expertise
  • Gizzburt - Special thanks to my buddy Gizz for helping me add AutoHDR support and also for his Detailed Guide

🌟 Community Support

Special thanks to the Steam Deck homebrew community for continuous feedback and testing.

📞 Support & Help

🆘 Getting Help

  1. 📖 Documentation First

    • Review this README thoroughly
    • Check the Wiki Guide
  2. 🔍 Search Existing Issues

  3. 🆕 Report New Issues

    • Provide detailed system information
    • Include reproduction steps
    • Attach relevant log files

📱 Community Channels

  • GitHub Discussions - Feature requests and general discussion
  • GitHub Issues - Bug reports and technical support

🎮 Made with ❤️ for the Steam Deck Community 🎮

Enhancing your gaming experience, one shader at a time