Installing

The recommended path is the Framegain Installer. It finds installed Unreal Engine versions and installs the matching plugin.

#Framegain Installer

Download the installer from the Framegain download page. The current installer targets Windows 10 and 11.

The installer is unsigned and may trigger an “unknown publisher” warning the first time it runs.

#Manual ZIP installation

Use the engine-specific ZIP when you prefer to install by hand:

1. Close the Unreal Editor.
2. Unzip the folder into YourProject/Plugins/Framegain/. Create the Plugins folder if it is not there.
3. Open the project. Framegain appears under the editor’s Window menu.
4. Pick a target preset, then press Scan project.

#Engine versions

The release page currently provides builds for Unreal Engine 5.7 and 5.8. Earlier engine versions are not supported by the documented release.

#Adding a docs video

Put recordings inside public/media/docs/. The exact Markdown block is:

:::video
title: INSTALLING FRAMEGAIN
description: A short description shown below the recording.
dimensions: 1920×1080
duration: 60-90 S
src: /media/docs/installing-framegain.mp4
poster: /media/docs/installing-framegain-poster.jpg
:::

src is optional while a recording is planned. The build supports local .mp4 and .webm files; it renders native browser controls only when the referenced file exists. If src is missing or the file is not present, the page renders a labeled Framegain placeholder with the description, dimensions, and duration. No broken player is shown.