Skip to content

[Export] Add readable descriptions and validation warnings to the export options. - #74644

Merged
akien-mga merged 1 commit into
godotengine:masterfrom
bruvzg:export_opt_warn
Apr 19, 2023
Merged

[Export] Add readable descriptions and validation warnings to the export options.#74644
akien-mga merged 1 commit into
godotengine:masterfrom
bruvzg:export_opt_warn

Conversation

@bruvzg

@bruvzg bruvzg commented Mar 9, 2023

Copy link
Copy Markdown
Member

Adds an ability to dynamically validate and display warning for the export options.

Screenshot 2023-03-15 at 09 38 02

Adds more export option visibility checks (auto-hide irrelevant options).

Screen.Recording.2023-03-15.at.09.37.07.mov

Adds description tooltips and class reference pages (EditorExportPlatform*) for the export options.

Adds support for embedded provisioning profile (macOS).

Adds support for Installer PKG export format (macOS).

Adds export option to set macOS min. version (macOS).

Fixes godotengine/godot-proposals#6360
Fixes #73876
Fixes #74154

Supersede #74027
Supersede #49525
Supersede #73219

@Calinou

Calinou commented Mar 13, 2023

Copy link
Copy Markdown
Member

Does this use the class reference XML (which would allow for localization)? This is what I attempted in #49525.

@bruvzg

This comment was marked as outdated.

@bruvzg

bruvzg commented Mar 14, 2023

Copy link
Copy Markdown
Member Author

This is what I attempted in #49525.

Actually, this approach is probably better, changed it to use class ref. XMLs in a similar manner.

@bruvzg
bruvzg force-pushed the export_opt_warn branch 5 times, most recently from 3d8f049 to 3299639 Compare March 14, 2023 13:53
@bruvzg

bruvzg commented Mar 14, 2023

Copy link
Copy Markdown
Member Author

The list of Android permissions seems to be a mess. I have copy-pasted descriptions and added some links, but a lot of them are marked as deprecated or completely missing from the current Android documentation, so it's gonna need some extra work to clean up.

Also, I have not added any descriptions for OpenXR options and most of the Web export options, since I'm not sure what exactly these are doing.

@bruvzg
bruvzg marked this pull request as ready for review March 15, 2023 07:42
@bruvzg
bruvzg requested a review from a team as a code owner March 15, 2023 07:42
@bruvzg
bruvzg requested a review from a team March 15, 2023 07:42
@bruvzg
bruvzg requested review from a team as code owners March 15, 2023 07:42
@lostminds

Copy link
Copy Markdown

This feels like a great step in the right direction, good job! If this supersedes #74027 and has a wider scope, would it be possible to add the minOS version field for iOS export as well, to cover the entire godotengine/godot-proposals#6360 ?

Comment thread platform/android/export/export_plugin.cpp Outdated

@m4gr3d m4gr3d left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Android section looks good!

Comment thread doc/classes/EditorExportPlatformWindows.xml Outdated
Comment thread doc/classes/EditorExportPlatformAndroid.xml Outdated
Comment thread doc/classes/EditorExportPlatformLinuxBSD.xml Outdated
Comment thread doc/classes/EditorExportPlatformLinuxBSD.xml Outdated
Comment thread doc/classes/EditorExportPlatformMacOS.xml Outdated
Comment thread doc/classes/EditorExportPlatformMacOS.xml Outdated
Comment thread doc/classes/EditorExportPlatformWindows.xml Outdated

@akien-mga akien-mga left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's really amazing work. It's so cool to have all this documented.

Haven't reviewed the docs in depth beyond quick style comments, but the code looks great, and the docs seem quite thorough too.

It's outside the scope of this PR, but now that platform-specific classes are being registered, we might need to find a way to let them host their XML files in their platform folder, like we do for modules. It's not necessarily needed for platforms in core, but it would be needed for non-upstream platforms (e.g. console ports) so they can provide their docs easily.

@Calinou Calinou left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great!

Note for others: I'll be documenting all properties I can in a future PR after this is merged.

@akien-mga akien-mga modified the milestones: 4.x, 4.1 Apr 19, 2023
@akien-mga
akien-mga merged commit 00bb482 into godotengine:master Apr 19, 2023
@akien-mga

Copy link
Copy Markdown
Member

Thanks!

@bruvzg
bruvzg deleted the export_opt_warn branch April 19, 2023 09:24
@bruvzg

bruvzg commented Apr 19, 2023

Copy link
Copy Markdown
Member Author

It's outside the scope of this PR, but now that platform-specific classes are being registered, we might need to find a way to let them host their XML files in their platform folder, like we do for modules. It's not necessarily needed for platforms in core, but it would be needed for non-upstream platforms (e.g. console ports) so they can provide their docs easily.

Done - https://github.com/godotengine/godot/pull/76251

BendyLand pushed a commit to BendyLand/voltaire that referenced this pull request Aug 2, 2026
[Export] Add readable descriptions and validation warnings to the export options.
BendyLand pushed a commit to BendyLand/voltaire that referenced this pull request Aug 2, 2026
[Export] Add readable descriptions and validation warnings to the export options.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

5 participants