Skip to content

Rumik/SteamGridDB-Overlay-Automator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 

Repository files navigation

SteamGridDB Overlay Automator 🎮

Version Python

A powerful, automated tool for asset creators and gamers to batch-apply branding overlays (e.g., "Xbox Cloud Gaming", "GeForce Now", "PlayStation Plus") to Steam artwork and upload them directly to SteamGridDB.

✨ Key Features

  • 🚀 Batch Upload: Select multiple profiles (e.g., Xbox, Luna, Switch) and upload them all to SteamGridDB in one click.
  • 🔍 Deep Search Engine:
    • Level 1: Scrapes official Steam Store API for high-res assets.
    • Level 2: Queries SteamGridDB's internal API for hidden "Original Steam Assets" (hashed URLs).
    • Level 3: Searches for top-rated user-created "Official" style grids.
    • Level 4: Auto-generates a blurred background placeholder if no art is found, ensuring you are never blocked.
  • 🎨 Live Adjustments: Interactive preview with sliders to vertically shift artwork, preventing overlays from covering important logos or faces.
  • ⚡ Smart Caching: Caches AppIDs and GameIDs to speed up batch operations.
  • 🛡️ Validation: Automatically validates image dimensions and aspect ratios before uploading.

🚀 How to Use

  1. Search: Type a game name (e.g., "Resident Evil Requiem") into the search bar and press Enter.
  2. Select Art: The tool will automatically fetch the best official artwork.
    • Note: If the auto-fetched art looks wrong or is missing, you can manually import your own files using the blue "Import Custom Art" button.
  3. Adjust: Click on a profile name in the sidebar (e.g., "Xbox") to preview it. Use the Vertical Position sliders to move the game art up or down so it fits perfectly under the overlay.
  4. Upload:
    • Upload CURRENT: Uploads only the currently selected profile to SteamGridDB.
    • Batch Upload: Uploads ALL profiles that have their checkbox ticked in the sidebar list.
image

📦 Installation

Option 1: Download the App (Windows)

  1. Go to the Releases page.
  2. Download the latest .zip file.
  3. Extract the folder.
  4. Run SGDB_Overlay_Tool.exe.

Option 2: Run from Source (Python)

  1. Clone this repository.
  2. Install requirements:
    pip install -r requirements.txt
  3. Run the script:
    python main.py

🛠️ Setup & Configuration

1. Get your API Key

You need a SteamGridDB API Key to upload images.

  1. Log in to SteamGridDB.
  2. Go to User Settings > Preferences > API.
  3. Create an API Key.
  4. Open the tool, click ⚙ API Settings, and paste your key.

2. Create your Overlays

The tool looks for specific image files in the overlays folder.

  1. Click + Add Profile in the tool.
  2. Name your profile (e.g., "Xbox Cloud").
  3. Select your Vertical Overlay (600x900 PNG with transparency).
  4. Select your Horizontal Overlay (920x430 PNG with transparency).

Manual Folder Structure: If you prefer to organize files manually, your folder should look like this:

/overlays
    /Xbox Cloud Gaming
        horizontal.png  (920x430)
        vertical.png    (600x900)
    /PlayStation Plus
        horizontal.png
        vertical.png

About

A powerful, automated tool for asset creators and gamers to batch-apply branding overlays (e.g., "Xbox Cloud Gaming", "GeForce Now", "PlayStation Plus") to Steam artwork and upload them directly to SteamGridDB.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors