From 5367e64053f37f3ffb034c0aa1dff46438c6c808 Mon Sep 17 00:00:00 2001 From: tiyn Date: Sat, 14 Oct 2023 06:10:19 +0200 Subject: [PATCH] games: added gameyfin and separate games entry --- wiki/docker/grimsi_-_gameyfin.md | 69 +++++++++++++++++++++++ wiki/games.md | 23 ++++++++ wiki/games/bottles.md | 2 +- wiki/games/counter-strike_2.md | 4 +- wiki/games/emulators.md | 2 +- wiki/games/emulators/citra.md | 3 +- wiki/games/emulators/dolphin.md | 3 +- wiki/games/emulators/melonds.md | 3 +- wiki/games/emulators/mgba.md | 7 ++- wiki/games/emulators/nestopia.md | 2 +- wiki/games/emulators/pcsx2.md | 3 +- wiki/games/emulators/ppsspp.md | 3 +- wiki/games/emulators/simple64.md | 3 +- wiki/games/emulators/snes9x.md | 2 +- wiki/games/emulators/yuzu.md | 11 ++-- wiki/games/gameyfin.md | 9 +++ wiki/games/guild_wars_2.md | 2 +- wiki/games/league_of_legends.md | 2 +- wiki/games/lutris.md | 2 +- wiki/games/medieval_2_total_war.md | 2 +- wiki/games/minecraft.md | 8 +-- wiki/games/multimc5.md | 4 +- wiki/games/proton.md | 6 +- wiki/games/sid_meier's_civilization_vi.md | 3 +- wiki/games/steam.md | 2 +- wiki/games/steam_deck.md | 2 +- 26 files changed, 145 insertions(+), 37 deletions(-) create mode 100644 wiki/docker/grimsi_-_gameyfin.md create mode 100644 wiki/games.md create mode 100644 wiki/games/gameyfin.md diff --git a/wiki/docker/grimsi_-_gameyfin.md b/wiki/docker/grimsi_-_gameyfin.md new file mode 100644 index 0000000..d6984d5 --- /dev/null +++ b/wiki/docker/grimsi_-_gameyfin.md @@ -0,0 +1,69 @@ +# grimsi - gameyfin + +This is a [Docker](/wiki/docker.md) container for a [Gameyfin](/wiki/games/gameyfin.md). + +## Set-up + +Create the files `rebuild.sh` and `docker-compose.yml` at the same place. +Change the settings according to your needs and run `./rebuild.sh` afterwards. + +## Environment-variables + +Set the following environment-variables in the `environment:` section of the +docker-compose file. + +| Name | Usage | Default | +| --------------------------------- | --------------------------------------- | ------- | +| `GAMEYFIN_USER` | user name for gameyfin | | +| `GAMEYFIN_PASSWORD` | password for gameyfin | | +| `GAMEYFIN_IGDB_API_CLIENT_ID` | id of twitch internet game database | | +| `GAMEYFIN_IGDB_API_CLIENT_SECRET` | secret of twitch internet game database | | + +## Volumes + +Set the following volumes in the `volumes:` section of the docker-compose file. + +| Outside mount/volume name | Container mount | Description | +| ------------------------- | ----------------------- | ------------------------------ | +| `media_games` | `/opt/gameyfin-library` | storage for games and configs | + +## Ports + +Set the following ports in the `ports:` section. + +| Container Port | Recommended outside port | Protocol | Description | +| -------------- | ------------------------ | -------- | ---------------------- | +| `8080` | `8093` | TCP | WebUI | + + +## rebuild.sh + +```sh +#!/bin/sh +docker-compose down +docker-compose up -d +``` + +## docker-compose.yml + +```yml +version: "3" +services: + gameyfin: + image: grimsi/gameyfin:latest + container_name: gameyfin + environment: + - GAMEYFIN_USER=admin + - GAMEYFIN_PASSWORD=admin + - GAMEYFIN_IGDB_API_CLIENT_ID=id + - GAMEYFIN_IGDB_API_CLIENT_SECRET=secret + volumes: + - media_games:/opt/gameyfin-library + - config:/opt/gameyfin-library/.gameyfin + ports: + - "8093:8080" + +volumes: + media_games: + config: +``` diff --git a/wiki/games.md b/wiki/games.md new file mode 100644 index 0000000..bb8f100 --- /dev/null +++ b/wiki/games.md @@ -0,0 +1,23 @@ +# Games + +A video game - short game - is an electronic game that features interation and input from the user +to generate a feedback. +Games can be played on different platforms. + +## Game Platforms, Distributors and Managers + +There are various platforms for managing games. +[Steam](/wiki/games/steam.md) is a gaming a platform for games that distributes games at the same +time. +Games bought in the Steam shop but also third party games can be added to the game list. +It is very popular and cross platform capable. + +For [Linux-based systems](/wiki/linux.md) the most used platform is a game manager called +[Lutris](/wiki/games/lutris.md). +Lutris can incorporate local games, aswell as games from various big platforms including steam. +It is especially popular on Linux because it can manage [WINE](/wiki/linux/wine.md) prefixes and +thus is able to easily run [Windows](/wiki/windows.md) games on Linux. + +Furthermore [Gameyfin](/wiki/games/gameyfin.md) is a game manager that can be easily accessed +through a web interface. +Games can then be downloaded from the website. diff --git a/wiki/games/bottles.md b/wiki/games/bottles.md index 7d09ea6..dfb879d 100644 --- a/wiki/games/bottles.md +++ b/wiki/games/bottles.md @@ -2,7 +2,7 @@ [Bottles](https://usebottles.com/) is an application similar to [Lutris](/wiki/games/lutris.md) that focusses on running both -[Windows](/wiki/windows.md) applications aswell as games through +[Windows](/wiki/windows.md) applications aswell as [games](/wiki/games.md) through [WINE](/wiki/linux/wine.md) or their own runner [Caffe](#caffe). ## Caffe diff --git a/wiki/games/counter-strike_2.md b/wiki/games/counter-strike_2.md index b421ed1..18465cc 100644 --- a/wiki/games/counter-strike_2.md +++ b/wiki/games/counter-strike_2.md @@ -1,7 +1,7 @@ # Counter-Strike 2 -[Counter-Strike 2](https://www.counter-strike.net/cs2) is a tactical first-person shooter developed -by [Valve](https://www.valvesoftware.com/en/). +[Counter-Strike 2](https://www.counter-strike.net/cs2) is a tactical first-person shooter +[game](/wiki/games.md) developed by [Valve](https://www.valvesoftware.com/en/). It is distributed via [Steam](./steam.md). ## Troubleshooting diff --git a/wiki/games/emulators.md b/wiki/games/emulators.md index ae75477..7bbb835 100644 --- a/wiki/games/emulators.md +++ b/wiki/games/emulators.md @@ -2,7 +2,7 @@ An Emulator is a hard- or software that enables a computer to behave like another computer. -In the gaming context this is mainly used to run games from a console on +In the [gaming](/wiki/games.md) context this is mainly used to run games from a console on another computer. Emulators usually need ROMs to run games. ROMs are a digital copy of a video game. diff --git a/wiki/games/emulators/citra.md b/wiki/games/emulators/citra.md index 7712cf3..bc6feff 100644 --- a/wiki/games/emulators/citra.md +++ b/wiki/games/emulators/citra.md @@ -1,6 +1,7 @@ # Citra -[Citra](https://citra-emu.org/) is a Nintendo 3DS [emulator](/wiki/games/emulators.md). +[Citra](https://citra-emu.org/) is a [Nintendo 3DS](/wiki/games.md) +[emulator](/wiki/games/emulators.md). ## Setup diff --git a/wiki/games/emulators/dolphin.md b/wiki/games/emulators/dolphin.md index b03032e..0ad80cd 100644 --- a/wiki/games/emulators/dolphin.md +++ b/wiki/games/emulators/dolphin.md @@ -1,6 +1,7 @@ # Dolphin -[Dolphin](https://dolphin-emu.org/) is a Nintendo GameCube and Wii [emulator](/wiki/games/emulators.md). +[Dolphin](https://dolphin-emu.org/) is a [Nintendo GameCube and Wii](/wiki/games.md) +[emulator](/wiki/games/emulators.md). ## Setup diff --git a/wiki/games/emulators/melonds.md b/wiki/games/emulators/melonds.md index 882755a..017a9f2 100644 --- a/wiki/games/emulators/melonds.md +++ b/wiki/games/emulators/melonds.md @@ -1,6 +1,7 @@ # melonDS -[melonDS](https://melonds.kuribo64.net/) is a Nintendo DS [emulator](/wiki/games/emulators.md). +[melonDS](https://melonds.kuribo64.net/) is a [Nintendo DS](/wiki/games.md) +[emulator](/wiki/games/emulators.md). ## Setup diff --git a/wiki/games/emulators/mgba.md b/wiki/games/emulators/mgba.md index caa84bd..43c9a10 100644 --- a/wiki/games/emulators/mgba.md +++ b/wiki/games/emulators/mgba.md @@ -1,6 +1,7 @@ # mGBA -[mGBA](https://mgba.io/) is a Nintendo Game Boy, Game Boy Color and Game Boy Advanced +[mGBA](https://mgba.io/) is a +[Nintendo Game Boy, Game Boy Color and Game Boy Advanced](/wiki/games.md) [emulator](/wiki/games/emulators.md). ## Setup @@ -18,7 +19,7 @@ and usage of Dolphin. ### Start Emulated Game in Fullscreen Mode In different scenarios it can be useful to start directly into a game in fullscreen mode. -One example would be using the [Steam Deck](/wiki/games/steam_deck.md) to -[set up a game in the Steam UI](/wiki/games/steam_deck.md#running-a-game-directly-through-the-interface) +One example would be using the [Steam Deck](/wiki/games/steam_deck.md) to +[set up a game in the Steam UI](/wiki/games/steam_deck.md#running-a-game-directly-through-the-interface) so it can be run directly without switching to the desktop mode. For this add the `-f` flag for fullscreen mode. diff --git a/wiki/games/emulators/nestopia.md b/wiki/games/emulators/nestopia.md index 3b93607..4b63173 100644 --- a/wiki/games/emulators/nestopia.md +++ b/wiki/games/emulators/nestopia.md @@ -1,6 +1,6 @@ # Nestopia -[Nestopia](http://0ldsk00l.ca/nestopia/) is a Nintendo Entertainment System +[Nestopia](http://0ldsk00l.ca/nestopia/) is a [Nintendo Entertainment System](/wiki/games.md) [emulator](/wiki/games/emulators.md). ## Setup diff --git a/wiki/games/emulators/pcsx2.md b/wiki/games/emulators/pcsx2.md index 5e29d21..7251863 100644 --- a/wiki/games/emulators/pcsx2.md +++ b/wiki/games/emulators/pcsx2.md @@ -1,6 +1,7 @@ # PCSX2 -[PCSX2](https://pcsx2.net/) is a PlayStation 2 [emulator](/wiki/games/emulators.md). +[PCSX2](https://pcsx2.net/) is a [PlayStation 2](/wiki/games.md) +[emulator](/wiki/games/emulators.md). ## Setup diff --git a/wiki/games/emulators/ppsspp.md b/wiki/games/emulators/ppsspp.md index 2e8b056..96cd425 100644 --- a/wiki/games/emulators/ppsspp.md +++ b/wiki/games/emulators/ppsspp.md @@ -1,6 +1,7 @@ # PPSSPP -[PPSSPP](https://ppsspp.org/) is a PlayStation Portable [emulator](/wiki/games/emulators.md). +[PPSSPP](https://ppsspp.org/) is a [PlayStation Portable](/wiki/games.md) +[emulator](/wiki/games/emulators.md). ## Setup diff --git a/wiki/games/emulators/simple64.md b/wiki/games/emulators/simple64.md index 0d2bb16..786f124 100644 --- a/wiki/games/emulators/simple64.md +++ b/wiki/games/emulators/simple64.md @@ -1,6 +1,7 @@ # simple64 -[simple64](https://simple64.github.io/) is a Nintendo 64 [emulator](/wiki/games/emulators.md). +[simple64](https://simple64.github.io/) is a [Nintendo 64](/wiki/games.md) +[emulator](/wiki/games/emulators.md). ## Setup diff --git a/wiki/games/emulators/snes9x.md b/wiki/games/emulators/snes9x.md index 55d3f5e..3dbbe61 100644 --- a/wiki/games/emulators/snes9x.md +++ b/wiki/games/emulators/snes9x.md @@ -1,6 +1,6 @@ # Snes9x -[Snes9x](http://www.snes9x.com/) is a Super Nintendo Entertainment System +[Snes9x](http://www.snes9x.com/) is a [Super Nintendo Entertainment System](/wiki/games.md) [emulator](/wiki/games/emulators.md). ## Setup diff --git a/wiki/games/emulators/yuzu.md b/wiki/games/emulators/yuzu.md index d81268c..83c8f5a 100644 --- a/wiki/games/emulators/yuzu.md +++ b/wiki/games/emulators/yuzu.md @@ -1,6 +1,7 @@ # yuzu -[yuzu](https://yuzu-emu.org/) is a Nintendo Switch [emulator](/wiki/games/emulators.md). +[yuzu](https://yuzu-emu.org/) is a [Nintendo Switch](/wiki/games.md) +[emulator](/wiki/games/emulators.md). ## Setup @@ -10,7 +11,7 @@ Additionally it can be installed using [Flatpak](/wiki/linux/flatpak.md) where t package is called `org.yuzu_emu.yuzu`. After installation keys need to be added. -A guide on this can be found on the +A guide on this can be found on the [yuzu website](https://yuzu-emu.org/help/quickstart/#setting-up-the-decryption-keys-and-firmware). ## Usage @@ -21,10 +22,10 @@ and usage of Dolphin. ### Start Emulated Game in Fullscreen Mode In different scenarios it can be useful to start directly into a game in fullscreen mode. -One example would be using the [Steam Deck](/wiki/games/steam_deck.md) to -[set up a game in the Steam UI](/wiki/games/steam_deck.md#running-a-game-directly-through-the-interface) +One example would be using the [Steam Deck](/wiki/games/steam_deck.md) to +[set up a game in the Steam UI](/wiki/games/steam_deck.md#running-a-game-directly-through-the-interface) so it can be run directly without switching to the desktop mode. -For this add the `-f` flag for fullscreen mode aswell as the `-g` flag in front of the path to the +For this add the `-f` flag for fullscreen mode aswell as the `-g` flag in front of the path to the game that should to be started. ### Steam Deck Specific Settings diff --git a/wiki/games/gameyfin.md b/wiki/games/gameyfin.md new file mode 100644 index 0000000..ed259de --- /dev/null +++ b/wiki/games/gameyfin.md @@ -0,0 +1,9 @@ +# Gameyfin + +[Gameyfin](https://github.com/grimsi/gameyfin) is a simple [game](/wiki/games.md) library manager +with a web interface to browse and download games. + +## Setup + +The software can be setup via docker with the +[girimsi image](/wiki/docker/grimsi_-_gameyfin.md). diff --git a/wiki/games/guild_wars_2.md b/wiki/games/guild_wars_2.md index 29a4090..cb83f6a 100644 --- a/wiki/games/guild_wars_2.md +++ b/wiki/games/guild_wars_2.md @@ -1,6 +1,6 @@ # Guild Wars 2 -[Guild Wars 2](https://www.guildwars2.com) is a MMORPG which is available as +[Guild Wars 2](https://www.guildwars2.com) is a MMORPG [game](/wiki/games.md) which is available as a standalone Launcher for Windows and on [Steam](./steam.md). ## Add-ons diff --git a/wiki/games/league_of_legends.md b/wiki/games/league_of_legends.md index 7f885d2..b8a16ac 100644 --- a/wiki/games/league_of_legends.md +++ b/wiki/games/league_of_legends.md @@ -1,7 +1,7 @@ # League of Legends [League of Legends](https://www.leagueoflegends.com/en-us) is a multiplayer -online battle arena game which is available as a standalone Launcher for +online battle arena [game](/wiki/games.md) which is available as a standalone Launcher for [Windows](/wiki/windows.md). It is developed and published by [Riot Games](https://www.riotgames.com/en). diff --git a/wiki/games/lutris.md b/wiki/games/lutris.md index 90b7656..b78ca6f 100644 --- a/wiki/games/lutris.md +++ b/wiki/games/lutris.md @@ -1,6 +1,6 @@ # Lutris -[Lutris](https://lutris.net/) is a free and open source video game platform for +[Lutris](https://lutris.net/) is a free and open source video [game](/wiki/games.md) platform for [Linux](/wiki/linux.md) systems. It features compatibility with [GOG](https://www.gog.com/), [Humble Bundle](https://humblebundle.com/), diff --git a/wiki/games/medieval_2_total_war.md b/wiki/games/medieval_2_total_war.md index fed9a9a..16d7717 100644 --- a/wiki/games/medieval_2_total_war.md +++ b/wiki/games/medieval_2_total_war.md @@ -1,6 +1,6 @@ # Medieval 2: Total War -Medieval 2: Total War is a game from the [Total War](https://www.totalwar.com) +Medieval 2: Total War is a [game](/wiki/games.md) from the [Total War](https://www.totalwar.com) series. ## Mods diff --git a/wiki/games/minecraft.md b/wiki/games/minecraft.md index e6a588a..4eae7fc 100644 --- a/wiki/games/minecraft.md +++ b/wiki/games/minecraft.md @@ -1,6 +1,6 @@ # Minecraft -[Minecraft](https://www.minecraft.net) is a sandbox video game created by "Notch". +[Minecraft](https://www.minecraft.net) is a sandbox [video game](/wiki/games.md) created by "Notch". ## Setup @@ -19,7 +19,7 @@ There are different Minecraft Clients available: - [MultiMC5](./multimc5.md) is a custom Minecraft launcher that allows multiple installations at once. -### Usage +### Usage #### Link Minecraft to a Subdomain @@ -41,10 +41,10 @@ target: mine.. #### Adding Death Count to the Scoreboard -Run the following commands inside the console of minecraft to add death count as a objective in the +Run the following commands inside the console of minecraft to add death count as a objective in the scoreboard. -```txt +```txt /scoreboard objectives add Deaths deathCount /scoreboard objectives setdisplay list Deaths ``` diff --git a/wiki/games/multimc5.md b/wiki/games/multimc5.md index d26fb0f..c5de963 100644 --- a/wiki/games/multimc5.md +++ b/wiki/games/multimc5.md @@ -1,7 +1,7 @@ # MultiMC5 -[MultiMC5](https://multimc.org) is a custom launcher that allows multiple -[Minecraft](./minecraft.md) instances installed at once. +[MultiMC5](https://multimc.org) is a custom launcher that allows multiple instances of the +[game](/wiki/games.md) [Minecraft](./minecraft.md) to be installed at once. ## Usage diff --git a/wiki/games/proton.md b/wiki/games/proton.md index 62cc721..4d3bdb2 100644 --- a/wiki/games/proton.md +++ b/wiki/games/proton.md @@ -1,8 +1,9 @@ # Proton [Proton](https://github.com/ValveSoftware/Proton) is a compatibility tool for -[Steam](./steam.md) by its developers, [Valve](https://www.valvesoftware.com), -based on [WINE](../linux/wine.md). +[games](/wiki/games.md) made by the developers of [Steam](./steam.md), +[Valve](https://www.valvesoftware.com). +It is based on [WINE](../linux/wine.md). ## GE-Version @@ -46,4 +47,3 @@ You can remove `/steamapps/compatdata/` to reset the Wine prefix completely. It is recommended to keep a backup of the folder containing the old Wine prefix as it stores game saves and other important data, that can be useful. - diff --git a/wiki/games/sid_meier's_civilization_vi.md b/wiki/games/sid_meier's_civilization_vi.md index 9833215..e51dba5 100644 --- a/wiki/games/sid_meier's_civilization_vi.md +++ b/wiki/games/sid_meier's_civilization_vi.md @@ -1,7 +1,7 @@ # Sid Meier's Civilization VI [Sid Meier's Civilization VI](https://civilization.com/de-DE/) is a round-based -strategy game which is available as a standalone Launcher for Windows and on +strategy [game](/wiki/games.md) which is available as a standalone Launcher for Windows and on [Steam](./steam.md) and many other video game distribution services. ## Troubleshooting @@ -16,4 +16,3 @@ steams game related settings: ```sh eval $( echo "%command%" | sed "s/2KLauncher\/LauncherPatcher.exe'.*/Base\/Binaries\/Win64Steam\/CivilizationVI'/" ) ``` - diff --git a/wiki/games/steam.md b/wiki/games/steam.md index 5b15837..510dcb6 100644 --- a/wiki/games/steam.md +++ b/wiki/games/steam.md @@ -1,6 +1,6 @@ # Steam -[Steam](https://store.steampowered.com/) is a software for digital game +[Steam](https://store.steampowered.com/) is a software for digital [game](/wiki/games.md) destribution. It is developed by [Valve](https://www.valvesoftware.com). Steam uses its compatibility layer, [Proton](./proton.md) for running windows diff --git a/wiki/games/steam_deck.md b/wiki/games/steam_deck.md index 5a8efe7..bac4f0e 100644 --- a/wiki/games/steam_deck.md +++ b/wiki/games/steam_deck.md @@ -1,6 +1,6 @@ # Steam Deck -The [Steam Deck](https://store.steampowered.com/steamdeck) is a handheld gaming +The [Steam Deck](https://store.steampowered.com/steamdeck) is a handheld [gaming](/wiki/games.md) computer made by the same developers as [Steam](./steam.md), [Valve](https://www.valvesoftware.com). Due to its form factor it can be used especially well to play games that need a