godotengine / godotengine/godot-docs

Inconsistency between `@GDScript.load()` / `ResourceLoader.load()` and `convert_text_resources_to_binary`

Open Beginner friendly
#12,127 0 comments 2 reactions 0 assignees View on GitHub
area:class reference bug
Dominant language
reStructuredText
Stars
5.7k
Forks
3.8k
Avg merge
1d 20h
Merged PRs (30d)
25

Description

**Your Godot version:**
v4.7.stable.official [5b4e0cb0f]

**Issue description:**
The documentation for [convert_text_resources_to_binary](https://docs.godotengine.org/en/stable/classes/class_projectsettings.html#class-projectsettings-property-editor-export-convert-text-resources-to-binary) states:
> Note: Because a resource's file extension may change in an exported project, it is heavily recommended to use [@GDScript.load()](https://docs.godotengine.org/en/stable/classes/class_%40gdscript.html#class-gdscript-method-load) or [ResourceLoader](https://docs.godotengine.org/en/stable/classes/class_resourceloader.html#class-resourceloader) instead of [FileAccess](https://docs.godotengine.org/en/stable/classes/class_fileaccess.html#class-fileaccess) to load resources dynamically.

However, both [@GDScript.load()](https://docs.godotengine.org/en/stable/classes/class_%40gdscript.html#class-gdscript-method-load) and [ResourceLoader.load()](https://docs.godotengine.org/en/stable/classes/class_resourceloader.html#class-resourceloader-method-load) state:

> Note: If [ProjectSettings.editor/export/convert_text_resources_to_binary](https://docs.godotengine.org/en/stable/classes/class_projectsettings.html#class-projectsettings-property-editor-export-convert-text-resources-to-binary) is true, [@GDScript.load()](https://docs.godotengine.org/en/stable/classes/class_%40gdscript.html#class-gdscript-method-load) will not be able to read converted files in an exported project. If you rely on run-time loading of files present within the PCK, set [ProjectSettings.editor/export/convert_text_resources_to_binary](https://docs.godotengine.org/en/stable/classes/class_projectsettings.html#class-projectsettings-property-editor-export-convert-text-resources-to-binary) to false.

**URL to the documentation page:**
- https://docs.godotengine.org/en/stable/classes/class_projectsettings.html#class-projectsettings-property-editor-export-convert-text-resources-to-binary
- https://docs.godotengine.org/en/stable/classes/class_resourceloader.html#class-resourceloader-method-load
- https://docs.godotengine.org/en/stable/classes/class_%40gdscript.html#class-gdscript-method-load

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the three linked documentation entries for convert_text_resources_to_binary, @GDScript.load(), and ResourceLoader.load(), and compare their notes about converted resources in exported projects. Determine the consistent guidance and update the affected documentation so the setting and runtime-loading behavior are described without contradiction; verify the rendered links and wording.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.