Skip to content
/ earplug Public

Free and open source website for your local game library

License

Notifications You must be signed in to change notification settings

delath/earplug

Repository files navigation

Earplug

Overview

This is a game library website that takes as input a json containing games titles and displays a library of those games using the igdb API.

Preview

Preview 1

Preview 2

Installation

git clone https://github.com/delath/earplug.git
npm install

Set up environment variables in .env

IGDB_CLIENT_ID=<YOUR_IGDB_CLIENT_ID>
IGDB_CLIENT_SECRET=<YOUR_IGDB_CLIENT_SECRET>

Create a games.json in the root of the repository, containing all the titles of the games to display, as an example:

[
    "AI The Somnium Files",
    "Alan Wake II",
    "Among Us",
    "Animal Well"
]

Start the website in dev mode

npm run dev

The first time only, it might take some time to fetch all the data and write it on the games_metadata.json, a file you can manually edit should you want to manage the games on your main page.

Acknowledgments

Almost all of this project has been based on the work of mvximenko, you could say this is a fork of gg with a different goal.