https://github.com/gameyfin/gameyfin

Manage your video games.
https://github.com/gameyfin/gameyfin

hacktoberfest

Last synced: 10 days ago
JSON representation

Manage your video games.

• Host: GitHub
• URL: https://github.com/gameyfin/gameyfin
• Owner: gameyfin
• License: agpl-3.0
• Created: 2022-07-04T17:24:11.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-29T12:22:43.000Z (15 days ago)
• Last Synced: 2024-10-29T12:46:27.996Z (15 days ago)
• Topics: hacktoberfest
• Language: Java
• Homepage:
• Size: 13.6 MB
• Stars: 397
• Watchers: 6
• Forks: 19
• Open Issues: 33
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        


  

  
Gameyfin

  
A simple game library manager.



# Overview

Name and functionality inspired by [Jellyfin](https://jellyfin.org/).

## Video

Click [this link](https://youtu.be/BSaccEm0tpo) to watch how to install and set up Gameyfin on your machine.

## Features

* Automatically scans your game library folder and downloads additional metadata from IGDB

* Access your library via your Web-Browser

* Download games directly from your browser

* LAN-friendly (everything is cached locally)

* Native Docker support (alternatively it's only one .jar file to run on bare metal)

* Light and dark theme

## Preview

https://user-images.githubusercontent.com/9295182/197277953-d69464a4-d280-407b-9274-ae62e6917981.mp4

## 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 `gameyfin.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 -jar gameyfin.jar`

5. Open the address of your Gameyfin host in your browser, Gameyfin runs under port 8080 by default