Brendon/gameyfin
1
0
Fork 0
mirror of https://github.com/BrenBroZAYT/gameyfin.git synced 2026-06-16 16:20:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Simon
2022-10-21 22:04:10 +02:00
committed by GitHub
parent 755611689e
commit 9485ec0e25
1 changed files with 8 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+8 -26
View File
@@ -4,8 +4,6 @@
<p align="center">A simple game library manager.</p> <p align="center">A simple game library manager.</p>
</div> </div>
<img />
# Overview # Overview
Name and functionality inspired by [Jellyfin](https://jellyfin.org/). Name and functionality inspired by [Jellyfin](https://jellyfin.org/).
@@ -16,15 +14,17 @@ Click [this link](https://youtu.be/BSaccEm0tpo) to watch how to install and set
## Features ## Features
* Automatically scans your game library folder * Automatically scans your game library folder and downloads additional metadata from IGDB
* Load additional information about the games from IGDB * Access your library via your Web-Browser
* Display your library in a modern web frontend
* Download games directly from your browser * Download games directly from your browser
* Search and filter your game library * LAN-friendly (everything is cached locally)
* Offline-friendly (once the library has been scanned everything is cached locally) * Native Docker support (alternatively it's only one .jar file to run on bare metal)
* Easy to host yourself thanks to native Docker support (alternatively it's only one .jar file to run on bare metal)
* Light and dark theme * Light and dark theme
## Preview
https://user-images.githubusercontent.com/9295182/197277953-d69464a4-d280-407b-9274-ae62e6917981.mp4
## Installation ## Installation
### General ### General
@@ -44,21 +44,3 @@ Since Gameyfin loads information from IGDB, you need to register yourself there.
3. Edit the config options in the `gameyfin.properties` file 3. Edit the config options in the `gameyfin.properties` file
4. Use the following command to start Gameyfin: `java -jar gameyfin.jar` 4. Use the following command to start Gameyfin: `java -jar gameyfin.jar`
5. Open the address of your Gameyfin host in your browser, Gameyfin runs under port 8080 by default 5. Open the address of your Gameyfin host in your browser, Gameyfin runs under port 8080 by default
## Screenshots
### Game library screen in light mode (top) and dark mode (bottom)
![Game library](assets/library_overview.png)
### Game detail view
![Game detail screen](assets/game_detail_view.png)
### Automatic library scanning
![Library scan hint](assets/scan_library.png)
### Admin interface
![Admin interface](assets/game_mappings.png)
### Manually fix incorrect mappings (with autocomplete suggestions)
![Fix mapping dialog](assets/fix_game_mapping.png)