DarkRadiant - Flatpak Installation Guide: Difference between revisions

From The DarkMod Wiki
Jump to navigationJump to search
mNo edit summary
(Update with final instructions for the released version)
Line 1: Line 1:
= '''NOTE: This is a WIP, the Flatpak is not yet online''' =
== Obtaining the Flatpak version of DarkRadiant ==
== Obtaining the Flatpak version of DarkRadiant ==
Flatpak is a universal package format for Linux.  Rather than having a different package for every Linux distribution, the Flatpak version will just work on almost any major distribution.
Flatpak is a universal package format for Linux.  Rather than having a different package for every Linux distribution, the Flatpak version will just work on almost any major distribution.


# If you've never used a Flatpak before, follow the Flatpak setup instructions for your distro here: https://www.flatpak.org/setup/
* If you've never used a Flatpak before, follow the Flatpak setup instructions for your distro here: https://www.flatpak.org/setup/
# Once Flatpak is ready, you can install the DarkRadiant package in a few ways:
* Once Flatpak is ready, you can install the DarkRadiant package in a few ways:
## You can install the package directly from FlatHub: https://flathub.org/apps/details/net.darkradiant.DarkRadiant
** You can install the package directly from FlatHub: https://flathub.org/apps/details/net.darkradiant.DarkRadiant
## If you are making use of a graphical package installer such as Discover or <Gnome equivalent>, you can simply search for and install DarkRadiant.
** If you are making use of a graphical package installer such as Discover or GNOME Software, you can simply search for and install DarkRadiant.
## Alternatively, from the command line you can run <code>flatpak install --user flathub net.darkradiant.DarkRadiant</code>.
** Alternatively, from the command line you can run <code>flatpak install --user flathub net.darkradiant.DarkRadiant</code>.
 
== After Installation ==
One of Flatpak's features is its ability to sandbox applications, providing only the minimum file and device permissions necessary for the application to run.  For many applications, you won't ever notice a difference, but for DarkRadiant one additional step is needed to allow DarkRadiant to access the assets from your main game path.  This can be done graphically using [https://flathub.org/apps/details/com.github.tchx84.Flatseal Flatseal], or by using the command line. 


Start by making note of the path to your DarkMod (or other IdTech4 game) installation, then choose one of the two options below.
== Optional - Enable the sandbox ==
One of Flatpak's features is its ability to sandbox applications, providing only the minimum file and device permissions necessary for the application to run.  However, DarkRadiant needs to have access to the assets from your main game path, which may be installed in any location.  DarkRadiant must currently have permissions to access the entire filesystem to allow this, but you can reduce this down to your game path manually if desired.  This can be done easily using [https://flathub.org/apps/details/com.github.tchx84.Flatseal Flatseal].


=== Add permissions graphically ===
# Install and run [https://flathub.org/apps/details/com.github.tchx84.Flatseal Flatseal].
# Install and run [https://flathub.org/apps/details/com.github.tchx84.Flatseal Flatseal]
# In the Applications list, find and select DarkRadiant.
# In the Applications list, find and select DarkRadiant.
# In the Filesystem section, hit the Add button inside "Other files".
# In the Filesystem section, turn off the "All system files" option.
# Press the Add button inside "Other files".
# Enter the line <code>filesystem=/path/to/tdm</code>, substituting the path to the root of your DarkMod installation.
# Enter the line <code>filesystem=/path/to/tdm</code>, substituting the path to the root of your DarkMod installation.
=== Add permissions from the command line ===
:Run the following command, substituting the path to the root of your DarkMod installation:
:<code>flatpak override --user --filesystem=/path/to/tdm net.darkradiant.DarkRadiant</code>


== Running DarkRadiant ==
== Running DarkRadiant ==
# The Flatpak version can be launched from your window manager like any other desktop application.
# The Flatpak version can be launched from your window manager like any other desktop application.
# Alternatively, to launch it from the command line you can run <code>flatpak run net.darkradiant.DarkRadiant</code>.
# Alternatively, to launch it from the command line you can run <code>flatpak run net.darkradiant.DarkRadiant</code>.
Upon first launch, you will be prompted to select your game path.  If you cannot successfully enter your game path, double-check the permissions settings above.

Revision as of 13:57, 18 September 2022

Obtaining the Flatpak version of DarkRadiant

Flatpak is a universal package format for Linux. Rather than having a different package for every Linux distribution, the Flatpak version will just work on almost any major distribution.

  • If you've never used a Flatpak before, follow the Flatpak setup instructions for your distro here: https://www.flatpak.org/setup/
  • Once Flatpak is ready, you can install the DarkRadiant package in a few ways:
    • You can install the package directly from FlatHub: https://flathub.org/apps/details/net.darkradiant.DarkRadiant
    • If you are making use of a graphical package installer such as Discover or GNOME Software, you can simply search for and install DarkRadiant.
    • Alternatively, from the command line you can run flatpak install --user flathub net.darkradiant.DarkRadiant.

Optional - Enable the sandbox

One of Flatpak's features is its ability to sandbox applications, providing only the minimum file and device permissions necessary for the application to run. However, DarkRadiant needs to have access to the assets from your main game path, which may be installed in any location. DarkRadiant must currently have permissions to access the entire filesystem to allow this, but you can reduce this down to your game path manually if desired. This can be done easily using Flatseal.

  1. Install and run Flatseal.
  2. In the Applications list, find and select DarkRadiant.
  3. In the Filesystem section, turn off the "All system files" option.
  4. Press the Add button inside "Other files".
  5. Enter the line filesystem=/path/to/tdm, substituting the path to the root of your DarkMod installation.

Running DarkRadiant

  1. The Flatpak version can be launched from your window manager like any other desktop application.
  2. Alternatively, to launch it from the command line you can run flatpak run net.darkradiant.DarkRadiant.
Retrieved from "https://wiki.thedarkmod.com/index.php?title=DarkRadiant_-_Flatpak_Installation_Guide&oldid=29848"