# README

**The complete screenshot and Steam marketing asset tool for UE5.**

Capture at any resolution, generate every Steam store asset in one click, record MP4/WebM description videos and GIFs, compose shots with viewport guides, turntable and burst image capture and preview your assets in a live Steam store mockup all inside the editor. Zero runtime impact and zero external dependencies for screenshots and GIFs. FFmpeg (free, auto-downloadable) required for video encoding.

***

## Requirements

|                     |                                                      |
| ------------------- | ---------------------------------------------------- |
| **UE Version**      | 5.5 · 5.6 · 5.7                                      |
| **Render Pipeline** | Built-in RP · Forward Shading · Lumen · Path Tracing |
| **Platform**        | Editor only - Windows, macOS, Linux                  |
| **Dependencies**    | None for screenshots/GIF - FFmpeg for MP4/WebM video |
| **Runtime Impact**  | Zero                                                 |

***

## Installation

1. Copy the `ScreenshotStudio` folder into your project's `Plugins/` directory
2. Right-click your `.uproject` → **Generate Visual Studio Project Files**
3. Build in `Development Editor` configuration
4. Open via **Tools → Screenshot Studio** or `Ctrl+Shift+S`

{% hint style="warning" %}
**Important:** The project path must not contain spaces. UBT's linker response files break with spaces in the path, causing 100+ unresolved symbol errors. Use a path like `C:\UnrealProjects\MyGame\` not `C:\My Projects\My Game\`.
{% endhint %}

The window is dockable, drag the tab anywhere in your editor layout.

***

## Installation Blueprint Project

{% hint style="info" %}
Screenshot Studio is a C++ plugin. Blueprint only projects have no game module for the linker to attach it to, so you need to add one C++ class to your project first, the class doesn't need to do anything, it just generates the necessary build infrastructure.
{% endhint %}

1. Open your Blueprint project in UE5
2. Go to **Tools → New C++ Class**
3. Select **None (Empty Class)** as the parent
4. Name it anything — `MyGameModule` is fine
5. Click **Create Class** - UE will prompt you to restart, accept
6. Visual Studio or your  opens with the generated solution - build it once in `Development Editor`
7. Now follow the standard installation steps above (copy plugin, generate project files, build again)

The C++ class you created can remain completely empty. Its only purpose is to give UE a game module to link the plugin against. You will not need to touch it again.

***

## Feature Overview

### Capture Tab

Seven sub-tabs covering every resolution you need: Standard (720p–8K + Steam Deck), Steam Store, Steam Library, Steam Community, Steam Misc, Social Media, and Custom. All Steam specs follow the August 2024 updated requirements.

<figure><img src="https://244726274-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXrMw6XdS7bBsLCdMdXOz%2Fuploads%2FeSzb1tsJiZLqZktyW6wR%2FScreenshot%202026-04-06%20233356.png?alt=media&#x26;token=b20de645-a1e1-4bd7-ac3f-ab06c8969fb6" alt=""><figcaption></figcaption></figure>

### Resolution Preview Frame

Click the frame toggle next to any preset to overlay the exact capture frame in your active editor viewport blue border, corner ticks, dimmed outer regions, and a label showing resolution and viewport coverage %. Uses `SLevelViewport::AddOverlayWidget`

### Steam Pack

One click captures a 4K master and generates all 14 required Steam assets via center crop + bilinear resize. Saves to `SteamPack/` with Steamworks ready filenames.

<figure><img src="https://244726274-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXrMw6XdS7bBsLCdMdXOz%2Fuploads%2FtsPsfUcWq3tGR1kXOZTh%2FScreenshot%202026-04-06%20233402.png?alt=media&#x26;token=85942275-ba4a-44fb-a795-5c84ba1bb15d" alt=""><figcaption></figcaption></figure>

### Batch Tab

* **Turntable -** orbits the editor camera around the selected actor. Folder never opens between shots.
* **Burst** - N shots at timed intervals
* **Batch Rename** - renames files to Steamworks names by pixel dimensions
* **Batch Rename + Organize**  same, plus sorts into Store / Library / Community / Events subfolders

<figure><img src="https://244726274-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXrMw6XdS7bBsLCdMdXOz%2Fuploads%2FKLPp9VCNX3e2UnQ5EWzi%2FScreenshot%202026-04-06%20233407.png?alt=media&#x26;token=f50c354b-9236-4fb0-8d31-bcbd89966447" alt=""><figcaption></figcaption></figure>

### Video Recorder — MP4 & WebM

Steam added MP4 and WebM support for store description embeds in August 2025. Record PIE footage and encode to MP4 (H.264) and WebM (VP9/VP8). Four resolution presets at 780px and 1170px widths. Select MP4, WebM, or Both from the format selector. Live encoding status in the UI.

**FFmpeg detection order:**

1. `Saved/ScreenshotStudio/FFmpeg/` (auto-downloaded by the plugin)
2. System PATH
3. UE bundled FFmpeg
4. Windows built-in H.264 encoder (Windows only, MP4 only)
5. PNG frame sequence fallback with encode.bat/encode.sh

**Download FFmpeg automatically** from the Video tab - no manual installation needed.

<figure><img src="https://244726274-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXrMw6XdS7bBsLCdMdXOz%2Fuploads%2FX67KhtElCRr3VQxfAVdk%2FScreenshot%202026-04-25%20235345.png?alt=media&#x26;token=e5273f40-8792-4fb0-86e7-16bb66cac0d0" alt=""><figcaption></figcaption></figure>

### GIF Recorder

Records PIE footage and encodes animated GIFs in pure C++ (no external libs). Median-cut quantization, Floyd-Steinberg dithering, LZW compression, background thread encoding.

**Hotkey: `Ctrl+Shift+R`** — toggles recording while in Play mode, fires before game input.

<figure><img src="https://244726274-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXrMw6XdS7bBsLCdMdXOz%2Fuploads%2FCQHZtNupOt4JgopivORJ%2FScreenshot%202026-04-06%20233411.png?alt=media&#x26;token=0a5dcb08-ff6b-483b-b1ee-8103a8201e00" alt=""><figcaption></figcaption></figure>

### Composition Guides

Rule of Thirds, Golden Ratio, Crosshair, Safe Zone overlays drawn directly on the level editor viewport via `SLevelViewport::AddOverlayWidget`. Editor-only, never appear in captures.

<figure><img src="https://244726274-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXrMw6XdS7bBsLCdMdXOz%2Fuploads%2Ft7AYMhSZSOAiJ8IdWqjR%2FScreenshot%202026-04-06%20233415.png?alt=media&#x26;token=f31b50c1-ff9e-4a63-a644-28e3a3d2afd0" alt=""><figcaption></figcaption></figure>

### Steam Store Preview

Procedural Slate mockup of the Steam store (Store Page, Front Page, Library views) populated with your actual captured images. Correct Steam color palette (#1b2838, #171a21, etc.). Images maintain aspect ratio when the window is resized.

<figure><img src="https://244726274-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXrMw6XdS7bBsLCdMdXOz%2Fuploads%2FsRRaB1BqoQvy5XswLpG7%2FScreenshot%202026-04-06%20235401.png?alt=media&#x26;token=ad8effed-7928-4a7d-8052-3d2c79ca5bf7" alt=""><figcaption></figcaption></figure>

### File List

Session capture history with filename, dimensions, file size, and Open button.

<figure><img src="https://244726274-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXrMw6XdS7bBsLCdMdXOz%2Fuploads%2FM3PUYRiAiSnegS2VhAdZ%2FScreenshot%202026-04-06%20233435.png?alt=media&#x26;token=a2fcc03e-57da-4624-8294-6310cdaae376" alt=""><figcaption></figcaption></figure>

### Settings

Output folder, format (PNG/JPG/EXR), JPG quality, watermark/logo overlay (position, scale, opacity).

<figure><img src="https://244726274-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXrMw6XdS7bBsLCdMdXOz%2Fuploads%2FrNoR5cch52sFUXuKO0GS%2FScreenshot%202026-04-06%20233500.png?alt=media&#x26;token=0b21e3dc-9b72-413a-9bae-de8f211a4c15" alt=""><figcaption></figcaption></figure>

***

## Keyboard Shortcuts

| Shortcut       | Action                                                            |
| -------------- | ----------------------------------------------------------------- |
| `Ctrl+Shift+S` | Open Screenshot Studio window                                     |
| `Ctrl+Shift+R` | Toggle GIF or Video recording (PIE only, fires before game input) |

***

## Documentation

See the **MANUAL.md** for the full user manual including all the settings, Steam asset size reference, and troubleshooting.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://ecbstudios.gitbook.io/screenshot-studio/documentation/readme.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.