Gameyfin - Installation & Setup

Summary

This video guides viewers on how to easily install and set up Gamifin, a simple game management tool similar to Plex or Jellyfin but for video games. It covers installation on bare metal and via Docker, along with configuring the game library, integrating with the IGDB API, and managing game metadata. The tutorial also includes steps for scanning the library, correcting mismatches, and downloading game assets. The video concludes with a demonstration of using Docker for setup and advice on choosing between bare metal or Docker for deployment.

Takeaways

• 😀 GamingFin is a game library manager that functions similarly to Plex or Jellyfin but specifically for video games.
• 😀 The application provides a user-friendly web interface to browse, download, and manage your games with metadata from IGDB (International Game Database).
• 😀 To set up GamingFin, you need to download the latest `.jar` file and the configuration `.properties` file from the official repository.
• 😀 The `.properties` file allows you to configure the server port, username, password, and the library paths for your games. It also requires authentication with Twitch's API.
• 😀 You must create a Twitch Developer Application to get a *Client ID* and *Client Secret* for IGDB authentication.
• 😀 If using Windows, ensure you use double backslashes for file paths in the `.properties` configuration to avoid errors.
• 😀 Once configured, run the GamingFin `.jar` file with the command `java -jar GamingFin-<version>.jar` to start the application.
• 😀 After starting GamingFin, you can access the web interface via `localhost:8080` and begin scanning your game library for metadata and images.
• 😀 GamingFin downloads and caches game metadata locally, allowing offline access to images and descriptions. Game videos require an internet connection.
• 😀 With the web interface, you can manage your game library, confirm or correct game matches, and add or remove games easily.
• 😀 For Docker users, you can use the provided `docker-compose.yml` file to deploy GamingFin in a containerized environment, making setup easier and more portable.

Q & A

What is Gamifin and how does it differ from Plex or Jellyfin?

Gamifin is a simple game manager that functions like Plex or Jellyfin, but specifically for video games. It provides a web UI for browsing and managing games, scanning your library for metadata, and downloading games directly. Unlike Plex or Jellyfin, which focus on media content, Gamifin is tailored for organizing and managing video games with features like metadata retrieval from IGDB.

What are the key features of Gamifin?

Gamifin allows users to browse and manage their game libraries, scan folders for games, match game titles with metadata from IGDB, download game covers and metadata, and play games offline. It also supports user authentication for administration, offers game management features, and allows filtering and sorting by different criteria.

How do you install Gamifin on bare metal?

To install Gamifin on bare metal, download the latest `.jar` file and `properties` configuration file from the Gamifin GitHub repository. Copy them to your desired location, configure the `properties` file with the server port, username, password, and game library path, and then run the application using the command `java -jar gamifin-x.x.x.jar`.

What is the purpose of the properties file in Gamifin?

The properties file in Gamifin is used to configure important settings like the server port, username, password for admin access, library paths where games are stored, and database/cache locations. It also includes fields for IGDB API authentication credentials (Client ID and Secret) required to fetch metadata.

How do you authenticate Gamifin with IGDB?

To authenticate Gamifin with IGDB, you need to create a Twitch Developer account, register a new application, and obtain a Client ID and Client Secret. These credentials are then added to the `properties` file to enable communication with the IGDB API for game metadata retrieval.

How can you resolve mismatched or unrecognized games in the library?

If Gamifin fails to match a game correctly, you can manually confirm or edit the match using the 'Confirm Matches' feature in the Library Management section. If necessary, you can select the correct game from the auto-complete suggestions to fix incorrect metadata mappings.

What does the 'Scan Library' feature do in Gamifin?

The 'Scan Library' feature in Gamifin scans the specified folders for game files, matches them with entries in IGDB, and downloads corresponding metadata, game covers, and screenshots. It helps keep your game library up-to-date and organized.

How do you download games using Gamifin?

To download a game in Gamifin, navigate to the game's page in the library, click the 'Download' button, and the game will be downloaded as a ZIP file. This file contains the setup file, which you can run on your machine to install the game.

How do you set up Gamifin using Docker?

To set up Gamifin using Docker, download the `docker-compose.yml` example file from the Gamifin repository, modify it with your configuration settings (such as username, password, and library paths), and then run `docker-compose up -d` in the terminal. This will pull the latest Gamifin image, create a container, and start the application in Docker.

What are the advantages of using Docker to run Gamifin?

Running Gamifin in Docker offers the advantage of simplified deployment, as Docker handles dependencies and environment setup. It's a clean, isolated environment, making it easier to manage and update. Docker also allows for easier scalability and portability, especially when running Gamifin on multiple machines or environments.