Skip to content

Commit

Permalink
Revamped documentation (#407)
Browse files Browse the repository at this point in the history
  • Loading branch information
@TheEvilSkeleton
TheEvilSkeleton authored Jul 8, 2020
1 parent b0f5e25 commit 510834f
Show file tree
Hide file tree
Showing 2 changed files with 149 additions and 88 deletions.
118 changes: 118 additions & 0 deletions INSTALL.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
# Installation

## Table of contents

* Packages
- [Arch-based distributions](#arch-based-distributions)
- [Debian](#debian)
- [Fedora](#fedora)
- [OpenMandriva](#openmandriva)
- [openSUSE](#opensuse)
- [Pop!\_OS](#pop_os)
- [Ubuntu-based distributions](#ubuntu-based-distributions)
* [AppImage](#appimage)
* [Flatpak](#flatpak)
* [Prebuilt releases](#prebuilt-releases)
* [Source](#source)
- [Dependencies](#dependencies)
- [Building](#building)
- [Installing](#installing)

### Arch-based distributions
[`gamehub-git`](https://aur.archlinux.org/packages/gamehub-git) and [`gamehub`](https://aur.archlinux.org/packages/gamehub) are available in AUR.

### Debian
Prebuilt .deb packages from [releases page](https://github.com/tkashkin/GameHub/releases) were not tested on Debian, but should work.

Alternatively you can build a package from source:
```bash
git clone https://github.com/tkashkin/GameHub.git
cd GameHub
scripts/build.sh build_deb
```

### Fedora
Package is available in Fedora repository:
```bash
sudo dnf install gamehub
```

### OpenMandriva
[`gamehub`](https://abf.openmandriva.org/openmandriva/gamehub/build_lists) is available in the OpenMandriva repository.

### openSUSE
```bash
sudo zypper install gamehub
```

### Pop!\_OS
Package is available in Pop!\_OS repository:
```bash
sudo apt install com.github.tkashkin.gamehub
```

### Ubuntu-based distributions
Install Debian package from the [releases page](https://github.com/tkashkin/GameHub/releases) or import the [PPA](https://launchpad.net/~tkashkin/+archive/ubuntu/gamehub):
```bash
# install if `add-apt-repository` is not available
sudo apt install --no-install-recommends software-properties-common

sudo add-apt-repository ppa:tkashkin/gamehub
sudo apt update
sudo apt install com.github.tkashkin.gamehub
```

## AppImage
AppImages can be found in the [releases page](https://github.com/tkashkin/GameHub/releases).

**WARNING: AppImages are unstable! You might experience issues.**

## Flatpak
Flatpak releases can be found in the [releases page](https://github.com/tkashkin/GameHub/releases).

**WARNING: Flatpak releases are unstable! You might experience issues.**

Then install the package by executing this command:
```bash
flatpak install GameHub-*.flatpak
```

If you want to build it from source instead of installing the binary, execute the commands:
```bash
git clone https://github.com/tkashkin/GameHub.git
cd GameHub
scripts/build.sh build_flatpak
```

## Prebuilt releases
Prebuilt releases can be found in the [releases page](https://github.com/tkashkin/GameHub/releases).

## Source

### Dependencies
* `meson`
* `valac`
* `libgtk-3-dev`
* `libglib2.0-dev`
* `libwebkit2gtk-4.0-dev`
* `libjson-glib-dev`
* `libgee-0.8-dev`
* `libsoup2.4-dev`
* `libsqlite3-dev`
* `libxml2-dev`
* `libpolkit-gobject-1-dev`
* `libunity-dev` (optional, required for launcher icon quicklist, progress indicator and counter; pass `-Duse_libunity=true` to `meson` to use)
* `libmanette-0.2-dev`, `libx11-dev`, `libxtst-dev` (optional, required for gamepad support)

### Building
```bash
git clone https://github.com/tkashkin/GameHub.git
cd GameHub
meson build --prefix=/usr --buildtype=debug
cd build
ninja
```
### Installing
```
sudo ninja install
```
119 changes: 31 additions & 88 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,100 +1,43 @@
# [GameHub](https://tkashkin.tk/projects/gamehub) [![Build status](https://ci.appveyor.com/api/projects/status/cgw5hc4kos4uvmy9/branch/master?svg=true)](https://ci.appveyor.com/project/tkashkin/gamehub/branch/master) [![Translation status](https://hosted.weblate.org/widgets/gamehub/-/translations/svg-badge.svg)](https://hosted.weblate.org/engage/gamehub/?utm_source=widget)
Mirrors: [GitHub](https://github.com/tkashkin/GameHub), [codeberg.org](https://codeberg.org/tkashkin/GameHub), [repo.or.cz](https://repo.or.cz/GameHub.git), [git.froggi.es](https://git.froggi.es/tkashkin/gamehub)

Unified library for all your games.
## Overview
GameHub is a unified library for all your games. It allows you to store your games from different platforms into one program to make it easier for you to manage your games.

### [Features](https://tkashkin.tk/projects/gamehub/#/features)
GameHub allows to view, download, install, run and uninstall games from [supported sources](#game-sources).

### [Games](https://tkashkin.tk/projects/gamehub/#/games)
GameHub supports non-native games as well as native games for Linux.

It supports multiple [compatibility layers](https://github.com/tkashkin/GameHub/wiki/Compatibility-layers) for non-native games:
* Wine / Proton
* DOSBox
* RetroArch
* ScummVM

It also allows to add custom emulators.

GameHub supports [WineWrap](https://www.gog.com/forum/general/adamhms_linux_wine_wrappers_news_faq_discussion/post1) — a set of preconfigured wrappers for [supported games](https://www.gog.com/forum/general/adamhms_linux_wine_wrappers_news_faq_discussion/post3).

### [Game sources](https://tkashkin.tk/projects/gamehub/#/sources)
GameHub supports multiple game sources and services:
* Steam
* GOG
* Humble Bundle
* Humble Trove

Locally installed games can also be added to GameHub.

### [Collection](https://tkashkin.tk/projects/gamehub/#/collection)
GameHub makes storing and managing your DRM-free game collection easier.

Download installers, DLCs and bonus content and GameHub will save your downloads according to settings.
With GameHub, you can:
* store your games in one place
* login to multiple platforms
* install games from the supported sources
* download game installers, DLCs and bonus content
* automatically find artwork for games on [SteamGridDB](https://steamgriddb.com)
* setup emulators and automatically import emulated games

GameHub also has features like:
* [Overlays](https://tkashkin.tk/projects/gamehub/#/overlays) — multiple directories applied on top of each other. Each overlay is stored separately and doesn't affect other overlays. Overlays can be useful to manage DLCs and mods
* [Tweaks](https://github.com/tkashkin/GameHub/wiki/Tweaks) — environment variable and command line overrides that can be applied to games automatically

GameHub supports:
* native games for Linux
* multiple [compatibility layers](https://github.com/tkashkin/GameHub/wiki/Compatibility-layers):
- Wine
- Proton
- DOSBox
- RetroArch
- ScummVM
- [WineWrap](https://www.gog.com/forum/general/adamhms_linux_wine_wrappers_news_faq_discussion/post1) — a set of preconfigured wrappers for [supported games](https://www.gog.com/forum/general/adamhms_linux_wine_wrappers_news_faq_discussion/post3);
- custom emulators
* multiple game platforms:
- Steam
- GOG
- Humble Bundle (including Humble Trove)
- itch.io

## Installation
Prebuilt releases can be found on [releases page](https://github.com/tkashkin/GameHub/releases).

### Ubuntu-based distros
Install debian package from [releases page](https://github.com/tkashkin/GameHub/releases) or use [PPA](https://launchpad.net/~tkashkin/+archive/ubuntu/gamehub):
```bash
# install if `add-apt-repository` is not available
sudo apt install --no-install-recommends software-properties-common

sudo add-apt-repository ppa:tkashkin/gamehub
sudo apt update
sudo apt install com.github.tkashkin.gamehub
```

### Arch Linux
[gamehub-git](https://aur.archlinux.org/packages/gamehub-git/) and [gamehub](https://aur.archlinux.org/packages/gamehub/) are available in AUR.

### Other packages
See [this issue](https://github.com/tkashkin/GameHub/issues/156) for more information.
See [INSTALL.md](INSTALL.md).

## Building

### Debian/Ubuntu-based distros

#### Build dependencies
* `meson`
* `valac`
* `libgtk-3-dev`
* `libglib2.0-dev`
* `libwebkit2gtk-4.0-dev`
* `libjson-glib-dev`
* `libgee-0.8-dev`
* `libsoup2.4-dev`
* `libsqlite3-dev`
* `libxml2-dev`
* `libpolkit-gobject-1-dev`
* `libunity-dev` (optional, required for launcher icon quicklist, progress indicator and counter; pass `-Duse_libunity=true` to `meson` to use)
* `libmanette-0.2-dev`, `libx11-dev`, `libxtst-dev` (optional, required for gamepad support)

#### Building
```bash
git clone https://github.com/tkashkin/GameHub.git
cd GameHub
scripts/build.sh build_deb
```

### Any distro, without package manager
```bash
git clone https://github.com/tkashkin/GameHub.git
cd GameHub
meson build --prefix=/usr --buildtype=debug
cd build
ninja
sudo ninja install
```

### flatpak
```bash
git clone https://github.com/tkashkin/GameHub.git
cd GameHub
scripts/build.sh build_flatpak
```
See [INSTALL.md#Source](INSTALL.md#source).

## [Screenshots](https://tkashkin.tk/projects/gamehub/#/screenshots)
<p align="center"><img src="data/screenshots/light/welcome.png?raw=true" width="49%" /> <img src="data/screenshots/dark/grid.png?raw=true" width="49%" /><img src="data/screenshots/dark/list.png?raw=true" width="49%" /> <img src="data/screenshots/light/grid_controller.png?raw=true" width="49%" /><img src="data/screenshots/light/details.png?raw=true" width="49%" /> <img src="data/screenshots/dark/settings_collection.png?raw=true" width="49%" /><img src="data/screenshots/dark/overlays.png?raw=true" width="49%" /> <img src="data/screenshots/light/install.png?raw=true" width="49%" /><img src="data/screenshots/light/properties.png?raw=true" width="49%" /> <img src="data/screenshots/dark/install_compat.png?raw=true" width="49%" /></p>

0 comments on commit 510834f

Please sign in to comment.