Skip to content

Commit af7fcec

Browse files
authored
Add flatpak docs (#21)
* Add explainer on Flatpak installations * Add note about the `GemRB.cfg` location for Flatpak install
1 parent 2b9abb3 commit af7fcec

2 files changed

Lines changed: 24 additions & 3 deletions

File tree

Install.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ page](http://sourceforge.net/projects/gemrb/files/)**. Here is a handy table wit
1212

1313
| | Release downloads | Development downloads |
1414
| --- | :---: | :---: |
15-
| **Binaries** | [<i class="fab fa-windows"></i> Windows]({{ page.sf }}/{{ site.version }}/gemrb-win32-v{{ site.version }}.zip),<br>[<i class="fab fa-linux"></i> Linux]({{ page.sf }}/{{ site.version }}/gemrb-linux-v{{ site.version }}.AppImage),<br>[<i class="fab fa-apple"></i> macOS x86]({{ page.sf }}/{{ site.version }}/gemrb-macos-v{{ site.version }}.tar.bz2),<br>[<i class="fab fa-apple"></i> macOS ARM64]({{ page.sf }}/{{ site.version }}/gemrb-macos-arm64-v{{ site.version }}.zip) ([Mac Source Ports alternative](https://www.macsourceports.com/sourceport/gemrb)) | [Build bots](https://sourceforge.net/projects/gemrb/files/Buildbot%20Binaries/) |
15+
| **Binaries** | [<i class="fab fa-windows"></i> Windows]({{ page.sf }}/{{ site.version }}/gemrb-win32-v{{ site.version }}.zip),<br>[<i class="fab fa-linux"></i> Linux]({{ page.sf }}/{{ site.version }}/gemrb-linux-v{{ site.version }}.AppImage),<br>[<i class="fab fa-linux"></i> Linux (Flatpak)](https://flathub.org/apps/org.gemrb.gemrb),<br>[<i class="fab fa-apple"></i> macOS x86]({{ page.sf }}/{{ site.version }}/gemrb-macos-v{{ site.version }}.tar.bz2),<br>[<i class="fab fa-apple"></i> macOS ARM64]({{ page.sf }}/{{ site.version }}/gemrb-macos-arm64-v{{ site.version }}.zip) ([Mac Source Ports alternative](https://www.macsourceports.com/sourceport/gemrb)) | [Build bots](https://sourceforge.net/projects/gemrb/files/Buildbot%20Binaries/) |
1616
| Source | [Tarball]({{ page.sf }}/{{ site.version }}/gemrb-{{ site.version }}-sources.tar.gz) | See [dev docs](Dev-docs.html#getting-the-code) |
1717
| Version | {{ site.version }} | {{ site.version }}-git with build number |
1818

@@ -56,6 +56,11 @@ Edit the shipped **`GemRB.cfg`**: the only thing that always needs to be changed
5656
GemRB in a game folder) is the **path to the game's data files** (`GamePath`). It is crucial you get
5757
this right to be able to use the configuration.
5858

59+
Please note that the Linux Flatpak distribution of GemRB does not include a `GemRB.cfg` that's accessible
60+
immediately after installation. You will need to run GemRB once for this to be created in
61+
`~/.var/app/org.gemrb.gemrb/config/gemrb/GemRB.cfg`.
62+
{: .notice--warning}
63+
5964
If you are curious, read the detailed explanation of all the [configuration options](Manpage.md).
6065
The configuration filename is arbitrary, but check the note in the *Options* section.
6166

@@ -72,7 +77,8 @@ screen. If that doesn't happen, check the end of the log for errors and fix the
7277
configuration file as needed. Usually the game path is set wrong.
7378

7479
Run the `gemrb` binary, optionally specifying the desired configuration: `gemrb.exe -c torment.cfg`
75-
or game path: `gemrb /games/gog/iwd2`.
80+
or game path: `gemrb /games/gog/iwd2`. This also works with the Flatpak version:
81+
`flatpak run org.gemrb.gemrb ~/.var/app/org.gemrb.gemrb/data/iwd2`.
7682

7783
If you named the configuration file `GemRB.cfg` and put it in the same folder as the binary,
7884
that file will be used automatically. If the GemRB files are put into a game folder, it will
@@ -81,7 +87,8 @@ can **just click on the program**.
8187

8288
If you're using a touch screen, read this page for the [gesture information](Touch-input.md).
8389

84-
On Linux, BSDs and similar, the configuration file will be searched for in `$XDG_CONFIG_HOME/gemrb`, `~/.config/gemrb`, `/etc/gemrb`, `~/.gemrb` and the current working directory.
90+
On Linux, BSDs and similar, the configuration file will be searched for in
91+
`$XDG_CONFIG_HOME/gemrb`, `~/.config/gemrb`, `/etc/gemrb`, `~/.gemrb` and the current working directory.
8592
{: .notice--info}
8693

8794
## How to run the GemRB demo?

Installing-games.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,3 +27,17 @@ the optical media — if you still have them. Check out the
2727
[detailed instructions](https://github.com/gemrb/gemrb/wiki/Unshield:-alternative-game-install-method)
2828
on the wiki.
2929

30+
## GemRB Linux Flatpak
31+
32+
Please note that the Flatpak distribution of GemRB is heavily sandboxed by default;
33+
this is a regular security feature of Flatpak. In the default setup, the easiest approach
34+
is to copy your games to **`~/.var/app/org.gemrb.gemrb/data/`**; if you want to store your
35+
games in a different location you will need to explicitly give the GemRB Flatpak
36+
permission to access this location.
37+
38+
You can adjust permissions for Flatpak apps using the built-in graphical configuration tools on many modern
39+
Linux desktops such as KDE (`System Settings > Flatpak Permissions`) or GNOME (`Settings > Apps`), using external
40+
graphical configuration tools such as [Flatseal](https://flathub.org/en/apps/com.github.tchx84.Flatseal)
41+
or [Warehouse](https://flathub.org/en/apps/io.github.flattool.Warehouse), or with the
42+
[`flatpak override`](https://docs.flatpak.org/en/latest/flatpak-command-reference.html#flatpak-override)
43+
command in a terminal.

0 commit comments

Comments
 (0)