Skip to content
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

Update UID upgrade tool dialog message #103468

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

adamscott
Copy link
Member

@adamscott adamscott commented Mar 2, 2025

Note

The new wording reads:

As of Godot 4.4, scenes and resources use UIDs to reference scripts and shaders. Upgrades apply on the next save of each scene/resource.

To save time, this tool can open and save each of these files. Depending on the project size, it may take several minutes.

This PR clarifies what the tool does and reduce greatly the verbosity of it. This also adds a (missing) title to the dialog.

Before After
image image

Fixes #103066

@adamscott adamscott force-pushed the update-uid-upgrade-tool branch from 3325696 to 52e6e17 Compare March 2, 2025 19:30
@adamscott adamscott force-pushed the update-uid-upgrade-tool branch from 52e6e17 to 7c78025 Compare March 2, 2025 19:31
@adamscott
Copy link
Member Author

The new wording reads:

As of Godot 4.4, scenes and resources use UIDs to reference scripts and shaders. Upgrades apply on the next save of each scene/resource.

To save time, this tool can open and save each of these files. Depending on the project size, it may take several minutes.

@KoBeWi
Copy link
Member

KoBeWi commented Mar 2, 2025

The new message is fine, but the change will erase all translations for this dialog.

@akien-mga
Copy link
Member

Yeah this would invalidate translations for all these languages:

$ rg -g'*.po' --sort=path "As of Godot 4.4," -l
translations/editor/cs.po
translations/editor/es.po
translations/editor/fr.po
translations/editor/ja.po
translations/editor/pl.po
translations/editor/uk.po
translations/editor/zh_CN.po

Since this is a dialog all users would see, I think breaking translations just before the stable release isn't a good idea.

IIUC the main issue fixed here is that the "Note:" advising to make a backup is wrong as it's already too late at this stage. So I'll make an alternative that just removes that note and edit the translations manually to drop their last paragraph.

@akien-mga
Copy link
Member

Actually I don't think this is improving things that much, and won't solve #103066, just might reduce a tiny bit of the wrong expectation.

It removes some important information that .uid files are not optional and shouldn't be gitignore'd for example.

@adamscott
Copy link
Member Author

It removes some important information that .uid files are not optional and shouldn't be gitignore'd for example.

It is not the responsibility of the tool, IMHO. The tool just exists to save existing resources, not prevent the upgrade.

@KoBeWi
Copy link
Member

KoBeWi commented Mar 2, 2025

btw I have a PR that completely replaces the dialog: #103044

@akien-mga
Copy link
Member

It removes some important information that .uid files are not optional and shouldn't be gitignore'd for example.

It is not the responsibility of the tool, IMHO. The tool just exists to save existing resources, not prevent the upgrade.

Well as it stands this dialog does two things:

  • Inform users about UIDs. There's even a "Learn More" button that should point to more information about that change in 4.4.
  • Offer running a tool that updates everything to use UIDs.

I think both are important first-time user information, though I agree the UX and wording aren't the best.

@adamscott
Copy link
Member Author

It removes some important information that .uid files are not optional and shouldn't be gitignore'd for example.

It is not the responsibility of the tool, IMHO. The tool just exists to save existing resources, not prevent the upgrade.

Well as it stands this dialog does two things:

* Inform users about UIDs. There's even a "Learn More" button that should point to more information about that change in 4.4.

* Offer running a tool that updates everything to use UIDs.

I think both are important first-time user information, though I agree the UX and wording aren't the best.

Yes, I totally agree. The first is to explain the second, where the latter is the main focus of the popup. Where I disagree is about advising users to not add their .uid files to .gitignore, as it doesn't have anything to do with the second point, ie. the main idea behind the popup.

@lyuma
Copy link
Contributor

lyuma commented Mar 3, 2025

My worry is if you start explaining too much about UIDs in the upgrade dialog, and we have a cancel button, the users are going to say "oh this is too complicated, I don't want this UID stuff" and hit cancel, not knowing that the UIDs are there regardless and the dialog is just to facilitate the transition.

We could have some "What's new?" popup that just has an OK button and explains some of the changes related to UIDs.
But also, if a user sees a "what's new" dialog, they will probably mash OK without reading it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Clicking on "Cancel" when asked about UIDs update does not cancel anything
6 participants