mirror of
https://github.com/BrenBroZAYT/gameyfin.git
synced 2026-06-13 16:40:01 +00:00
45 lines
1.3 KiB
Markdown
45 lines
1.3 KiB
Markdown
<div align="center">
|
|
<img src="assets/v2/Banner.svg" width="auto" alt="Gameyfin Logo">
|
|
<h2>Gameyfin</h2>
|
|
<p align="center">Manage your video games.</p>
|
|
</div>
|
|
|
|
> [!IMPORTANT]
|
|
> Gameyfin v2 is still under heavy development and far from feature complete.
|
|
> You can check the current progress [here](https://github.com/gameyfin/gameyfin/pull/280).
|
|
|
|
## Overview
|
|
|
|
Name and functionality inspired by [Jellyfin](https://jellyfin.org/).
|
|
|
|
### 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
|
|
|
|
### Screenshots
|
|
|
|
`Work in progress`
|
|
|
|
### Installation
|
|
|
|
`Work in progress`
|
|
|
|
### Contribute to Gameyfin
|
|
|
|
`Work in progress`
|
|
|
|
Gameyfin v2 is written in Kotlin and uses the following libraries/frameworks:
|
|
|
|
* Spring Boot 3 for the backend
|
|
* Vaadin for the frontend
|
|
* PF4J for the plugin system
|
|
* H2 database for persistence
|
|
* Micrometer and Prometheus for monitoring
|