search

vrchat-community / creator-docs

7 stars 77 forks source link

Helpful Tip for setting Reflect Layers, added note for Environment Layer. #160

Closed BluWizard10 closed 3 months ago

BluWizard10 commented 6 months ago

This is just a minor change that adds a few improvements to the World Creation Documentation.

Do keep in mind that this was built up from commit 8b3a17b5893752bd9985bfd5c612f7fe1d870a25, which synced from the Upstream Repo by Momo. So I made sure that all recent information added by Momo are still in here.

oneVR commented 6 months ago

I don't really agree with the wording ONLY here for the mirror layers. It would be better to tell people to only have the layers they need enabled instead and have an example of the most important layers Player and MirrorReflection. Default can be debatable as it'll depend on if the creator leaves their world geometry on it or moves it to another layer like Environment or one of the unused layers. What VRWorld Toolkit sets is meant as the minimal layer setup from which the creator can customize if they want to or need to and is just to discourage leaving all layers enabled when that is rarely a good thing.

please note that this is not an official answer as I do not maintain this documentation and only my personal opinion on the matter

BluWizard10 commented 6 months ago

@oneVR You make a fair point. I was debating between what I had vs what you were saying.

But I too think it would probably be better to say what the important layers are (as you said) and only suggest to the user to decide if Default should be ignored or shown.

BluWizard10 commented 6 months ago

@oneVR Would these recent commits I just pushed sound better? I thought about your comment and made adjustments.

oneVR commented 6 months ago

@BluWizard10 I personally feel like just a tip callout like this would be better:

For performance, having the least amount of layers set on a mirror is recommended, as anything shown in mirrors needs to be rendered twice. For minimal layer setup, MirrorReflection is required to see the local player, and Player is required to see other players. Any other layers should be considered based on how your world is set up and what you want to be visible in the mirror, such as pickups and the environment.

BluWizard10 commented 6 months ago

@BluWizard10 I personally feel like just a tip callout like this would be better:

For performance, having the least amount of layers set on a mirror is recommended, as anything shown in mirrors needs to be rendered twice. For minimal layer setup, MirrorReflection is required to see the local player, and Player is required to see other players. Any other layers should be considered based on how your world is set up and what you want to be visible in the mirror, such as pickups and the environment.

I appreciate the suggestion, @oneVR. I've reworded it based on your suggestion. Let me know what you think!

I also added a link in the Tip Callout leading to layers.md, so that the reader can learn about what each Reflect Layer is used for.

Faxmashine commented 6 months ago

Thank you for suggesting these changes! I think your base branch might be out of date - I'm seeing changes in the Changes tab that probably shouldn't be there 🤔

BluWizard10 commented 6 months ago

Thank you for suggesting these changes!

I think your base branch might be out of date - I'm seeing changes in the Changes tab that probably shouldn't be there 🤔

@Faxmashine I think that might be a result of multiple Branches that have been merged lately. This PR is based off of PR #158 because the main branch was clearly not up-to-date to what it's was right now internally at the time.

BluWizard10 commented 3 months ago

Closing this because GitHub seems to be giving me a lot of problems. I'll create a fresh new fork.