gameyfin/README.md

Gameyfin

Manage your video games.

Important

Gameyfin v2 currently in beta stage.
Expect bugs and breaking changes until the 2.0.0 release.

Overview

Name and functionality inspired by Jellyfin.

Features

✨ Automatically scans and indexes your game libraries
⬇️ Access your library via your web browser & download games directly from there
👥 Share your library with friends & family
⚛️ LAN-friendly (everything is cached locally)
🐋 Runs in a container or as single <binary file / JAR file> on bare metal
🌈 Themes (including light and dark mode)
🔌 Easily expandable with plugins
🔒 Integrates into your SSO solution via OAuth2 / OpenID Connect

Documentation

The documentation is available at gameyfin.org.

Contribute to Gameyfin

Currently, no contribution guide is available. After the 2.0.0 release, contributions will be welcome.

Technical Details

Gameyfin v2 is written in Kotlin and uses the following libraries/frameworks:

• Spring Boot 3 for the backend
• Vaadin Hilla & React for the frontend
• PF4J for the plugin system
• H2 database for persistence