Merge branch 'flatpak-paths' into 'master'

Document Flatpak paths

See merge request OpenMW/openmw!4884
This commit is contained in:
Evil Eye 2025-09-06 09:39:42 +00:00 committed by GitLab
commit 1403fbce1b
No known key found for this signature in database

View File

@ -21,12 +21,15 @@ Configuration files and log files
| Mac | ``$HOME/Library/Preferences/openmw`` | | Mac | ``$HOME/Library/Preferences/openmw`` |
+--------------+---------------+-------------------------------------------------------------------------------+ +--------------+---------------+-------------------------------------------------------------------------------+
| Windows | File Explorer | ``Documents\My Games\OpenMW`` | | Windows | File Explorer | ``Documents\My Games\OpenMW`` |
| | | | | +---------------+-------------------------------------------------------------------------------+
| | PowerShell | ``Join-Path ([environment]::GetFolderPath("mydocuments")) "My Games\OpenMW"`` | | | PowerShell | ``Join-Path ([environment]::GetFolderPath("mydocuments")) "My Games\OpenMW"`` |
| | | | | +---------------+-------------------------------------------------------------------------------+
| | Example | ``C:\Users\Username\Documents\My Games\OpenMW`` | | | Example | ``C:\Users\Username\Documents\My Games\OpenMW`` |
+--------------+---------------+-------------------------------------------------------------------------------+ +--------------+---------------+-------------------------------------------------------------------------------+
.. note::
Flatpak sets ``$XDG_CONFIG_HOME`` to ``$HOME/.var/app/$FLATPAK_ID/config``, so these files will be at ``$HOME/.var/app/org.openmw.OpenMW/config/openmw`` if you use the Flatpak.
Savegames Savegames
--------- ---------
@ -38,12 +41,15 @@ Savegames
| Mac | ``$HOME/Library/Application\ Support/openmw/saves`` | | Mac | ``$HOME/Library/Application\ Support/openmw/saves`` |
+--------------+---------------+-------------------------------------------------------------------------------------+ +--------------+---------------+-------------------------------------------------------------------------------------+
| Windows | File Explorer | ``Documents\My Games\OpenMW\saves`` | | Windows | File Explorer | ``Documents\My Games\OpenMW\saves`` |
| | | | | +---------------+-------------------------------------------------------------------------------------+
| | PowerShell | ``Join-Path ([environment]::GetFolderPath("mydocuments")) "My Games\OpenMW\saves"`` | | | PowerShell | ``Join-Path ([environment]::GetFolderPath("mydocuments")) "My Games\OpenMW\saves"`` |
| | | | | +---------------+-------------------------------------------------------------------------------------+
| | Example | ``C:\Users\Username\Documents\My Games\OpenMW\saves`` | | | Example | ``C:\Users\Username\Documents\My Games\OpenMW\saves`` |
+--------------+---------------+-------------------------------------------------------------------------------------+ +--------------+---------------+-------------------------------------------------------------------------------------+
.. note::
Flatpak sets ``$XDG_DATA_HOME`` to ``$HOME/.var/app/$FLATPAK_ID/data``, so saves will be at ``$HOME/.var/app/org.openmw.OpenMW/data/openmw/saves`` if you use the Flatpak.
Screenshots Screenshots
----------- -----------
@ -55,12 +61,15 @@ Screenshots
| Mac | ``$HOME/Library/Application\ Support/openmw/screenshots`` | | Mac | ``$HOME/Library/Application\ Support/openmw/screenshots`` |
+--------------+---------------+-------------------------------------------------------------------------------------------+ +--------------+---------------+-------------------------------------------------------------------------------------------+
| Windows | File Explorer | ``Documents\My Games\OpenMW\screenshots`` | | Windows | File Explorer | ``Documents\My Games\OpenMW\screenshots`` |
| | | | | +---------------+-------------------------------------------------------------------------------------------+
| | PowerShell | ``Join-Path ([environment]::GetFolderPath("mydocuments")) "My Games\OpenMW\screenshots"`` | | | PowerShell | ``Join-Path ([environment]::GetFolderPath("mydocuments")) "My Games\OpenMW\screenshots"`` |
| | | | | +---------------+-------------------------------------------------------------------------------------------+
| | Example | ``C:\Users\Username\Documents\My Games\OpenMW\screenshots`` | | | Example | ``C:\Users\Username\Documents\My Games\OpenMW\screenshots`` |
+--------------+---------------+-------------------------------------------------------------------------------------------+ +--------------+---------------+-------------------------------------------------------------------------------------------+
.. note::
Flatpak sets ``$XDG_DATA_HOME`` to ``$HOME/.var/app/$FLATPAK_ID/data``, so screenshots will be at ``$HOME/.var/app/org.openmw.OpenMW/data/openmw/screenshots`` if you use the Flatpak.
Custom configuration directories Custom configuration directories
================================ ================================
@ -184,6 +193,9 @@ Tokens are used in the `Default paths`_.
| Windows | ``Documents\My Games\OpenMW\`` | | Windows | ``Documents\My Games\OpenMW\`` |
+--------------+-----------------------------------------------------------+ +--------------+-----------------------------------------------------------+
.. note::
Flatpak sets ``$XDG_CONFIG_HOME`` to ``$HOME/.var/app/$FLATPAK_ID/config``, so ``?userconfig?`` will mean ``$HOME/.var/app/org.openmw.OpenMW/config/openmw/`` if you use the Flatpak.
:``?userdata?``: Platform-dependent: :``?userdata?``: Platform-dependent:
+--------------+--------------------------------------------------------------+ +--------------+--------------------------------------------------------------+
@ -196,6 +208,9 @@ Tokens are used in the `Default paths`_.
| Windows | ``Documents\My Games\OpenMW\`` | | Windows | ``Documents\My Games\OpenMW\`` |
+--------------+--------------------------------------------------------------+ +--------------+--------------------------------------------------------------+
.. note::
Flatpak sets ``$XDG_DATA_HOME`` to ``$HOME/.var/app/$FLATPAK_ID/data``, so ``?userdata?`` will mean ``$HOME/.var/app/org.openmw.OpenMW/data/openmw/`` if you use the Flatpak.
:``?global?``: Platform-dependent: :``?global?``: Platform-dependent:
+--------------+-------------------------------------------------------------------+ +--------------+-------------------------------------------------------------------+