mbugni/DoomRunnerFlatpak

This project is discontinued and will be removed, since the app is on Flathub now

This project contains files to build Doom Runner as a Flatpak app.

The app include GZDoom engine to run WADs and files.

How to build the app

1 - Prepare the environment

Ensure you have the following commands installed on your system:

• git
• flatpak
• flatpak-builder

Ensure you have the flathub repo enabled:

$ flatpak remote-add --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo

Clone this project on your computer:

$ git clone https://github.com/mbugni/DoomRunnerFlatpak.git

2 - Build and install the app

From the project directory run the command:

$ sudo flatpak-builder --verbose --install --install-deps-from=flathub --force-clean build \
  io.github.Youda008.DoomRunner.yaml

See flatpak documentation for more info.

The first build can take a while (15 minutes or more), it depends on your machine performances. It compile and install the app, making it available for all users in your system.

3 - Run the app

You can run the Doom Runner launching it from your favorite desktop, or manually by using the flatpak command:

$ flatpak run io.github.Youda008.DoomRunner

Basic usage

• Put data files in ~/.var/app/io.github.Youda008.DoomRunner/data/share.
• Choose your favorite combination from main window
• Press the "Launch!" button
• Have fun!

GZDoom options

Embedded GZDoom engine configs are in ~/.var/app/io.github.Youda008.DoomRunner/config/gzdoom.ini

Custom folders

You can choose different folders in you $HOME directory for data and configs, just select them trough the "Initial setup" menu. For example: $HOME/doom/share for game files and $HOME/doom/config for configs. If you want to use other folders outside your home directory, then you have to extend Flatpak permissions in order to access them.

Advanced usage

Add a Flatpak engine

Let's assume you want to use an engine with app identifier my.app.Engine. Remember that Flatpak apps are sandboxed: the engine cannot access to Doom Runner files and vice versa.

1 - Grant permissions

Ensure that both the engine app and Doom Runner can access to a common folder (eg ~/doom):

$ flatpak override my.app.Engine --filesystem=$HOME/doom

2 - Create a launcher script

Create a launcher script (eg ~/doom/engine/myapp.sh) in the common folder like the following:

#!/usr/bin/bash
exec /usr/bin/flatpak run my.app.Engine "$@"

3 - Add the engine

Add the engine to the Doom Runner list:

• select the file ~/doom/engine/myapp.sh as "Executable path"
• provide an existing "Config directory" (eg ~/doom/config)

4 - Provide game files

Put data files in the common folder (eg ~/doom/share), so both Doom Runner and the engine can access them.

The common folder should look like this:

~/doom/
├── config
│   └── myapp
│       └── doomsav0.dsg
├── share
│   ├── freedoom1.wad
│   └── freedoom2.wad
└── engine
    └── myapp.sh

Repeat the above steps for each Flatpak engine you want to add.