pandemonium_engine_docs/usage/io/data_paths.md

File paths in Pandemonium projects
============================

This page explains how file paths work inside Pandemonium projects. You will learn how
to access paths in your projects using the `res://` and `user://` notations,
and where Pandemonium stores project and editor files on your and your users' systems.

Path separators
---------------

To make supporting multiple platforms easier, Pandemonium uses **UNIX-style path
separators** (forward slash `/`). These work on all platforms, **including
Windows**.

Instead of writing paths like `C:\Projects\Game`, in Pandemonium, you should write
`C:/Projects/Game`.

Windows-style path separators (backward slash `\`) are also supported in some
path-related methods, but they need to be doubled (`\\`), as `\` is normally
used as an escape for characters with a special meaning.

This makes it possible to work with paths returned by other Windows
applications. We still recommend using only forward slashes in your own code to
guarantee that everything will work as intended.

Accessing files in the project folder (`res://`)
--------------------------------------------------

Pandemonium considers that a project exists in any folder that contains a
`project.pandemonium` text file, even if the file is empty. The folder that contains
this file is your project's root folder.

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://character.png)`.

Accessing persistent user data (`user://`)
--------------------------------------------

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.

The `user://` prefix points to a different directory on the user's device.
Unlike `res://`, the directory pointed at by `user://` is created
automatically and *guaranteed* to be writable to, even in an exported project.

The location of the `user://` folder depends on what is configured in the
Project Settings:

- By default, the `user://` folder is created within Pandemonium's
  `editor data path ( doc_data_paths_editor_data_paths )` in the
  `app_userdata/[project_name]` folder. This is the default so that prototypes
  and test projects stay self-contained within Pandemonium's data folder.
- If `application/config/use_custom_user_dir`
  is enabled in the Project Settings, the `user://` folder is created **next
  to** Pandemonium's editor data path, i.e. in the standard location for applications
  data.

  * By default, the folder name will be inferred from the project name, but it
    can be further customized with
    `application/config/custom_user_dir_name`.
    This path can contain path separators, so you can use it e.g. to group
    projects of a given studio with a `Studio Name/Game Name` structure.

On desktop platforms, the actual directory paths for `user://` are:

+---------------------+------------------------------------------------------------------------------+
| Type                | Location                                                                     |
+=====================+==============================================================================+
| Default             | | Windows: `%APPDATA%\Pandemonium\app_userdata\[project_name]`                   |
|                     | | macOS: `~/Library/Application Support/Pandemonium/app_userdata/[project_name]` |
|                     | | Linux: `~/.local/share/pandemonium/app_userdata/[project_name]`                |
+---------------------+------------------------------------------------------------------------------+
| Custom dir          | | Windows: `%APPDATA%\[project_name]`                                      |
|                     | | macOS: `~/Library/Application Support/[project_name]`                    |
|                     | | Linux: `~/.local/share/[project_name]`                                   |
+---------------------+------------------------------------------------------------------------------+
| Custom dir and name | | Windows: `%APPDATA%\[custom_user_dir_name]`                              |
|                     | | macOS: `~/Library/Application Support/[custom_user_dir_name]`            |
|                     | | Linux: `~/.local/share/[custom_user_dir_name]`                           |
+---------------------+------------------------------------------------------------------------------+

`[project_name]` is based on the application name defined in the Project Settings, but
you can override it on a per-platform basis using `feature tags ( doc_feature_tags )`.

On mobile platforms, this path is unique to the project and is not accessible
by other applications for security reasons.

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
through the `JavaScript` singleton.)

Converting paths to absolute paths or "local" paths
---------------------------------------------------

You can use `ProjectSettings.globalize_path()`
to convert a "local" path like `res://path/to/file.txt` to an absolute OS path.
For example, `ProjectSettings.globalize_path()`
can be used to open "local" paths in the OS file manager
using `OS.shell_open()` since it only accepts
native OS paths.

To convert an absolute OS path to a "local" path starting with `res://`
or `user://`, use `ProjectSettings.localize_path()`.
This only works for absolute paths that point to files or folders in your
project's root or `user://` folders.



Editor data paths
-----------------

The editor uses different paths for editor data, editor settings, and cache,
depending on the platform. By default, these paths are:

+-----------------+---------------------------------------------------+
| Type            | Location                                          |
+=================+===================================================+
| Editor data     | | Windows: `%APPDATA%\Pandemonium\`                   |
|                 | | macOS: `~/Library/Application Support/Pandemonium/` |
|                 | | Linux: `~/.local/share/pandemonium/`                |
+-----------------+---------------------------------------------------+
| Editor settings | | Windows: `%APPDATA%\Pandemonium\`                   |
|                 | | macOS: `~/Library/Application Support/Pandemonium/` |
|                 | | Linux: `~/.config/pandemonium/`                     |
+-----------------+---------------------------------------------------+
| Cache           | | Windows: `%TEMP%\Pandemonium\`                      |
|                 | | macOS: `~/Library/Caches/Pandemonium/`              |
|                 | | Linux: `~/.cache/pandemonium/`                      |
+-----------------+---------------------------------------------------+

- **Editor data** contains export templates and project-specific data.
- **Editor settings** contains the main editor settings configuration file as
  well as various other user-specific customizations (editor layouts, feature
  profiles, script templates, etc.).
- **Cache** contains data generated by the editor, or stored temporarily.
  It can safely be removed when Pandemonium is closed.

Pandemonium complies with the `XDG Base Directory Specification
( https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html )`
on all platforms. You can override environment variables following the
specification to change the editor and project data paths.

Note:
 If you use `Pandemonium packaged as a Flatpak
          ( https://flathub.org/apps/details/org.pandemoniumengine.Pandemonium )`, the
          editor data paths will be located in subfolders in
          `~/.var/app/org.pandemoniumengine.Pandemonium/`.



Self-contained mode
~~~~~~~~~~~~~~~~~~~

If you create a file called `._sc_` or `sc_` in the same directory as the
editor binary (or in `MacOS/Contents/` for a macOS editor .app bundle), Pandemonium
will enable *self-contained mode*.
This mode makes Pandemonium write all editor data, settings, and cache to a directory
named `editor_data/` in the same directory as the editor binary.
You can use it to create a portable installation of the editor.

The `Steam release of Pandemonium ( https://store.steampowered.com/app/404790/ )` uses
self-contained mode by default.

Note:


    Self-contained mode is not supported in exported projects yet.
    To read and write files relative to the executable path, use
    `OS.get_executable_path()`.
    Note that writing files in the executable path only works if the executable
    is placed in a writable location (i.e. **not** Program Files or another
    directory that is read-only for regular users).