2023-03-31 19:53:23 +02:00
< link rel = "stylesheet" href = "doc/style.css" / >
2023-03-31 19:21:31 +02:00
< link href = "https://fonts.cdnfonts.com/css/montserrat" rel = "stylesheet" / >
2023-03-31 19:18:48 +02:00
2023-03-31 17:49:08 +02:00
[](https://github.com/coderofsalvation/xrfragment/actions)
2023-08-08 15:14:23 +02:00
< img src = "https://xrfragment.org/example/assets/logo.png" width = "200" / >
2023-08-08 13:21:22 +02:00
# Documentation / Website
2023-05-23 11:30:39 +02:00
2023-08-08 13:21:22 +02:00
https://xrfragment.org
2023-03-09 19:58:08 +01:00
2023-08-08 15:14:23 +02:00
# Getting started
Here are various ways to enhance your 3D assets/scenes with XR Fragments:
2023-08-08 15:15:00 +02:00
| | difficulty | how | notes |
|-|-|-|-|
2023-08-08 15:16:52 +02:00
| 1 | easiest | the xrfragment.org < a href = "https://xrfragment.org/example/aframe/sandbox" target = "_blank" > Sandbox< / a > | open 3D file (fbx/gltf) in < a href = "https://blender.org" target = "_blank" > Blender< / a > , add < a href = "https://docs.blender.org/manual/en/2.79/data_system/custom_properties.html" target = "_blank" > custom properties< / a > , and load exported files into < a href = "/example/aframe/sandbox" target = "_blank" > the sandbox< / a > |
2023-08-08 15:14:23 +02:00
| 2 | easy | hosted sandbox by < a href = "https://github.com/coderofsalvation/xrfragment-helloworld" target = "_blank" > forking xrfragment-helloworld</ a > | Basically #1 but it will be hosted for free at your own github URL |
| 3 | developer | fork < a href = "https://github.com/coderofsalvation/xrfragment-aframe-helloworld" > xfragment-aframe-helloworld< / a > | requires javascript- and < a href = "https://aframe.io" target = "_blank" > aframe.io< / a > developer-knowledge |
| 4 | developer | fork < a href = "https://github.com/coderofsalvation/xrfragment-three-helloworld" > xfragment-three-helloworld< / a > | requires javascript- and < a href = "https://threejs.org" target = "_blank" > threejs< / a > developer-knowledge |
| 5 | developer++ | use a parser-library below | lowlevel approach, more suitable for other scenarios |
# available parser-implementations
2023-03-31 13:25:53 +02:00
2023-05-23 11:30:39 +02:00
* [javascript ](dist/xrfragment.js ) [(+example) ](test/test.js )
* [python ](dist/xrfragment.py ) [(+example) ](test/test.py )
* [lua ](dist/xrfragment.lua ) [(+example) ](test/test.lua )
2023-08-08 15:14:23 +02:00
* [haXe ](src/xrfragment ) (allows exporting to various programming languages)
2023-05-23 11:30:39 +02:00
See documentation for more info
2023-03-09 19:58:08 +01:00
# development
2023-05-23 11:30:39 +02:00
Pre-build libraries can be found in [/dist folder ](dist )< br >
If you really want to build from source:
2023-03-09 19:58:08 +01:00
```
$ ./make install
2023-05-23 11:30:39 +02:00
$ ./make build & & ./make runtest
2023-03-09 19:58:08 +01:00
```
