Skip to content

Commit

Permalink
Updated the readme file with a link to the documentation and updated …
Browse files Browse the repository at this point in the history
…the documentation with more detailed download information (GodotVR#164)
  • Loading branch information
BastiaanOlij authored Jun 17, 2024
1 parent 87dff2b commit da80e83
Show file tree
Hide file tree
Showing 3 changed files with 56 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@ Version `2.x` and higher of this plugin requires **Godot 4.2**.
Check the [`1.x` branch](https://github.com/GodotVR/godot_openxr_vendors/tree/1.x) and releases
for support on prior versions of Godot 4.

## Manual pages

This readme focuses on instructions for building and maintaining this plugin.

User manual pages can be found [here](https://godotvr.github.io/godot_openxr_vendors/).

## Building this asset

After cloning this project, run the following command in the project root directory to initialize
Expand Down
49 changes: 49 additions & 0 deletions docs/getting-started/downloading.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
Obtaining the plugin
====================

There are three methods of obtaining a copy of this plugin.

Installing from the asset library
---------------------------------

This is the easiest and prefered way of deploying the plugin.
After creating your project in Godot, open the asset library and search for ``vendors``.
You can now find the latest releasess of this plugin and Godot will install the plugin for you.

Downloading from the releases page
----------------------------------

All releases can be found on the `plugins releases page <https://github.com/GodotVR/godot_openxr_vendors/releases>`_.
Once you find the correct release, unfold the ``Assets`` section and download the ``godotopenxrvendorsaddon.zip`` file.

In Godot you can open the asset library and use the ``Import...`` button to properly install the plugin.

Alternatively you can extract the zip file and copy the files into place.

.. note::

Note that the zip file contains a root folder as as required by the asset library.
This root folder should not be recreated in your project.
The plugin must be installed into ``res://addons/godotopenxrvendors``!

Building from source
--------------------

If you wish to use the latest changes, or add your own modifications you need to build the plugin from source.
You should clone the repository in a folder outside of your Godot project.

You can clone the repository by running the following command:

.. code-block::
git clone --recursive https://github.com/godotvr/godot_openxr_vendors
Follow the instructions in the ``README.md`` file to build the plugin.

You can now copy the folder ``demo\addons\godotopenxrvendors`` into your project.

Updating the vendors plugin
---------------------------

Godot currently does not have a method of updating the plugin.
You need to manually delete the ``godotopenxrvendors`` folder and repeat the installation process.
1 change: 1 addition & 0 deletions docs/getting-started/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,6 @@ Getting Started
:maxdepth: 1
:name: toc-getting-started

downloading
installation

0 comments on commit da80e83

Please sign in to comment.