Bump version to 0.15.0
[GameHub.git] / README.md
blobdcbf9a6a7572ac8a849df7e51896b6a7eff1e72c
1 # [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)
2 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)
4 Unified library for all your games.
6 ### [Features](https://tkashkin.tk/projects/gamehub/#/features)
7 GameHub allows to view, download, install, run and uninstall games from [supported sources](#game-sources).
9 ### [Games](https://tkashkin.tk/projects/gamehub/#/games)
10 GameHub supports non-native games as well as native games for Linux.
12 It supports multiple [compatibility layers](https://github.com/tkashkin/GameHub/wiki/Compatibility-layers) for non-native games:
13 * Wine / Proton
14 * DOSBox
15 * RetroArch
16 * ScummVM
18 It also allows to add custom emulators.
20 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).
22 ### [Game sources](https://tkashkin.tk/projects/gamehub/#/sources)
23 GameHub supports multiple game sources and services:
24 * Steam
25 * GOG
26 * Humble Bundle
27 * Humble Trove
29 Locally installed games can also be added to GameHub.
31 ### [Collection](https://tkashkin.tk/projects/gamehub/#/collection)
32 GameHub makes storing and managing your DRM-free game collection easier.
34 Download installers, DLCs and bonus content and GameHub will save your downloads according to settings.
36 ## Installation
37 Prebuilt releases can be found on [releases page](https://github.com/tkashkin/GameHub/releases).
39 ### Ubuntu-based distros
40 Install debian package from [releases page](https://github.com/tkashkin/GameHub/releases) or use [PPA](https://launchpad.net/~tkashkin/+archive/ubuntu/gamehub):
41 ```bash
42 # install if `add-apt-repository` is not available
43 sudo apt install --no-install-recommends software-properties-common
45 sudo add-apt-repository ppa:tkashkin/gamehub
46 sudo apt update
47 sudo apt install com.github.tkashkin.gamehub
48 ```
50 ### Arch Linux
51 [gamehub-git](https://aur.archlinux.org/packages/gamehub-git/) and [gamehub](https://aur.archlinux.org/packages/gamehub/) are available in AUR.
53 ### Other packages
54 See [this issue](https://github.com/tkashkin/GameHub/issues/156) for more information.
56 ## Building
58 ### Debian/Ubuntu-based distros
60 #### Build dependencies
61 * `meson`
62 * `valac`
63 * `libgtk-3-dev`
64 * `libglib2.0-dev`
65 * `libwebkit2gtk-4.0-dev`
66 * `libjson-glib-dev`
67 * `libgee-0.8-dev`
68 * `libsoup2.4-dev`
69 * `libsqlite3-dev`
70 * `libxml2-dev`
71 * `libpolkit-gobject-1-dev`
72 * `libunity-dev` (optional, required for launcher icon quicklist, progress indicator and counter; pass `-Duse_libunity=true` to `meson` to use)
73 * `libmanette-0.2-dev`, `libx11-dev`, `libxtst-dev` (optional, required for gamepad support)
75 #### Building
76 ```bash
77 git clone https://github.com/tkashkin/GameHub.git
78 cd GameHub
79 scripts/build.sh build_deb
80 ```
82 ### Any distro, without package manager
83 ```bash
84 git clone https://github.com/tkashkin/GameHub.git
85 cd GameHub
86 meson build --prefix=/usr --buildtype=debug
87 cd build
88 ninja
89 sudo ninja install
90 ```
92 ### flatpak
93 ```bash
94 git clone https://github.com/tkashkin/GameHub.git
95 cd GameHub
96 scripts/build.sh build_flatpak
97 ```
99 ## [Screenshots](https://tkashkin.tk/projects/gamehub/#/screenshots)
100 <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>