diff --git a/README.md b/README.md index e14bf1b..1fe755e 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,42 @@ # gameyfin -A simple game library manager +A simple game library manager. +Name and functionality inspired by [Jellyfin](https://jellyfin.org/). + +## Features + +* Automatically scans your game library folder +* Load additional information about the games from IGDB +* Display your library in a modern web frontend +* Download games directly from your browser +* Search and filter your game library +* Offline-friendly (once the library has been scanned everything is cached locally) +* 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 + +### Differences to other game library software + +In the past I used [Grifter](https://github.com/terrybrash/grifter) to manage my game library, and I was (and still am) happy with it. +However, Grifter has some limitations that I could not work around, so I decided to develop my own app. + +Grifter does not support auto-discovery of games in your library folder. Instead, you have to manually add all files and their corresponding IGDB-slugs to a config file. +Also, Grifter only supports to download one file per game. Since I also have games consisting of multiple files I was not able to download them from the browser with Grifter. +Gameyfin fixes both these limitations: It can scan your library for games and automatically match them on IGDB to load additional information. +It can also deal with games consisting of multiple files by packing them into a .zip folder in realtime if necessary. + +## 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) + diff --git a/assets/fix_game_mapping.png b/assets/fix_game_mapping.png new file mode 100644 index 0000000..58eda1a Binary files /dev/null and b/assets/fix_game_mapping.png differ diff --git a/assets/game_detail_view.png b/assets/game_detail_view.png new file mode 100644 index 0000000..d829c4f Binary files /dev/null and b/assets/game_detail_view.png differ diff --git a/assets/game_mappings.png b/assets/game_mappings.png new file mode 100644 index 0000000..30761b8 Binary files /dev/null and b/assets/game_mappings.png differ diff --git a/assets/library_overview.png b/assets/library_overview.png new file mode 100644 index 0000000..2feab80 Binary files /dev/null and b/assets/library_overview.png differ diff --git a/assets/scan_library.png b/assets/scan_library.png new file mode 100644 index 0000000..e3c8c9e Binary files /dev/null and b/assets/scan_library.png differ