mirror of
https://github.com/BrenBroZAYT/gameyfin.git
synced 2026-06-14 16:20:04 +00:00
grimsi
42 lines
1.3 KiB
Markdown
42 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 currently in beta stage.
|
|
> Expect bugs and breaking changes until the `2.0.0` release.
|
|
|
|
## 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
|
|
|
|
### Documentation
|
|
|
|
The documentation is available at [gameyfin.org](https://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
|