godotengine / godot-proposals

Godot Improvement Proposals (GIPs)
MIT License
1.1k stars 69 forks source link

Use TextFile resource in exported project #10227

Open L2750558108 opened 1 month ago

L2750558108 commented 1 month ago

Describe the project you are working on

Use TextFile resource in exported project

Describe the problem or limitation you are having in your project

I found there are some hard codes to ignore TextFile resource type when export project. This prevent user to use TextFile to keep informations in exported project. This are something I can do to make TextFile a normal resource that can use in exported project. Anyway, hard codes here is little stupid. Even if it have to make the TextFile type editor-only, it should be some ways better.

Describe the feature / enhancement and how it helps to overcome the problem or limitation

N/A

Describe how your proposal will work, with code, pseudo-code, mock-ups, and/or diagrams

Change source code to remove hard codes and handle it as normal resource. If this proposal is accepted, there is a PR I have done

If this enhancement will not be used often, can it be worked around with a few lines of script?

This is a source code problem.

Is there a reason why this should be core and not an add-on in the asset library?

This is a source code problem.

AThousandShips commented 1 month ago

You just have to enable them, as per the documentation

They should be ignored by default IMO, and they are trivial to enable if you do want them

L2750558108 commented 1 month ago

The hardcoded exclusion introduced a confusing situation to user: the resource is imported in file system but can't be loaded as a text file resource. Therefore, text file extensions setting should be a project setting entry. TextFile should be exposed, and any file imported as text file should be exported and can be loaded in the game.

Calinou commented 1 month ago

It's common for projects to include documentation in the form of Markdown files, plain text files and so on. If these are exported automatically by default, this could potentially leak sensitive information (such as design documents) when exporting a project.