Skip to content

Getting started ​

Install ​

Download a build from the releases page.

SystemFileNotes
Windows.exeNot code signed, so SmartScreen warns on first run. Choose More info, then Run anyway.
Debian, Ubuntu.debNeeds Ubuntu 24.04 or Debian 13 or newer. Gameyfin tells you when a new version is out; install it the same way.
Fedora, openSUSE.rpmNeeds Fedora 40, openSUSE Leap 16 or Tumbleweed, or newer. Updates work as with .deb.
Any Linux.flatpakWorks on older distributions too, since it brings its own libraries.

The .deb and .rpm need glibc 2.39 or newer and WebKitGTK 4.1. On anything older, use the Flatpak.

Flatpak: updates ​

You can also install from the repository instead of a file:

bash
flatpak remote-add --user --if-not-exists gameyfin-app https://wieluk.github.io/gameyfin-app/repo/gameyfin-app.flatpakrepo
flatpak install --user gameyfin-app org.gameyfin.gameyfin-app

Flatpak: 32-bit support ​

Installers and older games are 32-bit, and the Flatpak needs Flathub's 32-bit libraries to run them with Proton. Without them those run on Gameyfin's own Wine instead. Settings, Compatibility offers Install 32-bit support; restart Gameyfin afterwards.

First start ​

  1. Connect: enter your Gameyfin server's address.
  2. Sign in: the server's own login page opens, so SSO works too. If the login window misbehaves, use the link under it to clear its saved data.
  3. Choose where games go and name this PC. The name appears beside every save this PC uploads.

On Linux, what Windows games need downloads on a game's first launch. See Playing games.

Behind a proxy with its own login ​

A proxy that asks to sign in before Gameyfin, such as Pangolin or Authelia, is signed in through the same window, and its cookie is kept alongside your Gameyfin login. Its session expires on its own schedule, and Gameyfin then asks you to sign in again.

To be asked less often, raise the proxy's session lifetime, or let /connect/**, /download/**, /images/** and /saves/** through without it. Gameyfin's own login still guards them. A proxy that authenticates by Authorization header, such as HTTP Basic, cannot be used: staying signed in needs that header.

Your games folder ​

Everything lives in a Gameyfin folder inside the games folder you chose:

FolderHolds
DownloadsDownloaded archives and unpacked files waiting to install
InstallationsInstalled games, named (id) Title
PrefixesOne Windows environment per Windows game (Linux only)
SavesLocal copies of save backups before they are uploaded

Because the game id is in the folder name, Gameyfin can find your games again after a reinstall. Use Rescan folders in Installed or Downloads.

You can add more games folders, for example on a second drive, in Settings, Library.