hiina/xrjamfeb2025
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

change readme, license to unlicense

Browse source
This commit is contained in:
hiina 2025-02-04 17:04:12 -07:00
parent 2f039195ba
commit 96b0bc714b
2 changed files with 22 additions and 92 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

37
LICENSE
View file

@ -1,21 +1,24 @@
MIT License
This is free and unencumbered software released into the public domain.
Copyright (c) 2018-2023 Bastiaan Olij and Contributors
Anyone is free to copy, modify, publish, use, compile, sell, or
distribute this software, either in source code form or as a compiled
binary, for any purpose, commercial or non-commercial, and by any
means.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
In jurisdictions that recognize copyright laws, the author or authors
of this software dedicate any and all copyright interest in the
software to the public domain. We make this dedication for the benefit
of the public at large and to the detriment of our heirs and
successors. We intend this dedication to be an overt act of
relinquishment in perpetuity of all present and future rights to this
software under copyright law.
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
For more information, please refer to <https://unlicense.org/>

77
README.md
View file

@ -1,76 +1,3 @@
# Godot XR Tools
# godot XR game jam feb 2025
![GitHub forks](https://img.shields.io/github/forks/godotvr/godot-xr-tools?style=plastic)
![GitHub Repo stars](https://img.shields.io/github/stars/godotvr/godot-xr-tools?style=plastic)
![GitHub contributors](https://img.shields.io/github/contributors/godotvr/godot-xr-tools?style=plastic)
![GitHub](https://img.shields.io/github/license/godotvr/godot-xr-tools?style=plastic)
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
a meme game demo in the meme engine for the meme platform.