XR Fragment parser written in Haxe (crosscompiler) with python-, javascript-, lua- and more builds.

Find a file

Leon van Kammen dcc3b1666f Some checks failed test / test (push) Has been cancelled Details Deploy static content to Pages / deploy (push) Has been cancelled Details bugfix: ever-growing xrfragment.module.js		2025-09-26 20:13:37 +02:00
.github/workflows	main: minor bugfix	2024-05-17 18:02:18 +02:00
assets	update thumbnail	2025-08-14 11:46:28 +02:00
dist	new build	2025-05-22 19:31:23 +02:00
example	restructured assets directory	2025-08-14 10:40:01 +02:00
src	bugfix: dont use nonexistant .interactive	2025-05-22 19:31:13 +02:00
test	fixed voodoo bug (xrwg lines messing with src scaling: always use xrf.add() ) + activated AGPL	2024-08-01 16:25:05 +02:00
.env	.env glob typofix	2025-01-14 15:44:49 +01:00
.gitignore	feat/godot wip	2024-05-10 13:41:20 +02:00
.gitmodules	moved godot repo to its own codeberg repo to submit as godot extension	2024-05-20 10:03:45 +02:00
.vimrc	updated vimrc	2023-11-16 14:58:51 +01:00
build.hxml	main: minor bugfix	2024-05-20 11:50:28 +02:00
LICENSE	fixed voodoo bug (xrwg lines messing with src scaling: always use xrf.add() ) + activated AGPL	2024-08-01 16:25:05 +02:00
make	bugfix: ever-growing xrfragment.module.js	2025-09-26 20:13:37 +02:00
README.md	README.md: typofix getting started link	2025-05-18 12:49:12 +02:00
shell.nix	fix nix deps	2025-09-01 17:55:24 +02:00

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://xrfragment.org

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)