Browse Source

Merge pull request #3550 from mhilbrunner/oculus-tutorial-fixes

Improvements and fixed for Oculus tutorial
Max Hilbrunner 5 years ago
parent
commit
01dd7b1a81
1 changed files with 19 additions and 19 deletions
  1. 19 19
      tutorials/vr/developing_for_oculus_quest.rst

+ 19 - 19
tutorials/vr/developing_for_oculus_quest.rst

@@ -7,39 +7,39 @@ Introduction
 ------------
 
 This tutorial goes over how to get started developing for the
-Oculus Quest with an official plugin.
+*Oculus Quest* with an official Godot plugin.
 
-Before getting started there are two things you need to do.
+Before starting, there are two things you need to do:
 
 First you need to go through the steps on the :ref:`doc_exporting_for_android`
 page. This leads you through installing the toolset that Godot
 needs to export to Android devices.
 
-Next you need the Quest Plugin. You can download it from the Asset
-Library or manually download it from `here <https://github.com/GodotVR/godot-oculus-mobile-asset>`_.
+Next you need the Quest plugin. You can get it from the Asset
+Library or manually download it from `here <https://github.com/GodotVR/godot-oculus-mobile-asset>`__.
 
 Setting Up Godot
 ----------------
 
-To get started Open up Godot and create a new project
+To get started open Godot and create a new project.
 
 .. image:: img/quest_new_project.png
 
-Make sure to chose the GLES2 renderer. Due to optimisations in the
+Make sure to choose the ``GLES2`` renderer. Due to the
 Quest's GPU this backend is far better suited for the Quest.
 
 Copy the addons folder from the Oculus Mobile asset into your Godot
-project. Your project tree should looks something like this:
+project. Your project tree should look similar to this:
 
 .. image:: img/quest_project_tree.png
 
-Now you can start building the main scene, stick to the bare minimum.
+Now you can start building the main scene:
 
-- Add an ARVROrigin node first.
-- Then Add three child nodes to the origin node, one ARVRCamera and two ARVRControllers.
-- Assign controller id 1 to the first ARVRController and rename that to LeftHand.
-- Assign controller id 2 to the second ARVRController and rename that to RightHand.
-- Finally add a MeshInstance as a child node to our first ARVRController and create a box shape, resize the box so each side is set to 0.1. Now duplicate the MeshInstance and move it to the second ARVRController node. These will stand in for our controllers, we're keeping things really simple.
+- Add an :ref:`ARVROrigin <class_ARVROrigin>` node first.
+- Then add three child nodes to the origin node, one :ref:`ARVRCamera <class_ARVRCamera>` and two :ref:`ARVRController <class_ARVRController>` nodes.
+- Assign controller ID 1 to the first :ref:`ARVRController <class_ARVRController>` and rename that to ``LeftHand``.
+- Assign controller ID 2 to the second :ref:`ARVRController <class_ARVRController>` and rename that to ``RightHand``.
+- Finally add a :ref:`MeshInstance <class_MeshInstance>` as a child node to our first :ref:`ARVRController <class_ARVRController>` and create a box shape, resize the box so each side is set to 0.1. Now duplicate the :ref:`MeshInstance <class_MeshInstance>` and move it to the second :ref:`ARVRController <class_ARVRController>` node. These will stand in for our controllers.
 
 .. image:: img/quest_scene_tree.png
 
@@ -76,7 +76,7 @@ more things.
 First go into the project settings and make sure that the main scene
 is the scene we run. Godot does not ask you to set this on export.
 
-..image:: img/quest_project_settings.png
+.. image:: img/quest_project_settings.png
 
 Then go into the export menu and configure a new Android export. if
 you still haven't gone through the :ref:`doc_exporting_for_android`
@@ -84,10 +84,10 @@ page do it now. If you didn't you'll have some red messages on this
 screen.
 
 If you did you can forge ahead and make a few small changes to the
-export settings. First change the XR Mode to "Oculus Mobile VR".
-Then change the Degrees of Freedom mode to "6DOF".
+export settings. First change the XR Mode to ``Oculus Mobile VR``.
+Then change the Degrees of Freedom mode to ``6DOF``.
 
-..image:: img/quest_export_settings.png
+.. image:: img/quest_export_settings.png
 
 Now save and close the export window.
 
@@ -122,6 +122,6 @@ it's not very exciting. Holger Dammertz has made a great toolkit for the
 quest that contains a lot of scenes to get help you on your way including
 really nice controller meshes.
 
-You can find the toolkit `here <https://github.com/NeoSpark314/godot_oculus_quest_toolkit>`_.
+You can find the toolkit `here <https://github.com/NeoSpark314/godot_oculus_quest_toolkit>`__.
 
-If you want to help out with improving the plugin please join us `here <https://github.com/GodotVR/godot_oculus_mobile>`_.
+If you want to help out with improving the plugin please join us `here <https://github.com/GodotVR/godot_oculus_mobile>`__.