https://github.com/coderofsalvation/xrfragment

XR Fragments: a tiny specification for controlling any 3D model using URLs, based on existing metadata ⚡ Enable hyperlinked 3D storytelling using all 3D editors 💙
https://github.com/coderofsalvation/xrfragment

aframe blender browser embeds fbx glb gltf hyperlinks hypermedia navigation nometaverse protocol specification standards threejs uri usdz

Last synced: 3 months ago
JSON representation

XR Fragments: a tiny specification for controlling any 3D model using URLs, based on existing metadata ⚡ Enable hyperlinked 3D storytelling using all 3D editors 💙

• Host: GitHub
• URL: https://github.com/coderofsalvation/xrfragment
• Owner: coderofsalvation
• License: mpl-2.0
• Created: 2023-03-09T18:55:16.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-10T16:38:52.000Z (10 months ago)
• Last Synced: 2024-04-11T11:39:36.052Z (10 months ago)
• Topics: aframe, blender, browser, embeds, fbx, glb, gltf, hyperlinks, hypermedia, navigation, nometaverse, protocol, specification, standards, threejs, uri, usdz
• Language: HTML
• Homepage: https://xrfragment.org
• Size: 135 MB
• Stars: 6
• Watchers: 3
• Forks: 1
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# MOVED TO NONPROFIT ORG https://codeberg.org/coderofsalvation/xrfragment

> this repo is outdated

[![Actions Status](https://github.com/coderofsalvation/xrfragment/workflows/test/badge.svg)](https://github.com/coderofsalvation/xrfragment/actions)



A tiny specification for viewing 3D models as linkable AR/VR websites.


Address and Control anything inside a 3D model with [W3C Media Fragments](https://www.w3.org/TR/media-frags/) and [URI Templates](https://www.rfc-editor.org/rfc/rfc6570).





![](https://coderofsalvation.github.io/xrfragment.media/images/metadata.jpg)




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

# Documentation / Website 

https://xrfragment.org 

![](https://coderofsalvation.github.io/xrfragment.media/images/nocode.jpg)

# Getting started

![](https://coderofsalvation.github.io/xrfragment.media/gettingstarted2024.mp4)

https://xrfragmenorg 

# available parser-implementations

* [javascript](dist/xrfragment.js) [(+example)](test/test.js)

* [javascript module](dist/xrfragment.module.js) 

* [python](dist/xrfragment.py) [(+example)](test/test.py)

* [lua](dist/xrfragment.lua) [(+example)](test/test.lua)

* [haXe](src/xrfragment) (allows exporting to various programming languages)

* [Godot](https://codeberg.org/coderofsalvation/xrfragment-godot) exports to all platforms

See documentation for more info

# development

Pre-build libraries can be found in [/dist folder](dist)


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](./src/xrfragment/godot) (open the folder in godot)

# Credits