-
-
Notifications
You must be signed in to change notification settings - Fork 21.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Export] Add readable descriptions and validation warnings to the export options. #74644
Conversation
Does this use the class reference XML (which would allow for localization)? This is what I attempted in #49525. |
This comment was marked as outdated.
This comment was marked as outdated.
Actually, this approach is probably better, changed it to use class ref. XMLs in a similar manner. |
3d8f049
to
3299639
Compare
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. |
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 ? |
There was a problem hiding this comment.
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!
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
Thanks! |
Done - https://github.com/godotengine/godot/pull/76251 |
Adds an ability to dynamically validate and display warning for the export options.
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