Make build profile project detection also set build options

[YeldhamDev]

Currently, the build profile editor only updates the used classes when attempting to detect from the project. This PR makes so that the other settings are also updated from the project information with the following.

• Checking project settings.
• Checking classes that require them.
• And last but definitely not least, import settings. This one required me to add an extra functionality called get_build_dependencies(), that works like get_classes_used() but is geared towards resource importers. And just like the latter, the former is also exposed to scripting.

However, that are a couple of build options that I couldn't find a way to detect, because as far as I'm aware, there are no settings that could imply if the project is using them or not:

• X11/Wayland
• SIL Graphite Fonts

This PR also fixes some issues necessary to make the feature to work properly:

• Fix error when scanning resource files.
• Fix loading profile files doing nothing.
• Hardcode some classes that are necessary for the engine to function.

Sponsored By: 🐺 Lone Wolf Technology / 🍀 W4 Games.

[deralmas]

X11/Wayland.

Isn't there a platform-specific display driver option somewhere in the project settings? I think you could use that to at least add the default driver. Although arguably it would make more sense to keep both by default I think, from a compatibility perspective.

[YeldhamDev]

@Riteo Yep, missed that setting. If it's set to default, both are now selected, otherwise, it will be the one you picked.

[YeldhamDev]

This PR is ready for review.

[Calinou]

That's not right, it manages to find GridMap on my end. Are you deleting the cache before re-detecting?

It works after removing .godot/ 🙂
The project works just fine with the custom build profile now.

These messages are still printed on startup though:

WARNING: Property not found: 'editor/movie_writer/mix_rate'.
     at: get_setting_with_override (core/config/project_settings.cpp:405)
WARNING: Property not found: 'editor/movie_writer/speaker_mode'.
     at: get_setting_with_override (core/config/project_settings.cpp:405)
WARNING: Property not found: 'editor/movie_writer/mjpeg_quality'.
     at: get_setting_with_override (core/config/project_settings.cpp:405)

[YeldhamDev]

Silenced, try again.

[Calinou]

Works great now!

[Calinou]

While doing further testing, I found an issue on the gui/control_gallery demo. After compiling with the autodetected profile, I get this:

ERROR: In Object of type 'TabBar': Attempt to connect nonexistent signal 'mouse_exited' to callable ''.
   at: connect (core/object/object.cpp:1454)
WARNING: Property not found: 'gui/common/default_scroll_deadzone'.
     at: get_setting_with_override (core/config/project_settings.cpp:405)

Build profile: pr.gdbuild.zip

[YeldhamDev]

@Calinou The PR has been updated with the following:

• Improved the extraction of classes from binary scene files. This removes the need for Skin to be hardcoded.
• Added ADD_CLASS_DEPENDENCY(). This is used inside _bind_methods() so classes can mark if they depend on other classes being registered. This fixes the error with TabBar.
• Removed the logic to toggle advanced GUI in the build profile, as stated by Akien, that was made before this feature existed, and it's kinda redundant now.

@AThousandShips Changes made.

[Calinou]

Tested again, it works as expected. The Control Gallery demo now generates the profile correctly.

I get a warning when running that demo with a compiled export template that uses the detected profile:

WARNING: Property not found: 'gui/common/default_scroll_deadzone'.
     at: get_setting_with_override (core/config/project_settings.cpp:404)

While rebasing on master, to account for the conflict generated by 55dd5d5, I chose to kept current changes only (i.e. what's in master). It performs the check slightly differently, since it checks each MovieWriter individually (which makes more sense to me). It seems to work fine.

[akien-mga]

I tested the PR on the 2D platformer demo: https://github.com/godotengine/godot-demo-projects/tree/master/2d/platformer

The auto-detection works relatively well, but the Window class is wrongly disabled, so the one script fails parsing:

SCRIPT ERROR: Parse Error: Native class Window used in script doesn't exist or isn't exposed. [tmp_js_export.js:477:18](http://localhost:8060/tmp_js_export.js)
   at: GDScript::reload (res://game.gd:16)

Since the root node is of type Window, I believe Window should never be disabled?

Surprisingly, with Window disabled, the 2D platformer demo does work fine though. Only the functionality from the Game script (fullscreen and pause toggles) is broken.

---

Tested on another project of mine: https://github.com/johncoffee/ngj-2024/

There it works well, Window is kept because some thirdparty asset uses some Dialogs.

Comparison of a Web release template compiled with scons p=web target=template_release production=yes lto=none (disabling LTO as for Clang is actually increases binary size), and the profile build with build_profile generated from this PR.

-rw-r--r--.  1 akien akien 8.6M May 19 15:48 godot.web.template_release.wasm32.master.zip
-rw-r--r--.  1 akien akien 5.9M May 19 16:01 godot.web.template_release.wasm32.profile.zip
-rw-r--r--.  1 akien akien 5.2M May 19 16:21 godot.web.template_release.wasm32.profile_manual.zip

So there's 31% size reduction from using the build profile.

profile_manual is a custom profile based on the generated one, removing more stuff not needed for my Web export:

• Navigation2D - not sure why this one wasn't detected as unused
• TextServerAdvanced - using Fallback instead, WOFF2 fonts, SIL Graphite fonts
• Node3D and AcceptDialog - those were kept due to an addon, but the scene is unused

[akien-mga]

Did a code review pass, looks pretty good overall.

Let's finalize this and get it merged :D

[akien-mga]

Is this dependency correct? I think you can use TTF/OTF dynamic fonts with TextServerFallback.

CC @bruvzg

[Calinou]

Yes, TextServerFallback supports all font file formats that TextServerAdvanced does. Specific font features may not work though.

In general, using TextServerFallback will introduce various subtle differences to behavior (e.g. #105497 (comment)). This means detecting whether we need TextServerAdvanced automatically is difficult. Even if you don't have any RTL language translations in your project, you may still be relying on OpenType features, variable fonts, and so on.

[bruvzg]

Indeed, TextServerFallback support all font formats TextServerAdvanced does. But OpenType font features (like variations) are not supported.

[bruvzg]

The opposite is also true, TextServerAdvanced can support RTL/BiDi with bitmap fonts. So it might be something like BUILD_OPTION_COMPLEX_TEXT_LAYOUTS, but not dynamic fonts.

[akien-mga]

FYI @godotengine/dotnet - would be good to implement as a follow-up.

[YeldhamDev]

Oh believe me, I tried, and it's currently not possible in a way that makes it worth it. You can ask @raulsntos for more details.

[akien-mga]

How do you determine which classes should be added as dependencies?

I see color_picker.cpp has an internal LineEdit but there's also e.g. SpinBox, HSlider, etc.

Is this a requirement only when signals are used?

[YeldhamDev]

Is this a requirement only when signals are used?

Seems so, as connecting signals require the class to be registered.

[akien-mga]

FYI @KoBeWi. I wonder if we could find a more elegant way to do this so we don't need to hardcode such list only for internal classes that have signal connections.

It's fine for now for this PR though.

[akien-mga]

Looks great to me!
The configuration system isn't perfect yet but this is much better than what was before, and we can build upon it.

I have a couple minor outstanding comments but this should be good to merge soon.

[Repiteo]

Thanks!