Шляхи до файлів у проектах Godot

На цій сторінці пояснюється, як працюють шляхи до файлів у проектах Godot. Ви дізнаєтеся, як отримати доступ до шляхів у ваших проектах за допомогою приміток res:// і user://, і де Godot зберігає файли користувачів на жорсткому диску.

Роздільники шляху

To make supporting multiple platforms easier, Godot only accepts UNIX-style path separators (/). These work on all platforms, including Windows.

Замість писати C:\Projects, в Godot, ви повинні писати C:/Projects.

Доступ до файлів у теці проекту

Godot вважає, що проект існує в будь-якій теці, яка містить текстовий файл project.godot, навіть якщо файл пустий. Тека, яка містить цей файл, є кореневою текою проекту.

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.

Доступ до постійних даних користувача

Щоб зберігати постійні файли даних, наприклад збереження, або параметри, гри, потрібно використовувати user:// замість res://. Це пов'язано з тим, що під час запуску гри файлова система проекту, швидше за все, буде доступна лише для читання.

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

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

Тип

Розташування

Дані користувача

  • Windows: %APPDATA%\Godot\app_userdata\[project_name]

  • macOS: ~/Library/Application Support/Godot/app_userdata/[project_name]

  • Linux: ~/.local/share/godot/app_userdata/[project_name]

Дані користувача (коли параметр проекту use_custom_user_dir є true)

  • Windows: %APPDATA%\[project_name]

  • macOS: ~/Library/Application Support/[project_name]

  • Linux: ~/.local/share/[project_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.

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

При експорті на HTML5, user:// буде посилатися на віртуальну файлову систему, що зберігається на пристрої через IndexedDB. (Взаємодія з основною файловою системою все ще може здійснюватися через синглтон JavaScript.)

Шляхи до даних редактора

Редактор використовує різні шляхи для даних користувача, параметрів користувача та кешу, залежно від платформи. За замовчуванням такими шляхами є:

Тип

Розташування

Дані користувача

  • Windows: %APPDATA%\Godot\app_userdata\[project_name]

  • macOS: ~/Library/Application Support/Godot/[project_name]

  • Linux: ~/.local/share/godot/[project_name]

Дані користувача (коли параметр проекту use_custom_user_dir є true)

  • Windows: %APPDATA%\[project_name]

  • macOS: ~/Library/Application Support/[project_name]

  • Linux: ~/.local/share/[project_name]

Параметри користувача

  • Windows: %APPDATA%\Godot\

  • macOS: ~/Library/Application Support/Godot/

  • Linux: ~/.config/godot/

Кеш

  • Windows: %TEMP%\Godot\

  • macOS: ~/Library/Caches/Godot/

  • Linux: ~/.cache/godot/

  • Дані користувача містять шаблони експорту та дані для конкретних проектів.

  • Параметри користувача містять параметри редактора, теми текстового редактора, шаблони скриптів тощо.

  • Кеш містить тимчасові дані. Його можна безпечно очистити, коли Godot закритий.

Godot відповідає `специфікації базового каталогу XDG<https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html>`__ на всіх платформах. Ви можете перевизначити змінні середовища після специфікації, щоб змінити шляхи даних редактора і проекту.

Примітка

Якщо ви використовуєте `Godot, упакований як Flatpak<https://flathub.org/apps/details/org.godotengine.Godot>`__, шляхи даних редактора будуть розташовані в вкладених папках у ~/.var/app/org.godotengine.Godot/.

Автономний режим

Якщо ви створите файл під назвою ._sc_, чи _sc_ в тому ж каталозі, що і бінарник редактора, Godot увімкне автономний режим. Цей режим змушує Godot записувати всі дані користувача в каталог під назвою editor_data/ в тому ж каталозі, що і бінарник редактора. Ви можете використовувати його для створення портативного інсталятора редактора.

Випуск Steam Godot використовує автономний режим за замовчуванням.

Примітка

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).