coderofsalvation
/
xrfragment
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update documentation

This commit is contained in:
Leon van Kammen 2023-03-31 19:21:31 +02:00
parent 5dee8713a0
commit cb1846d22d
3 changed files with 9 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -1,5 +1,5 @@
<link rel="stylesheet" href="https://2wa.isvery.ninja/css/style.css"></link>
<link href="https://fonts.cdnfonts.com/css/montserrat" rel="stylesheet">
<link rel="stylesheet" href="https://2wa.isvery.ninja/css/style.css"/>
<link href="https://fonts.cdnfonts.com/css/montserrat" rel="stylesheet"/>
[![Actions Status](https://github.com/coderofsalvation/xrfragment/workflows/test/badge.svg)](https://github.com/coderofsalvation/xrfragment/actions)

8
doc/RFC.md
View File

@ -14,13 +14,14 @@
# XR Fragments (key/value params)
> ⛁ = supported in 3D asset-file (custom property or projection)<br>
> ⚂ = supported in navigator URI (`document.location.href` e.g.)<br>
> ⛁ = define in 3D asset-file (as custom property or default projection)<br>
> ☇ = mutable, using navigator URI (`document.location.href` e.g.)<br>
| param | type | scope(s) | category | notes |
|---------|---------------|-------|--------------------|---------------------------------|
| prio | int (-10..1) | ⛁ | Asset loading / linking | \#static allow client to ignore lower-prio objects in the renderloop, to compensate frame-drop/cpu/gpu-overload scenario’soc/notes/prio.md |
| pos | 3D vector | ⛁ ⚂ |HREF navigation/portals | |
| pos | 3D vector | ⛁ ☇ |HREF navigation/portals | |
| q | string | ⛁ |Query Selector | |
# XR Fragments parser
@ -56,6 +57,7 @@ the gist of it:
1. integers are detected using regex `/^[0-9]+$/`
1. floats are detected using regex `/^[0-9]+\.[0-9]+$/`
1. vectors are detected using regex `/[,]/` (but can also be an string referring to an entity-ID in the asset)
1. anything else is string `/.*/`
# Tests

2
make
View File

@ -33,6 +33,8 @@ tests(){
doc(){
{
echo '<link rel="stylesheet" href="css/style.css"/>'
echo '<link href="https://fonts.cdnfonts.com/css/montserrat" rel="stylesheet"/>'
echo "> version $VERSION"
echo "\ndate: $(date +"%Y-%m-%dT%H:%M:%S%z") (generated by \`./make doc\`)\n"
echo "[![Actions Status](https://github.com/coderofsalvation/xrfragment/workflows/test/badge.svg)](https://github.com/coderofsalvation/xrfragment/actions)\n"