From 2b7d5fec92b129d06da0bf91285c4d4a78db096a Mon Sep 17 00:00:00 2001 From: skyace65 Date: Wed, 22 Dec 2021 19:59:10 -0500 Subject: [PATCH 1/3] Fix and expand user data path information --- tutorials/io/data_paths.rst | 43 +++++++++++++++++++++---------------- 1 file changed, 24 insertions(+), 19 deletions(-) diff --git a/tutorials/io/data_paths.rst b/tutorials/io/data_paths.rst index d6bcfd252..2183665f4 100644 --- a/tutorials/io/data_paths.rst +++ b/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 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 -Linux, ``~/Library/Application Support/Godot/app_userdata/Name`` on macOS (since Catalina) 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 `. +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 `. 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 @@ -65,21 +66,25 @@ Editor data paths The editor uses different paths for user data, user settings, and cache, 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 settings** contains editor settings, text editor themes, script From 0956d0e99335042f8f404ff28b1f7767a9e2e449 Mon Sep 17 00:00:00 2001 From: Hugo Locurcio Date: Fri, 24 Dec 2021 19:05:28 +0100 Subject: [PATCH 2/3] Apply suggestions from code review --- tutorials/io/data_paths.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tutorials/io/data_paths.rst b/tutorials/io/data_paths.rst index 2183665f4..65d5b40d3 100644 --- a/tutorials/io/data_paths.rst +++ b/tutorials/io/data_paths.rst @@ -73,7 +73,7 @@ depending on the platform. By default, these paths are: | | - macOS: ``~/Library/Application Support/Godot/[project_name]``| | | - Linux: ``~/.local/share/godot/[project_name]`` | +------------------------------+----------------------------------------------------------------+ -| User Data | - Windows: ``%APPDATA%\[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]`` | +------------------------------+----------------------------------------------------------------+ From fefe84fb23eee4bdef89656bc48e1d89bd0c2660 Mon Sep 17 00:00:00 2001 From: Hugo Locurcio Date: Fri, 24 Dec 2021 19:06:29 +0100 Subject: [PATCH 3/3] Apply suggestions from code review --- tutorials/io/data_paths.rst | 38 ++++++++++++++++++------------------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/tutorials/io/data_paths.rst b/tutorials/io/data_paths.rst index 65d5b40d3..f88e40155 100644 --- a/tutorials/io/data_paths.rst +++ b/tutorials/io/data_paths.rst @@ -66,25 +66,25 @@ Editor data paths The editor uses different paths for user data, user settings, and cache, depending on the platform. By default, these paths are: -+------------------------------+----------------------------------------------------------------+ -| 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/`` | -+------------------------------+----------------------------------------------------------------+ ++-------------------------------+----------------------------------------------------------------+ +| 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 settings** contains editor settings, text editor themes, script