mirror of
https://github.com/BrenBroZAYT/gameyfin.git
synced 2026-06-13 16:40:01 +00:00
grimsi
49 lines
1.7 KiB
Markdown
49 lines
1.7 KiB
Markdown
<div align="center">
|
|
<a href="https://gameyfin.org">
|
|
<img src="assets/v2/Banner.svg" width="auto" alt="Gameyfin Logo">
|
|
</a>
|
|
<h2>Gameyfin</h2>
|
|
<h4>Manage your video games.</h4>
|
|
<p>simple / fast / <a href="https://github.com/gameyfin/gameyfin/blob/main/LICENSE.md">FOSS</a></p>
|
|
</div>
|
|
|
|
> [!IMPORTANT]
|
|
> Gameyfins container image will move soon™.
|
|
> The new image is available under `ghcr.io/gameyfin/gameyfin`.
|
|
> The old image (`grimsi/gameyfin`) will be removed in the future, so please update your setup accordingly.
|
|
|
|
## Overview
|
|
|
|
Name and functionality inspired by [Jellyfin](https://jellyfin.org/).
|
|
|
|
### Documentation
|
|
|
|
The documentation and screenshots are available at [gameyfin.org](https://gameyfin.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 - except for videos)
|
|
🐋 Runs in a container or any system with a JVM
|
|
🌈 Themes (including colorblind support)
|
|
🔌 Easily expandable with plugins
|
|
🔒 Integrates into your SSO solution via OAuth2 / OpenID Connect
|
|
🆓 **100% open source and free to use without any paywall.**
|
|
|
|
### Contribute to Gameyfin
|
|
|
|
Contributions are welcome!
|
|
There are no strict requirements to contribute, but please contact us first if you want to implement a new feature or
|
|
change the design of the application before you start working on it.
|
|
|
|
### 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
|