feat(extension): Rename launcher buttons for clarity #1872

acastrodev · 2023-09-30T21:05:33Z

PR Details

Update launcher extension button labels
New labels: "Visual Studio Shader {0} Extensions"
Add link under VisualStudioExtension label: "An installed Visual Studio is required, which can be found here"

Description

This commit addresses the issue of misleading launcher extension button labels, making it clearer that users are installing an extension, not the IDE itself. The new labels and added clarification help redirect users to the Visual Studio download page to avoid confusion.

Related Issue

Resolves: #1773

Motivation and Context

Improves Launcher UX

No Visual Studio 2019 or 2022 found (hovering over the link shows the tooltip in the bottom part of the screen with the Visual Studio download page URL):

When one or another is found:

Types of changes

Docs change / refactoring / dependency upgrade
Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)

Checklist

My change requires a change to the documentation.
I have added tests to cover my changes.
All new and existing tests passed.

- Update launcher extension button labels - New labels: "Visual Studio Shader addons" - Add link under VisualStudioExtension label: "An installed Visual Studio is required, which can be found here" This commit addresses the issue of misleading launcher extension button labels, making it clearer that users are installing an extension, not the IDE itself. The new labels and added clarification help redirect users to the Visual Studio download page to avoid confusion.

acastrodev · 2023-09-30T21:08:08Z

@Doprez I closed the #1862 and recreated it here using a topic branch (the other was blocking my master). :)

MeharDT · 2023-10-02T22:04:27Z

Can we only show the message if Visual Studio isn't installed? There's an example of how to detect an installation here,

stride/sources/assets/Stride.Core.Assets/PackageSessionPublicHelper.cs

Line 33 in 02f6a1e

public static void FindAndSetMSBuildVersion()

The VS requirements also change by Stride version (i.e., VS 2022 is only needed for Stride 4.1+). We might have to re-word the message to get this across.

acastrodev · 2023-10-02T22:07:31Z

Thanks, @MeharDT! I will take a look on it.

acastrodev · 2023-10-03T19:08:53Z

I'm facing a dilemma and would appreciate your input on it:

We currently have a class called PackageSessionPublicHelper that contains logic for detecting Visual Studio instances. I'd like to centralize this logic within PackageSessionPublicHelper and use the same class in the Strider.Launcher project. However, there's a challenge: PackageSessionPublicHelper resides in the Stride.Core.Assets project, which is not part of the Strider.Launcher solution. In my opinion, we have two potential solutions:

Move PackageSessionPublicHelper from the Stride.Core.Assets project to the Stride.Core project, making it accessible to both the Stride and Strider.Launcher solutions.
Keep PackageSessionPublicHelper in the Stride.Core.Assets project and create a different helper class within the Strider.Launcher project to handle the same logic.

What would you suggest we do in this situation?

Thank you!

MeharDT · 2023-10-03T19:47:04Z

Hi @acastrodev, I think option 1 makes the most amount of sense to me but this might have to be a discussion for the next community meeting.

Another option, can this PR idea be merged into the existing FindAndSetMSBuildVersion() check? When launching Stride it looks for a VS and .NET install and throws an exception if either are missing (the user isn't told what is missing and is only shown a generic error with download links for both).

stride/sources/editor/Stride.GameStudio/Program.cs

Line 221 in 025e30d

private static async void Startup(UFile initialSessionPath)

acastrodev · 2023-10-03T19:58:02Z

Hi @MeharDT,

Thank you for your input! I agree that option 1 seems like the approach to go, and discussing it in the next community meeting sounds like a good idea to ensure everyone's alignment.

Regarding your suggestion to merge this PR idea into the existing FindAndSetMSBuildVersion() check, it's an interesting thought. It could potentially simplify the logic and improve the user experience by providing more specific error messages. I would say, we could definitely consider that as an option.

manio143 · 2023-10-03T20:57:26Z

Note that PackageSessionPublicHelper has a dependency on Microsoft.Build. If you move it to Stride.Core it means every game created has a runtime dependency on MSBuild.
I think it would be better to create a new project which would contain abstraction over MSBuild that can be shared between Stride.Core.Assets and the launcher without impacting user runtime dependencies.

acastrodev · 2023-10-03T21:24:37Z

Thank you, @manio143. I'll consider your point about the MSBuild dependency. Creating a new project for the MSBuild abstraction sounds like a good approach to avoid impacting dependencies. I'll explore this option further and update this PR. Appreciate your insight!

acastrodev · 2023-10-04T16:08:40Z

Following up the idea to extract this logic for a new project, my understanding is that it can live under Stride.Core. instead of Stride.Core.Assets.

Assuming Stride.Core. is the way to go, I have some suggestions to name this project as follows:

1 - Stride.Core.Build.Locator (in the same way as Microsoft assembly name Microsoft.Build.Locator)
2 - Stride.Core.Build (More generalist. We can use Stride.Core.Build.Locator namespace anyway)
3 - Stride.Core.MSBuild (Straightforward to make clear it is Microsoft MSBuild related)
4 - Stride.Core.MSBuild.Locator (same as the first option but more specific)

@manio143 and others, please let me know what are your ideas around that. Thanks!

Ethereal77 · 2023-10-04T16:31:42Z

Please note that, in the solution, Stride.Core and related "core" assemblies are implementing common functionality for the "runtime" (i.e. the engine, graphics, physics, etc), while Stride.Core.Design and related "design" assemblies are implementing common functionality for the tooling and editor parts.

This one is more appropriately placed under the "design-time" part. The naming could be whatever is better for legibility, but it must be in the correct category to avoid confusion.

acastrodev · 2023-10-04T16:40:11Z

Thanks for the feedback @Ethereal77. I see now we already have a class inside Stride.Core.Design for this purpose — to check Visual Studio versions installed (VisualStudioVersions). So, no big changes required. I will update this PR.

In LauncherWindow.xaml.cs: - Added a Loaded event handler method TextBlockVisualStudioDownloadPage_Loaded to handle the loading of the TextBlock displaying Visual Studio download information. - Implemented logic to check for compatible Visual Studio versions and hide the TextBlock if compatible versions are found. In LauncherWindow.xaml: - Added the Loaded event handler TextBlockVisualStudioDownloadPage_Loaded to the TextBlock element responsible for displaying Visual Studio download information. This change improves the user experience by dynamically hiding the Visual Studio download information TextBlock when compatible versions are detected, providing a cleaner interface.

manio143

Cool, so the dependencies were already referenced. Good job!

MeharDT · 2023-10-04T22:28:28Z

Nice work, well done @acastrodev!

Is there a way to see which version of Stride is actively selected in the launcher? Since you're checking for either VS 2019 or 2022, maybe the text that's displayed could reflect that? As an example if Stride 4.1 is selected it could say something like,

A valid Visual Studio 2022 installation could not be found. Download Now (hyperlink)

For Stride 4.0 and below it would be 2019

acastrodev · 2023-10-06T10:00:20Z

Nice work, well done @acastrodev!

Is there a way to see which version of Stride is actively selected in the launcher? Since you're checking for either VS 2019 or 2022, maybe the text that's displayed could reflect that? As an example if Stride 4.1 is selected it could say something like,

A valid Visual Studio 2022 installation could not be found. Download Now (hyperlink)

For Stride 4.0 and below it would be 2019

Thanks, @MeharDT! And thanks for the feedback!

I trust it is possible, although, if we follow the prerequisites from README it mentions Visual Studio 2022 only. If we are going to explicit offer a link with a wording based in the selected Stride version, I would say we should also need to update the README to reflect it.

Another option is to include "2022" straight ahead in the current wording, being aligned with README instructions.

MeharDT · 2023-10-06T16:02:19Z

Nice work, well done @acastrodev!
Is there a way to see which version of Stride is actively selected in the launcher? Since you're checking for either VS 2019 or 2022, maybe the text that's displayed could reflect that? As an example if Stride 4.1 is selected it could say something like,
A valid Visual Studio 2022 installation could not be found. Download Now (hyperlink)
For Stride 4.0 and below it would be 2019

Thanks, @MeharDT! And thanks for the feedback!

I trust it is possible, although, if we follow the prerequisites from README it mentions Visual Studio 2022 only. If we are going to explicit offer a link with a wording based in the selected Stride version, I would say we should also need to update the README to reflect it.

Another option is to include "2022" straight ahead in the current wording, being aligned with README instructions.

Fair enough, I only mentioned 2019 because of the extension but lets stick to 2022 since it's current for 4.1 and 4.2 (soon).

Eideren · 2023-10-16T22:30:31Z

Thanks !

Merge branch 'master' into topic/acastrodev/1773

01a84f6

acastrodev added 2 commits October 4, 2023 19:46

Update capitalizaton in "Visual Studio {0} extension"

f7efa24

manio143 approved these changes Oct 4, 2023

View reviewed changes

MeharDT mentioned this pull request Oct 5, 2023

[Installer] Stride Installer fails to install required .NET Runtimes/SDKs #1883

Open

Eideren merged commit cee7491 into stride3d:master Oct 16, 2023
1 check passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(extension): Rename launcher buttons for clarity #1872

feat(extension): Rename launcher buttons for clarity #1872

acastrodev commented Sep 30, 2023 •

edited

acastrodev commented Sep 30, 2023

MeharDT commented Oct 2, 2023

acastrodev commented Oct 2, 2023

acastrodev commented Oct 3, 2023

MeharDT commented Oct 3, 2023

acastrodev commented Oct 3, 2023

manio143 commented Oct 3, 2023

acastrodev commented Oct 3, 2023 •

edited

acastrodev commented Oct 4, 2023 •

edited

Ethereal77 commented Oct 4, 2023

acastrodev commented Oct 4, 2023 •

edited

manio143 left a comment

MeharDT commented Oct 4, 2023

acastrodev commented Oct 6, 2023

MeharDT commented Oct 6, 2023

Eideren commented Oct 16, 2023

feat(extension): Rename launcher buttons for clarity #1872

feat(extension): Rename launcher buttons for clarity #1872

Conversation

acastrodev commented Sep 30, 2023 • edited

PR Details

Description

Related Issue

Motivation and Context

Types of changes

Checklist

acastrodev commented Sep 30, 2023

MeharDT commented Oct 2, 2023

acastrodev commented Oct 2, 2023

acastrodev commented Oct 3, 2023

MeharDT commented Oct 3, 2023

acastrodev commented Oct 3, 2023

manio143 commented Oct 3, 2023

acastrodev commented Oct 3, 2023 • edited

acastrodev commented Oct 4, 2023 • edited

Ethereal77 commented Oct 4, 2023

acastrodev commented Oct 4, 2023 • edited

manio143 left a comment

Choose a reason for hiding this comment

MeharDT commented Oct 4, 2023

acastrodev commented Oct 6, 2023

MeharDT commented Oct 6, 2023

Eideren commented Oct 16, 2023

acastrodev commented Sep 30, 2023 •

edited

acastrodev commented Oct 3, 2023 •

edited

acastrodev commented Oct 4, 2023 •

edited

acastrodev commented Oct 4, 2023 •

edited