76 lines
3.4 KiB
Markdown
76 lines
3.4 KiB
Markdown
# Godot XR Tools
|
|
|
|
|
|
|
|
|
|
|
|
|
|
This repository contains a number of support files and support scenes that can be used together with the various AR and VR interfaces for the Godot game engine.
|
|
|
|
## Versions
|
|
|
|
Official releases are tagged and can be found [here](https://github.com/GodotVR/godot-xr-tools/releases).
|
|
|
|
The following branches are in active development:
|
|
|
|
| Branch | Description | Godot version |
|
|
|-----------|-------------------------------|-----------------|
|
|
| master | Current development branch | Godot 4.2+ |
|
|
| 4.3.x | Godot XR Tools 4.3.x branch | Godot 4.1+ |
|
|
| 3.x | Godot 3.x development branch | Godot 3.5+ |
|
|
|
|
Version compatibility:
|
|
|
|
| Godot XR Tools | Minimum Godot version |
|
|
|----------------|-----------------------|
|
|
| 4.4.x | 4.2 |
|
|
| 4.3.x | 4.1 |
|
|
| 4.2.x | 4.1 |
|
|
| 4.1.x | 4.0 |
|
|
| 4.0.x | 4.0 |
|
|
|
|
## How to Use
|
|
|
|
Information about how to use this plugin can be found [on the website](https://godotvr.github.io/godot-xr-tools/).
|
|
|
|
### Demo
|
|
|
|
This repository now contains a full demo for XR Tools with the XR Tools add on included in this demo.
|
|
|
|
After cloning this repository you will need to install the OpenXR plugin for it to work. The OpenXR plugin is not included within this repository.
|
|
You can obtain the OpenXR plugin [here](https://github.com/GodotVR/godot_openxr/releases) or download it from the asset library within Godot.
|
|
|
|
### XR Tools library
|
|
|
|
To obtain just the XR Tools library for your own project, please check [releases](https://github.com/GodotVR/godot-xr-tools/releases) or download it from the asset library within Godot.
|
|
|
|
### Preventing hiccups
|
|
|
|
As many of the functions in this module will hide objects that are later shown as the user performs actions, the user will experience a hiccup as Godot compiles the shader used to draw the object on screen.
|
|
|
|
To combat this you will find a scene in this module called `misc/VR_Common_Shader_Cache.tscn`.
|
|
Add this scene as a child node to your XRCamera3D. This will trigger the required shaders being
|
|
compiled the first time your main scene loads.
|
|
|
|
## Licensing
|
|
|
|
Code in this repository is licensed under the MIT license.
|
|
Images are licensed under CC0 unless otherwise specified.
|
|
|
|
See the full license inside of the addons folder.
|
|
|
|
## About this repository
|
|
|
|
This repository was created by Bastiaan Olij a.k.a. Mux213
|
|
|
|
It is primarily maintained by:
|
|
- [Bastiaan Olij](https://github.com/BastiaanOlij/)
|
|
- [Malcolm Nixon](https://github.com/Malcolmnixon/)
|
|
|
|
For further contributors please see `CONTRIBUTORS.md`
|
|
|
|
Further resources:
|
|
- [Bastiaan Olij on Twitter](https://twitter.com/mux213) for regular updates
|
|
- [Bastiaan Olij on Youtube](https://www.youtube.com/BastiaanOlij) for tutorials
|
|
- [Malcolm Nixon on Youtube](https://www.youtube.com/user/MalcolmANixon) for demonstrations of Godot XR Tools.
|
|
- [DigitalN8m4r3 on Youtube](https://youtube.com/playlist?list=PLBpYNPEE9RKiB7Rnn1tDpMO5wQEG0WnUt&feature=shared) custom hand poses tutorial for Godot XR Tools
|