Updated documentation

This commit is contained in:
Kevin Degeling 2021-12-10 19:14:47 +01:00
parent f11873513f
commit a92d76e206
2 changed files with 174 additions and 143 deletions

View file

@ -1,25 +1,38 @@
# GZDoom Flatpak edition #
# GZDoom Flatpak edition
## Installation of game-data
## Installation of gamedata ##
* Copy any commercial iwad into the folder `~/.var/app/org.zdoom.GZDoom/.config/gzdoom/`
* Optionally, configure the `~/.var/app/org.zdoom.GZDoom/.config/gzdoom/gzdoom.ini` file to load other directories
## Run with custom wads
Just as with the standalone GZDoom, you can pass commands through using the command line. If you want to play custom wads, you can add them to a sub-directory of `/gzdoom/` and then you can directly access then from the terminal:
Just as with the stand-alone GZDoom, you can pass commands through using the command line. If you want to play custom wads, you can add them to a sub-directory of `/gzdoom/` and then you can directly access then from the terminal:
```
flatpak run org.zdoom.GZDoom -file ~/.var/app/org.zdoom.GZDoom/.config/gzdoom/pwads/PL2.WAD
```
```
cd ~/.var/app/org.zdoom.GZDoom/.config/gzdoom/pwads/
flatpak run org.zdoom.GZDoom -file ./PL2.WAD
```
For more info, see:
* https://zdoom.org/wiki/Command_line_parameters
* https://zdoom.org/wiki/Installation_and_execution_of_ZDoom
## Accessing files on unconventional spots ##
If you want to access wads in different locations, you might have to adjust the [Flatpak sandboxing permissions](http://docs.flatpak.org/en/latest/sandbox-permissions.html). You can easily do that like this:
## Accessing files
If you want to access wads in different locations, you might have to adjust the [Flatpak sandboxing permissions](http://docs.flatpak.org/en/latest/sandbox-permissions.html).
### GUI
You can use Flatseal to visually manage your permissions:
https://flathub.org/apps/details/com.github.tchx84.Flatseal
### Terminal
You can easily do that like this:
```
flatpak override org.zdoom.GZDoom --filesystem=/OTHER/LOCATION/WITH/WADS --user
```

View file

@ -2,151 +2,169 @@
<!-- Copyright 2019 Kevin Degeling -->
<component type="desktop">
<id>org.zdoom.GZDoom</id>
<name>GZDoom</name>
<summary>Classic first-person-shooter engine for all classical Id games</summary>
<metadata_license>CC0-1.0</metadata_license>
<project_license>GPL-3.0</project_license>
<id>org.zdoom.GZDoom</id>
<name>GZDoom</name>
<summary>Classic first-person-shooter engine for all classical Id games</summary>
<metadata_license>CC0-1.0</metadata_license>
<project_license>GPL-3.0</project_license>
<developer_name>ZDoom team</developer_name>
<update_contact>eonfge@kevindegeling.nl</update_contact>
<developer_name>ZDoom team</developer_name>
<update_contact>eonfge@kevindegeling.nl</update_contact>
<url type="homepage">https://zdoom.org/index</url>
<url type="bugtracker">https://github.com/coelckers/gzdoom</url>
<url type="help">https://zdoom.org/wiki/Main_Page</url>
<url type="faq">https://zdoom.org/about</url>
<url type="contact">https://forum.zdoom.org/</url>
<url type="homepage">https://zdoom.org/index</url>
<url type="bugtracker">https://github.com/coelckers/gzdoom</url>
<url type="help">https://zdoom.org/wiki/Main_Page</url>
<url type="faq">https://zdoom.org/about</url>
<url type="contact">https://forum.zdoom.org/</url>
<launchable type="desktop-id">org.zdoom.GZDoom.desktop</launchable>
<launchable type="desktop-id">org.zdoom.GZDoom.desktop</launchable>
<description>
<p>
GZDoom is a source port for the modern era, supporting current hardware and operating systems and sporting a vast array of user options. Make Doom your own again!
</p>
<p>
In addition to Doom, GZDoom supports Heretic, Hexen, Strife, Chex Quest, and fan-created games like Harmony and Hacx. Meet the entire idTech 1 family!
</p>
<p>
Experience mind-bending user-created mods, made possible by ZDoom's advanced mapping features and the new ZScript language. Or make a mod of your own!
</p>
<ul>
<li>Can play all Doom engine games, including Ultimate Doom, Doom II, Heretic, Hexen, Strife, and more</li>
<li>Supports all the editing features of Hexen. (ACS, hubs, new map format, etc.)</li>
<li>Supports most of the Boom editing features</li>
<li>Features complete translations of Doom, Heretic, Hexen, Strife and other games into over ten different languages with Unicode support for Latin, Cyrillic, and Hangul so far</li>
<li>All Doom limits are gone</li>
<li>Several softsynths for MUS and MIDI playback, including an OPL softsynth for an authentic “oldschool” flavor</li>
<li>High resolutions</li>
<li>Quake-style console and key bindings</li>
<li>Crosshairs</li>
<li>Free look (look up/down)</li>
<li>Jumping, crouching, swimming, and flying</li>
<li>Up to 8 player network games using UDP/IP, including team-based gameplay</li>
<li>Support for the Bloodbath announcer from the classic Monolith game Blood</li>
<li>Walk over/under monsters and other things</li>
</ul>
<p>
Commercial data files are required to run the supported games. For more info about all supported games and their data files, see: Help -> List of supported games.
</p>
</description>
<description>
<p>
GZDoom is a source port for the modern era, supporting current hardware and operating systems and sporting a vast array of user options. Make Doom your own again!
</p>
<screenshots>
<screenshot type="default">
<image>https://raw.githubusercontent.com/flathub/org.zdoom.GZDoom/master/images/image_01.png</image>
<caption>Strife screenshot</caption>
</screenshot>
<screenshot>
<image>https://raw.githubusercontent.com/flathub/org.zdoom.GZDoom/master/images/image_02.png</image>
<caption>Doom screenshot</caption>
</screenshot>
<screenshot>
<image>https://raw.githubusercontent.com/flathub/org.zdoom.GZDoom/master/images/image_03.png</image>
<caption>Heretic screenshot</caption>
</screenshot>
<screenshot>
<image>https://raw.githubusercontent.com/flathub/org.zdoom.GZDoom/master/images/image_04.png</image>
<caption>Hexen screenshot</caption>
</screenshot>
</screenshots>
<p>
In addition to Doom, GZDoom supports Heretic, Hexen, Strife, Chex Quest, and fan-created games like Harmony and Hacx. Meet the entire idTech 1 family!
</p>
<releases>
<release version="4.6.1" date="2021-07-25">
<description>
<p>Updated release package to GZDoom 4.6.1</p>
</description>
</release>
<release version="4.6.0" date="2021-05-22">
<description>
<p>Updated release package to GZDoom 4.6.0</p>
</description>
</release>
<release version="4.5.0" date="2020-10-31">
<description>
<p>Updated release package to GZDoom 4.5.0</p>
</description>
</release>
<release version="4.4.2" date="2020-06-16">
<description>
<p>Updated release package to GZDoom 4.4.2</p>
</description>
</release>
<release version="4.4.1" date="2020-06-10">
<description>
<p>Updated release package to GZDoom 4.4.1</p>
</description>
</release>
<release version="4.4.0" date="2020-06-07">
<description>
<p>Updated release package to GZDoom 4.4.0</p>
</description>
</release>
<release version="4.3.3" date="2020-01-20">
<description>
<p>Updated release package to GZDoom 4.3.3</p>
</description>
</release>
<release version="4.3.2" date="2020-01-12">
<description>
<p>Updated release package to GZDoom 4.3.2</p>
</description>
</release>
<release version="4.3.1" date="2020-01-05">
<description>
<p>Updated release package to GZDoom 4.3.1 (4.3.0 was cancelled)</p>
</description>
</release>
<release version="4.2.4" date="2019-11-03">
<description>
<p>Updated release package to GZDoom 4.2.4</p>
</description>
</release>
<release version="4.2.3" date="2019-10-20">
<description>
<p>Updated release package to GZDoom 4.2.3 (4.2.2 was cancelled)</p>
</description>
</release>
<release version="4.2.1" date="2019-09-11">
<description>
<p>Updated release package to GZDoom 4.2.1 and made many minor changes for Flathub.</p>
</description>
</release>
<release version="4.2.0" date="2019-09-10">
<description>
<p>First release of GZDoom on Flatpak.</p>
</description>
</release>
</releases>
<p>
Experience mind-bending user-created mods, made possible by ZDoom's advanced mapping features and the new ZScript language. Or make a mod of your own!
</p>
<ul>
<li>Can play all Doom engine games, including Ultimate Doom, Doom II, Heretic, Hexen, Strife, and more</li>
<li>Supports all the editing features of Hexen. (ACS, hubs, new map format, etc.)</li>
<li>Supports most of the Boom editing features</li>
<li>Features complete translations of Doom, Heretic, Hexen, Strife and other games into over ten different languages with Unicode support for Latin, Cyrillic, and Hangul so far</li>
<li>All Doom limits are gone</li>
<li>Several softsynths for MUS and MIDI playback, including an OPL softsynth for an authentic “oldschool” flavor</li>
<li>High resolutions</li>
<li>Quake-style console and key bindings</li>
<li>Crosshairs</li>
<li>Free look (look up/down)</li>
<li>Jumping, crouching, swimming, and flying</li>
<li>Up to 8 player network games using UDP/IP, including team-based gameplay</li>
<li>Support for the Bloodbath announcer from the classic Monolith game Blood</li>
<li>Walk over/under monsters and other things</li>
</ul>
<p>
Commercial data files are required to run the supported games. For more info about all supported games and their data files, see: Help -> List of supported games.
</p>
<p>
With Flatpak, all file-access is restricted too ~/.var/app/org.zdoom.GZDoom/.config/gzdoom for privacy reasons. You'll have to manually place your IWADs and PWADS there, or you should use an application like Flatseal to give GZDoom additional permissions.
</p>
</description>
<screenshots>
<screenshot type="default">
<image>https://raw.githubusercontent.com/flathub/org.zdoom.GZDoom/master/images/image_01.png</image>
<caption>Strife screenshot</caption>
</screenshot>
<screenshot>
<image>https://raw.githubusercontent.com/flathub/org.zdoom.GZDoom/master/images/image_02.png</image>
<caption>Doom screenshot</caption>
</screenshot>
<screenshot>
<image>https://raw.githubusercontent.com/flathub/org.zdoom.GZDoom/master/images/image_03.png</image>
<caption>Heretic screenshot</caption>
</screenshot>
<screenshot>
<image>https://raw.githubusercontent.com/flathub/org.zdoom.GZDoom/master/images/image_04.png</image>
<caption>Hexen screenshot</caption>
</screenshot>
</screenshots>
<releases>
<release version="4.7.1" date="2021-10-20">
<description>
<p>Updated release package to GZDoom 4.7.1</p>
</description>
</release>
<release version="4.7.0" date="2021-09-22">
<description>
<p>Updated release package to GZDoom 4.7.0</p>
</description>
</release>
<release version="4.6.1" date="2021-07-25">
<description>
<p>Updated release package to GZDoom 4.6.1</p>
</description>
</release>
<release version="4.6.0" date="2021-05-22">
<description>
<p>Updated release package to GZDoom 4.6.0</p>
</description>
</release>
<release version="4.5.0" date="2020-10-31">
<description>
<p>Updated release package to GZDoom 4.5.0</p>
</description>
</release>
<release version="4.4.2" date="2020-06-16">
<description>
<p>Updated release package to GZDoom 4.4.2</p>
</description>
</release>
<release version="4.4.1" date="2020-06-10">
<description>
<p>Updated release package to GZDoom 4.4.1</p>
</description>
</release>
<release version="4.4.0" date="2020-06-07">
<description>
<p>Updated release package to GZDoom 4.4.0</p>
</description>
</release>
<release version="4.3.3" date="2020-01-20">
<description>
<p>Updated release package to GZDoom 4.3.3</p>
</description>
</release>
<release version="4.3.2" date="2020-01-12">
<description>
<p>Updated release package to GZDoom 4.3.2</p>
</description>
</release>
<release version="4.3.1" date="2020-01-05">
<description>
<p>Updated release package to GZDoom 4.3.1 (4.3.0 was cancelled)</p>
</description>
</release>
<release version="4.2.4" date="2019-11-03">
<description>
<p>Updated release package to GZDoom 4.2.4</p>
</description>
</release>
<release version="4.2.3" date="2019-10-20">
<description>
<p>Updated release package to GZDoom 4.2.3 (4.2.2 was cancelled)</p>
</description>
</release>
<release version="4.2.1" date="2019-09-11">
<description>
<p>Updated release package to GZDoom 4.2.1 and made many minor changes for Flathub.</p>
</description>
</release>
<release version="4.2.0" date="2019-09-10">
<description>
<p>First release of GZDoom on Flatpak.</p>
</description>
</release>
</releases>
<content_rating type="oars-1.1">
<!--
Violence is tricky: You could argue that by 2019 standards, it's cartoonish.
In this regard I follow PEGI, who rates Doom 1993 with an age rating 16
for "bloody violence in an arcane setting"
Violence is tricky: You could argue that by 2019 standards, it's cartoonish.
In this regard I follow PEGI, who rates Doom 1993 with an age rating 16
for "bloody violence in an arcane setting"
-->
<content_attribute id="violence-realistic">moderate</content_attribute>
<content_attribute id="violence-bloodshed">moderate</content_attribute>
<content_attribute id="violence-desecration">moderate</content_attribute>
<!-- While not a primary focus of GZDoom, is does fully support unmoderated mutiplayer -->
<content_attribute id="social-chat">intense</content_attribute>
</content_rating>
<content_rating type="oars-1.1">
<content_attribute id="violence-realistic">moderate</content_attribute>
<content_attribute id="violence-bloodshed">moderate</content_attribute>
<content_attribute id="violence-desecration">moderate</content_attribute>
<!-- While not a primary focus of GZDoom, is does fully support unmoderated mutiplayer -->
<content_attribute id="social-chat">intense</content_attribute>
</content_rating>
</component>