diff --git a/docs/01-get-started/02-Quickstart.md b/docs/01-get-started/02-Quickstart.md index d4073493..f79bc024 100644 --- a/docs/01-get-started/02-Quickstart.md +++ b/docs/01-get-started/02-Quickstart.md @@ -55,14 +55,16 @@ On NixOS, use the [Nix package manager](https://nixos.org/download/#nix-install- nix run github:StardustXR/telescope ``` # After Installation -From here, just run `telescope -f` for flatscreen mode in your terminal! +From here, just run `telescope -f` for flatscreen mode in your terminal! You will see a floating hexagon with the Stardust XR logo in the center, this is Hexagon Launcher. +To move around, hold down ***Shift*** and ***W A S D***, with ***Q*** for moving down and ***E*** for moving up. +![WASD Q E Look around](/img/updated_flat_wasd.GIF) -To look around, hold down ***Shift*** and ***Right Click*** while moving the mouse. +To look around, hold down ***Shift*** and ***Right Click*** while moving the mouse. +![Look around](/img/updated_flat_look.GIF) -To move around, hold down ***Shift*** and ***W A S D***, with ***Q*** for moving down and ***E*** for moving up. - -If you click on the hexagon, the launcher will open. Try dragging one of the apps with the ***Mouse 5*** (Back) button. The small minus sign is Black Hole, if you click it, it will grab any open window and store it away. Click it again and they will return to their original location. +If you click on the hexagon, the launcher will open. Try dragging one of the apps with `Shift + ~`. The small minus sign is Black Hole, if you click it, it will grab any open window and store it away. Click it again and they will return to their original location. +![Flat drag](/img/updated_flat_drag.GIF) If you are already using OpenXR within Linux, running `telescope` while OpenXR is running should launch Stardust on your headset. If not, check further instructions for setting up OpenXR. diff --git a/docs/02-User-Guide/01-What-is-Stardust.md b/docs/02-User-Guide/01-What-is-Stardust.md new file mode 100644 index 00000000..da1a893a --- /dev/null +++ b/docs/02-User-Guide/01-What-is-Stardust.md @@ -0,0 +1,26 @@ +--- +sidebar_position: 1 +--- +# Flatscreen Navigation +
+ +
+ + +To move around, hold down `Shift + W A S D`, with `Q` for moving down and `E` for moving up. +![wasd](/img/updated_flat_wasd.GIF) + +To look around, hold down `Shift + Right` Click while moving the mouse. +![updated_look](/img/updated_flat_look.GIF) + +To drag applications out of the app launcher, hold down `Shift + ~` +![updated_drag](/img/updated_flat_drag.GIF) + diff --git a/docs/02-User-Guide/02-XR-Navigation.md b/docs/02-User-Guide/02-XR-Navigation.md new file mode 100644 index 00000000..543343bc --- /dev/null +++ b/docs/02-User-Guide/02-XR-Navigation.md @@ -0,0 +1,27 @@ +--- +sidebar_position: 1 +--- +# XR Navigation +
+ +
+ + +**Quest 3 Hand tracking**: +Pinch to drag and drop, grasp with full hand for grabbing, +point and click with pointer finger to click or pinch from a distance + +![hand_pinching](/img/hand_pinching.GIF) + +**Quest 3 Controller**: +Grab with the grip buttons, click by touching the tip of the cones or by using the trigger from a distance + +![controller_click](/img/controller_click.GIF) diff --git a/docs/02-User-Guide/_category_.json b/docs/02-User-Guide/_category_.json new file mode 100644 index 00000000..2615bc53 --- /dev/null +++ b/docs/02-User-Guide/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "User Guide", + "position": 2 +} diff --git a/docs/02-dive-deeper/01-brief-overview.md b/docs/03-dive-deeper/01-brief-overview.md similarity index 100% rename from docs/02-dive-deeper/01-brief-overview.md rename to docs/03-dive-deeper/01-brief-overview.md diff --git a/docs/02-dive-deeper/02-deep-overview.md b/docs/03-dive-deeper/02-deep-overview.md similarity index 100% rename from docs/02-dive-deeper/02-deep-overview.md rename to docs/03-dive-deeper/02-deep-overview.md diff --git a/docs/02-dive-deeper/03-make-clients.md b/docs/03-dive-deeper/03-make-clients.md similarity index 100% rename from docs/02-dive-deeper/03-make-clients.md rename to docs/03-dive-deeper/03-make-clients.md diff --git a/docs/02-dive-deeper/09-terminology.md b/docs/03-dive-deeper/09-terminology.md similarity index 100% rename from docs/02-dive-deeper/09-terminology.md rename to docs/03-dive-deeper/09-terminology.md diff --git a/docs/02-dive-deeper/_category_.json b/docs/03-dive-deeper/_category_.json similarity index 65% rename from docs/02-dive-deeper/_category_.json rename to docs/03-dive-deeper/_category_.json index e9e64730..2bd207d1 100644 --- a/docs/02-dive-deeper/_category_.json +++ b/docs/03-dive-deeper/_category_.json @@ -1,4 +1,4 @@ { "label": "Dive deeper", - "position": 2 + "position": 3 }