From 763263baa4fe5ed342df8e818e3140e18915551e Mon Sep 17 00:00:00 2001 From: jingle chen <47862618+jinglechen2287@users.noreply.github.com> Date: Mon, 27 Jan 2025 17:19:55 -0500 Subject: [PATCH] Fix outdated info in docs (#5644) * Remove reference to Supermedium Browser * Remove references to aframe GUI tools * Update links to superhands component * Mark Supercraft as deprecated * Remove reference to an unavailable video * Update reference to oculus best practices * Update outdated links * Remove reference to mozvr * Update building-a-basic-scene.md --------- Co-authored-by: Diego Marcos --- docs/guides/building-a-basic-scene.md | 5 +-- docs/introduction/best-practices.md | 2 +- docs/introduction/faq.md | 10 ++++-- docs/introduction/hosting-and-publishing.md | 4 --- .../interactions-and-controllers.md | 7 ++-- docs/introduction/models.md | 6 ++-- .../visual-inspector-and-dev-tools.md | 36 +------------------ .../vr-headsets-and-webxr-browsers.md | 1 - 8 files changed, 16 insertions(+), 55 deletions(-) diff --git a/docs/guides/building-a-basic-scene.md b/docs/guides/building-a-basic-scene.md index 6247feb05ee..52abb4a024c 100644 --- a/docs/guides/building-a-basic-scene.md +++ b/docs/guides/building-a-basic-scene.md @@ -201,13 +201,10 @@ arrow keys. On mobile, we can pan the phone around to rotate the camera. Although A-Frame is tailored for WebVR, this default control scheme allows people to view scenes without a headset. -[mozvr]: http://mozvr.com/#start [webvrimage]: https://cloud.githubusercontent.com/assets/674727/20328949/69e2c628-ab4a-11e6-97e9-6e25104d6673.png ![webvrimage] -> [Check out the instructions on the Mozilla VR homepage for setting up and entering WebVR][mozvr]. - -Upon [entering VR][mozvr] by clicking the goggles icon with a VR headset +Upon entering VR by clicking the goggles icon with a VR headset connected (e.g., Oculus Rift, HTC Vive), we can experience the scene in immersive VR. If room-scale is available, we can physically *walk* around the scene! diff --git a/docs/introduction/best-practices.md b/docs/introduction/best-practices.md index 55aa74f4424..80f35971c8f 100644 --- a/docs/introduction/best-practices.md +++ b/docs/introduction/best-practices.md @@ -249,7 +249,7 @@ using `utils.throttleTick`][throttle] to run your code at less frequent interval ## VR Design -[oculus]: https://developer.oculus.com/design/latest/concepts/book-bp/ +[oculus]: https://developers.meta.com/horizon/resources/bp-overview/ Designing for VR is different than designing for flat experiences. As a new medium, there are new sets of best practices to follow, especially to maintain diff --git a/docs/introduction/faq.md b/docs/introduction/faq.md index b05f0cf61b4..160eaa17643 100644 --- a/docs/introduction/faq.md +++ b/docs/introduction/faq.md @@ -17,8 +17,8 @@ order: 14 ## How is A-Frame's performance? -[a-painter]: https://blog.mozvr.com/a-painter -[tiltbrush]: https://www.tiltbrush.com/ +[a-painter]: https://github.com/aframevr/a-painter/ +[tiltbrush]: https://github.com/icosa-foundation/open-brush A-Frame can achieve native-like latency and framerate with proper browsers (e.g., Firefox with WebVR). For example, [A-Painter][a-painter] is [Tilt @@ -143,12 +143,14 @@ is possible to overlay an ` - Though ee can also host the model the same as we serve all of our other assets, and let the server and CDN handle it. If we want a special place to host them, S3 is another option. diff --git a/docs/introduction/interactions-and-controllers.md b/docs/introduction/interactions-and-controllers.md index ed614c437ec..12e57f4618b 100644 --- a/docs/introduction/interactions-and-controllers.md +++ b/docs/introduction/interactions-and-controllers.md @@ -561,9 +561,8 @@ collision is detected. ### super-hands Component -[superhands]: https://github.com/wmurphyrd/aframe-super-hands-component -[superhandsdocs]: https://github.com/wmurphyrd/aframe-super-hands-component#description -[superhandsex]: https://wmurphyrd.github.io/aframe-super-hands-component/examples/ +[superhands]: https://github.com/c-frame/aframe-super-hands-component.git +[superhandsex]: https://c-frame.github.io/aframe-super-hands-component/examples/ The [super-hands component by William Murphy][superhands] provides all-in-one natural hand controller interaction. The component interprets input from @@ -583,7 +582,7 @@ components attached to translate the gestures into actions. super-hands includes components for typical reactions to the implemented gestures: hoverable, grabbable, stretchable, and drag-droppable. -The [documentation for super-hands][superhandsdocs] and +The [documentation for super-hands][superhands] and [examples][superhandsex] are excellent for getting started. We defer to those. ### Other Examples diff --git a/docs/introduction/models.md b/docs/introduction/models.md index ba1d40fcb01..183f743bda0 100644 --- a/docs/introduction/models.md +++ b/docs/introduction/models.md @@ -57,13 +57,13 @@ Places to find 3D models include: Programs to create models include: -- [Supercraft](https://supermedium.com/supercraft/) - Built **with** A-Frame to - model directly within VR with no modeling skill required and load with - [`aframe-supercraft-loader`](https://www.npmjs.com/package/aframe-supercraft-loader). - [Blender](https://www.blender.org/) - [MagicaVoxel](https://ephtracy.github.io/) - [Autodesk Maya](https://www.autodesk.com/products/maya/overview) or [Maya LT](https://www.autodesk.com/products/maya-lt/overview) - [Maxon Cinema4D](https://www.maxon.net/en-us/) +- [Supercraft](https://supermedium.com/supercraft/) (DEPRECATED) - Built **with** A-Frame to + model directly within VR with no modeling skill required and load with + [`aframe-supercraft-loader`](https://www.npmjs.com/package/aframe-supercraft-loader). ## Hosting Models diff --git a/docs/introduction/visual-inspector-and-dev-tools.md b/docs/introduction/visual-inspector-and-dev-tools.md index bcd9981adfc..491d7396ebd 100644 --- a/docs/introduction/visual-inspector-and-dev-tools.md +++ b/docs/introduction/visual-inspector-and-dev-tools.md @@ -23,8 +23,7 @@ experience: any computer for rapid development and testing. Reduce the amount of time going in and out of the headset. -We'll go over GUI tools built on top of A-Frame that can be used without code. -And touch on other tools that can ease development across multiple machines. +We'll touch on other tools that can ease development across multiple machines. @@ -252,39 +251,6 @@ view at whatever angle or focus on whatever area. ![Spectator Mode](https://cloud.githubusercontent.com/assets/674727/24733331/f2bc6094-1a2b-11e7-9442-bcf30d18af79.gif) -## GUI Tools Based on A-Frame - -People have built tools on top of A-Frame to abstract away code via an -interface or application, making content creation even easier. These act as -more complete editors rather than developer tools. - -### [Supercraft](https://supermedium.com/supercraft) - -Build VR Sites with Your Hands, all in VR, and publish to Web. - - - -### [Ottifox](http://ottifox.com/) - -*"Ottifox is a powerful design and prototyping solution that makes it easy to -create interactive VR scenes that run in the browser."* - -![Ottifox](https://cloud.githubusercontent.com/assets/674727/25638463/5cc90a3e-2f3d-11e7-987e-d8d299773f67.jpg) - -### [Hologram](http://hologram.cool/) - -*"All-in-one WebVR creation."* - -![Holgoram](https://user-images.githubusercontent.com/674727/36452389-24416be0-1649-11e8-8d7d-4a3a69097650.png) - -### [Fader](https://fader.vragments.com/) - -*"Create your own VR story now. Fader allows you to create and publish VR -stories. Add multiple layers of information to your 360 spheres, design scenes -and tell your story. Easy, fast and web based!"* - -![Fader](https://cloud.githubusercontent.com/assets/674727/25638761/53535724-2f3e-11e7-90f2-5efb3a58c549.jpg) - ## Cross-Machine Development With VR development, it is common to develop across multiple machines. For diff --git a/docs/introduction/vr-headsets-and-webxr-browsers.md b/docs/introduction/vr-headsets-and-webxr-browsers.md index da712355bca..efdd6f47078 100644 --- a/docs/introduction/vr-headsets-and-webxr-browsers.md +++ b/docs/introduction/vr-headsets-and-webxr-browsers.md @@ -143,7 +143,6 @@ specification][w3c], and flat 3D for most browsers. Large browser vendors are slowly moving to the WebXR specification, though it does not have much front-facing changes to A-Frame developers, involving mostly renaming of APIs. -- [Supermedium](https://www.supermedium.com) (available on Oculus and Steam) - Firefox - Oculus Browser - Samsung Internet