Skip to content

feat: Dedicated Game Server sample - IETs expanded [MTT-11649] #279

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

Open
wants to merge 12 commits into
base: develop
Choose a base branch
from

Conversation

fernando-cortez
Copy link
Collaborator

@fernando-cortez fernando-cortez commented Mar 31, 2025

Description

This PR adds two In-Editor Tutorials to the project:

  1. Enabling Multiplayer Play Mode a project
  2. A Sample Tutorial - A walkthrough of how Content Selection is used in this project

Issue Number(s)

MTT-11649

Contribution checklist

  • [ N/A ] Tests have been added for the project and/or any internal package
  • [ N/A ] Release notes have been added to the project changelog file
  • Pull request has a meaningful description of its purpose
  • All commits are accompanied by meaningful commit messages
  • JIRA ticket ID is in the PR title or at least one commit message
  • Include the ticket ID number within the body message of the PR to create a hyperlink

@fernando-cortez fernando-cortez marked this pull request as ready for review April 1, 2025 00:14
@fernando-cortez fernando-cortez requested a review from a team as a code owner April 1, 2025 00:14
@sentinel-u3d sentinel-u3d bot requested a review from RikuTheFuffs April 1, 2025 08:50
@RikuTheFuffs
Copy link
Contributor

Is there a reason why we have 3 categories with only a single tutorial in each of them?
It makes navigation clunkyer than it needs to be. For example, what if the two "Configuration" tutorials were in a single "Configuration" category? Then the name of the tutorial is used to distinguish "what" you're configuring.

image

Comment on lines +59 to +65
m_Untranslated: "To open the Multiplayer Play Mode window: \n\n1. Go to
<b>Window</b> > <b>Multiplayer</b> > <b>Multiplayer Play Mode</b>.\n\n2.
Select the checkbox for Virtual Player 2. This player opens when you enter
Play mode.\n\n3. Wait for the Player status to change from inactive to
active for Virtual Player 2.\n\nWhen active, the Virtual Player(s) appear
in Play Mode in the main Editor Player window. A separate window opens
for each enabled Player with the Player name as the window title."
Copy link
Contributor

Choose a reason for hiding this comment

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

This page has 3 instructions in it ("open the window > enable a virtual player > wait and then press next"), which makes handholding difficult. In-Editor Tutorials are meant to be "step-by-step" and to validate that the user has done what you're asking them to do. I'd break down the "open MPPM" and "enable virtual player + wait" in two different pages.

Comment on lines +59 to +60
m_Untranslated: "To open the Multiplayer Play Mode window: \n\n1. Go to
<b>Window</b> > <b>Multiplayer</b> > <b>Multiplayer Play Mode</b>.\n\n2.
Copy link
Contributor

Choose a reason for hiding this comment

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

We are instructing the user to open MPPM, but the tutorial also opens it for us. If we guide the user, the tutorial window should not be open automatically and we should check, using IET's Criteria feature, that the user opened the window, and then autoadvance to the next tutorial page when they do.
If we don't guide the user, there's no point in adding "go to window, etc..." instructions.

m_TutorialButtonText:
- m_Type: 1
Title:
m_Untranslated: Create a Virtual Player
Copy link
Contributor

Choose a reason for hiding this comment

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

We do not "create" virtual players, we "enable" them.

Text:
m_Untranslated: "To open the Multiplayer Play Mode window: \n\n1. Go to
<b>Window</b> > <b>Multiplayer</b> > <b>Multiplayer Play Mode</b>.\n\n2.
Select the checkbox for Virtual Player 2. This player opens when you enter
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd recommend to use the same approach we used in the Anticipation sample (and described here ) to highlight a specific virtual player (4, in this case), instead of highlighting the entire window

image

i see that you figured out how to check if the checkbox of a player has been enabled, using IsVirtualPlayerCreated, which is very smart! (we'll have to implement that approach too in the Anticipation tutorial of Use Cases), but unfortunately we can't check the status (activating/inactive) of players (there's no API for it), so we'll have to ask the user to wait a bit.

You can recycle the copy from this tutorial:

image


Note: Virtual Players do not automatically deactivate
when you close the Virtual Player window. To deactivate a Virtual Player,
deselect the checkbox for the active Virtual Player.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggestion: isn't it "of the" instead of "for the"?



Continue
to the next tutorial to learn how to use Network Scene Visualization.'
Copy link
Contributor

Choose a reason for hiding this comment

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

Is "Network Scene Visualization" correct? The button says "Content selection"

image

m_TutorialButtonText:
- m_Type: 1
Title:
m_Untranslated: Multiplayer Virtual Player created successfully
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggestion: we can probably get rid of this sentence (it's implicit as you got here, and also the 1st paragraph mentions it) and directly put the "Select Done to exit this tutorial."

Base automatically changed from feat/dedicated-game-server-sample/iet-welcome-page to develop April 7, 2025 17:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants