Update README with installation instructions

This commit is contained in:
grimsi
2022-08-06 18:33:41 +02:00
parent e1a8fefa2a
commit 0939117dc5
+22 -1
View File
@@ -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 <name of the downloaded jar file>.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)