a tiny specification for (viewing) 3D models (metadata) as linkable AR/VR websites. Address and Control anything inside a 3D model with W3C Media Fragments and URI Templates. Simply SURF a 3D file-verse and design for a Spatial Open Internet with the highest degree of interoperability. https://xrfragment.org

Go to file

Leon van Kammen b586b4e696 main: update documentation		2024-06-24 13:17:35 +00:00
.github/workflows	…
dist	main: work in progress [might break]	2024-06-18 12:00:14 +02:00
doc	updated docs	2024-06-19 14:13:15 +02:00
example	…
src	added accessibility: tab+enter navigation for quizz e.g.	2024-06-17 13:53:47 +00:00
test	…
.gitignore	…
.gitmodules	…
.vimrc	…
LICENSE	…
README.md	…
build.hxml	…
index.html	main: update documentation	2024-06-24 13:17:35 +00:00
make	…
shell.nix	…

README.md

A tiny specification for viewing 3D models as linkable AR/VR websites.
Address and Control anything inside a 3D model with W3C Media Fragments and URI Templates.

Simply SURF a 3D file-verse and design for a Spatial Open Internet with the highest degree of interoperability ❤

Documentation / Website

https://xrfragment.org

Getting started

https://xrfragmenorg

available parser-implementations

javascript (+example)
javascript module
python (+example)
lua (+example)
haXe (allows exporting to various programming languages)
Godot exports to all platforms

See documentation for more info

development

Pre-build libraries can be found in /dist folder
If you really want to build from source:

$ nix-shell           # nix-users: drops you into a dev-ready shell 
$ ./make install      # debian-users: install deps via apt-get
$ ./make build && ./make tests

NOTE #1: to rebundle the THREE/AFRAME javascripts during dev run ./make build js NOTE #2: to regenerate the parser in various languages (via haxe), run ./make build parser

Godot (>=v4.3.1)

$ ./make install godot       # this installs the godot-xr-tools addon

NOTE: the godot project is in src/xrfragment/godot (open the folder in godot)