Chemins d'accès aux fichiers dans les projets Godot

Cette page explique comment les chemins de fichiers fonctionnent dans les projets Godot. Vous apprendrez comment accéder aux chemins dans vos projets en utilisant les notations res:// et user:// et où Godot stocke les fichiers utilisateurs sur votre disque-dur.

Séparateurs de chemin

Afin de supporter le plus grand nombre de plateformes possible, Godot n'accepte que les séparateurs de chemin de style UNIX (/). Ceux-ci fonctionnent sur toutes les plateformes, y compris Windows.

Au lieu d'écrire des chemins comme C:\Projects, dans Godot, vous devriez écrire C:/Projects.

Accéder aux fichiers dans le dossier du projet

Godot considère qu'un projet existe dans tout dossier qui contient un fichier texte project.godot, même si ce fichier est vide. Le dossier qui contient ce fichier est le dossier racine de votre projet.

Vous pouvez accéder à n'importe quel fichier de manière relative à celui-ci en écrivant des chemins commençant par res://, qui représente les ressources. Par exemple, vous pouvez accéder à un fichier image character.png situé dans le dossier racine du projet en code avec le chemin suivant : res://some_texture.png.

Accès aux données persistantes des utilisateurs

Pour stocker des fichiers de données persistants, comme la sauvegarde ou les paramètres du joueur, vous devez utiliser user:// au lieu de res:// comme préfixe de votre chemin. En effet, lorsque le jeu est en cours d'exécution, le système de fichiers du projet sera probablement en lecture seule.

Le préfixe user:// pointe vers un répertoire différent sur l’appareil de l’utilisateur. Sur les mobiles et les consoles, ce chemin est unique au projet. Sur les appareils de bureau, le moteur stocke les fichiers utilisateur dans ~/.local/share/godot/app_userdata/[project_name] sur Linux, ~/Library/Application Support/Godot/app_userdata/[project_name] sur macOS (depuis Catalina) et %APPDATA%\Godot\app_userdata\[project_name] sur Windows. [project_name] est basé sur le nom de l'application défini dans les paramètres du projet, mais vous pouvez le remplacer sur une base par plateforme en utilisant feature tags.

Sur les exportations HTML5, user:// fera référence à un système de fichiers virtuel stocké sur le périphérique via IndexedDB. (L'interaction avec le système de fichiers principal peut toujours être effectuée par le singleton JavaScript.)

Chemins de données de l'éditeur

L'éditeur utilise différents chemins pour les données utilisateur, les paramètres utilisateur et le cache en fonction de la plate-forme. Par défaut, ces chemins sont :

Type

Localisation

Données utilisateur

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

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

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

Données utilisateur (lorsque le paramètre du projet use_custom_user_dir est true)

  • Windows : %APPDATA%\[project_name]

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

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

Réglages utilisateur

  • Windows : C:\Users\[username]\AppData\Roaming\Godot\app_userdata\[Name]

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

  • Linux : ~/.config/godot/

Cache

  • Windows : %TEMP%\Godot\

  • macOS : ~/Library/Caches/Godot/

  • Linux : ~/.cache/godot/

  • Les données utilisateur contiennent des modèles d'exportation et des données spécifiques au projet.

  • Paramètres utilisateur contient les paramètres de l'éditeur, les thèmes de l'éditeur de texte, les modèles de script, etc.

  • Cache contient des données temporaires. Il peut être supprimé en toute sécurité lorsque Godot est fermé.

Godot est conforme à la XDG Base Directory Specification sur toutes les plateformes. Les variables d'environnement peuvent être remplacées selon la spécification pour modifier les chemins de données de l'éditeur et du projet.

Note

Si vous utilisez Godot comme package Flatpak, les chemins de données de l'éditeur seront situés dans des sous-dossiers de ~/.var/app/org.godotengine.Godot/.

Mode autonome

Si vous créez un fichier appelé ._sc_ ou _sc_ dans le même répertoire que le binaire de l'éditeur, Godot activera le mode self-contained. Ceci fera que Godot écrira toutes les données utilisateur dans un répertoire nommé editor_data/ dans le même répertoire que le binaire de l'éditeur. Vous pouvez l'utiliser pour créer une installation portable de l'éditeur.

La version Steam de Godot utilise le mode autonome par défaut.