ソースを参照

Rename and edit data_paths.rst

Closes #4181
Nathan Lovato 4 年 前
コミット
5ae5a3a3be
1 ファイル変更46 行追加45 行削除
  1. 46 45
      tutorials/io/data_paths.rst

+ 46 - 45
tutorials/io/data_paths.rst

@@ -1,51 +1,52 @@
 .. _doc_data_paths:
 
-Data paths
-==========
+File paths in Godot projects
+============================
+
+This page explains how file paths work inside Godot projects. You will learn how
+to access paths in your projects using the ``res://`` and ``user://`` notations
+and where Godot stores user files on your hard-drive.
 
 Path separators
 ---------------
 
-For the sake of supporting as many platforms as possible, Godot only
-accepts UNIX-style path separators (``/``). These work on all
-platforms, including Windows.
-
-A path like ``C:\Projects`` will become ``C:/Projects``.
+To as many platforms as possible, Godot only accepts UNIX-style path separators
+(``/``). These work on all platforms, including Windows.
 
-Resource path
--------------
+Instead of writing paths like ``C:\Projects``, in Godot, you should write
+``C:/Projects``.
 
-As mentioned in the :ref:`doc_command_line_tutorial`, Godot considers that
-a project exists in any given folder that contains a ``project.godot``
-text file, even if such file is empty.
+Accessing files in the project folder
+-------------------------------------
 
-Accessing project files can be done by opening any path with ``res://``
-as a base. For example, a texture located in the root of the project
-folder may be opened from the following path: ``res://some_texture.png``.
+Godot considers that a project exists in any folder that contains a
+``project.godot`` text file, even if the file is empty. The folder that contains
+this file is your project's root folder.
 
-User path (persistent data)
----------------------------
+You can access any file relative to it by writing paths starting with
+``res://``, which stands for resources. For example, you can access an image
+file ``character.png`` located in the project's root folder in code with the
+following path: ``res://some_texture.png``.
 
-While the project is running, it is a common scenario that the
-resource path will be read-only, due to it being inside a package,
-self-contained executable, or system-wide install location.
+Accessing persistent user data
+------------------------------
 
-Storing persistent files in such scenarios should be done by using the
-``user://`` prefix, for example: ``user://game_save.txt``.
+To store persistent data files, like the player's save or settings, you want to
+use ``user://`` instead of ``res://`` as your path's prefix. This is because
+when the game is running, the project's file system will likely be read-only.
 
-On some devices (for example, mobile and consoles), this path is unique
-to the project. On desktop operating systems, the engine uses the
-typical ``~/.local/share/godot/app_userdata/Name`` on macOS and Linux,
-and ``%APPDATA%/Name`` on Windows. ``Name`` is taken from the
-application name defined in the Project Settings, but it can be
-overridden on a per-platform basis using
-:ref:`feature tags <doc_feature_tags>`.
+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 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>`.
 
 Editor data paths
 -----------------
 
-The editor uses different paths for user data, user settings and cache depending
-on the platform. By default, these paths are:
+The editor uses different paths for user data, user settings, and cache,
+depending on the platform. By default, these paths are:
 
 +---------------+---------------------------------------------------+
 | Type          | Location                                          |
@@ -64,19 +65,19 @@ on the platform. By default, these paths are:
 +---------------+---------------------------------------------------+
 
 - **User data** contains export templates and project-specific data.
-- **User settings** contains editor settings, text editor themes,
-  script templates, etc.
-- **Cache** contains temporary data. It can safely be removed
-  when Godot is closed.
+- **User settings** contains editor settings, text editor themes, script
+  templates, etc.
+- **Cache** contains temporary data. It can safely be removed when Godot is
+  closed.
 
 Godot complies with the `XDG Base Directory Specification
 <https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html>`__
-on all platforms. Environment variables can be overridden as per
-the specification to change the editor (and project) data paths.
+on all platforms. You can override environment variables following the
+specification to change the editor and project data paths.
 
-.. note:: If you use
-          `Godot packaged as a Flatpak <https://flathub.org/apps/details/org.godotengine.Godot>`__,
-          the editor data paths will be located in subfolders in
+.. note:: If you use `Godot packaged as a Flatpak
+          <https://flathub.org/apps/details/org.godotengine.Godot>`__, the
+          editor data paths will be located in subfolders in
           ``~/.var/app/org.godotengine.Godot/``.
 
 .. _doc_data_paths_self_contained_mode:
@@ -85,10 +86,10 @@ Self-contained mode
 ~~~~~~~~~~~~~~~~~~~
 
 If you create a file called ``._sc_`` or ``_sc_`` in the same directory as the
-editor binary, Godot will enable *self-contained mode*. This will make Godot
+editor binary, Godot will enable *self-contained mode*. This mode makes Godot
 write all user data to a directory named ``editor_data/`` in the same directory
-as the editor binary. This is useful to create a "portable" installation,
-which can then be placed on an USB drive.
+as the editor binary. You can use it to create a portable installation of the
+editor.
 
-The `Steam release of Godot <https://store.steampowered.com/app/404790/>`__
-uses self-contained mode by default.
+The `Steam release of Godot <https://store.steampowered.com/app/404790/>`__ uses
+self-contained mode by default.