Browse Source

Merge pull request #5463 from skyace65/data-path

Fix and expand user data path information

(cherry picked from commit dc0819b5932008e25027dba9436c2814ebb79386)
Max Hilbrunner 3 years ago
parent
commit
c6900647cc
1 changed files with 24 additions and 19 deletions
  1. 24 19
      tutorials/io/data_paths.rst

+ 24 - 19
tutorials/io/data_paths.rst

@@ -37,10 +37,11 @@ when the game is running, the project's file system will likely be read-only.
 
 
 The ``user://`` prefix points to a different directory on the user's device. On
 The ``user://`` prefix points to a different directory on the user's device. On
 mobile and consoles, this path is unique to the project. On desktop, the engine
 mobile and consoles, this path is unique to the project. On desktop, the engine
-stores user files in ``~/.local/share/godot/app_userdata/Name`` on macOS and
-Linux, and ``%APPDATA%/Name`` on Windows. ``Name`` is based on the application
-name defined in the Project Settings, but you can override it on a per-platform
-basis using :ref:`feature tags <doc_feature_tags>`.
+stores user files in ``~/.local/share/godot/app_userdata/[project_name]`` on
+Linux, ``~/Library/Application Support/Godot/app_userdata/[project_name]`` on
+macOS (since Catalina) and ``%APPDATA%\Godot\app_userdata\[project_name]`` on Windows.
+``[project_name]`` is based on the application name defined in the Project Settings, but
+you can override it on a per-platform basis using :ref:`feature tags <doc_feature_tags>`.
 
 
 On HTML5 exports, ``user://`` will refer to a virtual filesystem stored on the
 On HTML5 exports, ``user://`` will refer to a virtual filesystem stored on the
 device via IndexedDB. (Interaction with the main filesystem can still be performed
 device via IndexedDB. (Interaction with the main filesystem can still be performed
@@ -52,21 +53,25 @@ Editor data paths
 The editor uses different paths for user data, user settings, and cache,
 The editor uses different paths for user data, user settings, and cache,
 depending on the platform. By default, these paths are:
 depending on the platform. By default, these paths are:
 
 
-+---------------+---------------------------------------------------+
-| Type          | Location                                          |
-+===============+===================================================+
-| User data     | - Windows: ``%APPDATA%\Godot\``                   |
-|               | - macOS: ``~/Library/Application Support/Godot/`` |
-|               | - Linux: ``~/.local/share/godot/``                |
-+---------------+---------------------------------------------------+
-| User settings | - Windows: ``%APPDATA%\Godot\``                   |
-|               | - macOS: ``~/Library/Application Support/Godot/`` |
-|               | - Linux: ``~/.config/godot/``                     |
-+---------------+---------------------------------------------------+
-| Cache         | - Windows: ``%TEMP%\Godot\``                      |
-|               | - macOS: ``~/Library/Caches/Godot/``              |
-|               | - Linux: ``~/.cache/godot/``                      |
-+---------------+---------------------------------------------------+
++-------------------------------+----------------------------------------------------------------+
+| Type                          | Location                                                       |
++===============================+================================================================+
+| User data                     | - Windows: ``%APPDATA%\Godot\app_userdata\[project_name]``     |
+|                               | - macOS: ``~/Library/Application Support/Godot/[project_name]``|
+|                               | - Linux: ``~/.local/share/godot/[project_name]``               |
++-------------------------------+----------------------------------------------------------------+
+| User data                     | - Windows: ``%APPDATA%\[project_name]``                        |
+| (when ``use_custom_user_dir`` | - macOS: ``~/Library/Application Support/[project_name]``      |
+| project setting is ``true``)  | - Linux: ``~/.local/share/[project_name]``                     |
++-------------------------------+----------------------------------------------------------------+
+| User settings                 | - Windows: ``%APPDATA%\Godot\``                                |
+|                               | - macOS: ``~/Library/Application Support/Godot/``              |
+|                               | - Linux: ``~/.config/godot/``                                  |
++-------------------------------+----------------------------------------------------------------+
+| Cache                         | - Windows: ``%TEMP%\Godot\``                                   |
+|                               | - macOS: ``~/Library/Caches/Godot/``                           |
+|                               | - Linux: ``~/.cache/godot/``                                   |
++-------------------------------+----------------------------------------------------------------+
 
 
 - **User data** contains export templates and project-specific data.
 - **User data** contains export templates and project-specific data.
 - **User settings** contains editor settings, text editor themes, script
 - **User settings** contains editor settings, text editor themes, script