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

Adding docs and how-to #94

Open
De-Panther opened this issue Nov 28, 2020 · 6 comments
Open

Adding docs and how-to #94

De-Panther opened this issue Nov 28, 2020 · 6 comments
Assignees
Labels
documentation Improvements or additions to documentation
Projects

Comments

@De-Panther
Copy link
Owner

There are no docs and tutorials about the different components and how to start a project or import the packages.

I think that creating a general docs folder at the root of the repo, and link from docs folders of the packages would be easier to maintain.

@De-Panther De-Panther added the documentation Improvements or additions to documentation label Nov 28, 2020
@De-Panther De-Panther self-assigned this Nov 28, 2020
@De-Panther De-Panther added this to To do in General via automation Nov 28, 2020
@HawkenKing
Copy link

HawkenKing commented Dec 10, 2020

I'm having trouble accessing the WebXR namespace from scripts inside /Assets/

Would be good to get a guide on this.

Assets/myproject/PlayerController.cs(4,7): error CS0246: The type or namespace name 'WebXR' could not be found (are you missing a using directive or an assembly reference?)

with

using System.Collections.Generic;
using UnityEngine;
using WebXR.Interactions;

public class PlayerController : MonoBehaviour
{
    public WebXRController leftController;
    public WebXRController rightController;

}```

@De-Panther
Copy link
Owner Author

If you are using VSCode, it might be related to the VSCode package version, updating it to 1.2.3 (or up) should solve your issue.
It's a Unity bug, so I don't think that we should have a doc for it. You will get the same error for trying to use UnityEngine.UI.

@De-Panther
Copy link
Owner Author

Your issue might also be related to the use of .asmdef file. And while it's Unity related issue, this is something that should be in the docs. Thanks!
For now, developers who also has similar issue, I made a video tutorial about this - https://youtu.be/N9iACzNCnos

@HawkenKing
Copy link

ah yes can confirm this, all working now

@TheXRMonk
Copy link

TheXRMonk commented Apr 9, 2021

Adding to this, it would be really nice to have some more in-code comments in general. Especially on the functions and events in WebXRManager.
For instance, I can't really wrap my head around the ViewerHitTest state. Guess it's related to this? And the XRChange event? what are those parameters? :octocat:

Ah, just realized you are moving the cameras rather than the objects during hittest-updates. Guess that's because of static bathing optimization 👍

@De-Panther
Copy link
Owner Author

Yes, should add more comments. Would be happy if others would be able to help with that.

Regarding the ViewerHitTest, you can check the WebXR Interactions package for SceneHitTest which is one way to use it.

@De-Panther De-Panther moved this from To do to In progress in General Nov 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
General
  
In progress
Development

No branches or pull requests

3 participants