From 0939117dc57fcfef40f959aeb9619f62912fcfbb Mon Sep 17 00:00:00 2001 From: grimsi <9295182+grimsi@users.noreply.github.com> Date: Sat, 6 Aug 2022 18:33:41 +0200 Subject: [PATCH] Update README with installation instructions --- README.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1fe755e..ea58366 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# gameyfin +# Gameyfin A simple game library manager. Name and functionality inspired by [Jellyfin](https://jellyfin.org/). @@ -23,6 +23,27 @@ Also, Grifter only supports to download one file per game. Since I also have gam 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. +## Installation + +### General + +Since Gameyfin loads information from IGDB, you need to register yourself there. Follow [this guide](https://api-docs.igdb.com/#account-creation). + +### Docker + +1. Download the `docker-compose.example.yml` file from this repository and rename it to just `docker-compose.yml` +2. Edit the configuration values to your liking +3. Run `docker-compose up -d` + +### Bare metal + +1. Make sure you have a JRE or JDK with version 18 or greater installed +2. Download the latest .jar and `gameyfin.properties` file from the releases page +3. Edit the config options in the `gameyfin.properties` file +4. Use the following command to start Gameyfin: `java "-Dspring.config.name=application,database,gameyfin,secure" -jar .jar` + (note the quotation marks around the first argument) +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)