microsoft / mixed-reality-extension-sdk-samples

Sample code for the Mixed Reality Extension SDK (https://github.com/Microsoft/mixed-reality-extension-sdk)
MIT License
92 stars 82 forks source link

Steps in 'How to Build and Run the Hello World sample' section seems not up to date #82

Open rafalkarp opened 3 years ago

rafalkarp commented 3 years ago

Hello,

I was following instructions in 'How to Build and Run the Hello World sample' section and found out that few steps are a little bit vague and seems like they are not up to date. Currently (10.05.2021) steps look like:

...
In AltspaceVR
- Go to your personal home
- Make sure you are signed in properly, not a guest
- Activate the Space Editor (only available if you indicate you want to participate in the Early Access Program in your AltspaceVR settings)
- Click Basics group
- Click on SDKApp
- For the URL field, enter ws://localhost:3901
- Enter a session ID (This step will eventually be optional. For now, put in any random value)
- Click Confirm
- If the app doesn't seem to load, click on the gear icon next the MRE object in to the present objects list, and make sure "Is Playing" is checked.
- After the app has been placed, you will see the MRE Anchor (the white box with red/green/blue spikes on it), rendering on top of the MRE. You can use the anchor to move the MRE around. To hide the anchor, uncheck "Edit Mode".

I was not able to find 'Basics group' and step before to 'Activate the Space Editor' wasn't clear too.

I was able to run Hello-world sample and I propose to update instruction with steps below

...
In AltspaceVR
- Go to your personal home
- Make sure you are signed in properly, not a guest
- Activate the Space Editor (only available if you indicate you want to participate in the Early Access Program in your AltspaceVR settings, general section)
- Enter any world (for example go to 'Worlds' in Main menu and in a 'My worlds' tab select your own world)
- Inside the world press right mouse button and choose 'World editor'
- Click on SDKApp
- For the URL field, enter ws://localhost:3901
- Enter a session ID (This step will eventually be optional. For now, put in any random value)
- Click Confirm
- If the app doesn't seem to load, click on the gear icon next the MRE object in to the present objects list, and make sure "Is Playing" is checked.
- After the app has been placed, you will see the MRE Anchor (the white box with red/green/blue spikes on it), rendering on top of the MRE. You can use the anchor to move the MRE around. To hide the anchor, uncheck "Edit Mode".

This is just a suggestion, as it wasn't obvious for me how to trigger it. Please feel free to rephrase what I wrote or just change it totally. I was using AltspaceVR on desktop.