From d3acffa39d7ab67d4acdeca29611f81bcc890183 Mon Sep 17 00:00:00 2001 From: Leon van Kammen Date: Thu, 20 Aug 2026 12:54:37 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=83=20master:=20update=20documentation?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 53 ++++++++++----------- src/css/forkme.css | 101 ++++++++++++++++++++++++++++++++++++++++ src/css/xrforge.max.css | 8 +++- src/page/footer.html | 2 + src/page/header.html | 3 +- src/plugin/global.lua | 28 ++++++++--- 6 files changed, 161 insertions(+), 34 deletions(-) create mode 100644 src/css/forkme.css diff --git a/README.md b/README.md index 44f011c..64bdbfa 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,35 @@ XRForge is a tiny, powerful tool to interconnect XR experiences via 3D portals..
An open, seamless XR web built from simple URLs and directories, without gatekeepers, built upon Next Generation Internet (NGI) specs:

-

Try online version here

+ +
+ +## Usage / Radical Opensource + +Download [xrforge.com](releases) and open your windows/mac/linux terminal: + +```bash +$ ./xrforge.com +Usage: ./xrforge.com [opts] + + ./xrforge.com admin launch adminpanel to configure stuff (/admin) + ./xrforge.com generate generate www-folder with XR experiences + ./xrforge.com help display all possible flags + ./xrforge.com createplugin generates skeleton plugin + ./xrforge.com server starts the webserver [without --nobrowser] + ./xrforge.com test run testsuite (selftest) +``` + +> NOTE: mac/linux-users need to do an additional `chmod +x xrforge.com` + +Profit! now run `xrforge.com admin` and XRForge will be launched in a webbrowser + +
+ +
+

Try online version here


@@ -50,31 +76,6 @@ An open, seamless XR web built from simple URLs and directories, without gatekee - -
- -## Usage / Radical Opensource - -Download [xrforge.com](releases) and open your windows/mac/linux terminal: - -```bash -$ ./xrforge.com -Usage: ./xrforge.com [opts] - - ./xrforge.com admin launch adminpanel to configure stuff (/admin) - ./xrforge.com generate generate www-folder with XR experiences - ./xrforge.com help display all possible flags - ./xrforge.com createplugin generates skeleton plugin - ./xrforge.com server starts the webserver [without --nobrowser] - ./xrforge.com test run testsuite (selftest) -``` - -> NOTE: mac/linux-users need to do an additional `chmod +x xrforge.com` - -Profit! now run `xrforge.com admin` and XRForge will be launched in a webbrowser - -
-
## Example content diff --git a/src/css/forkme.css b/src/css/forkme.css new file mode 100644 index 0000000..02fe779 --- /dev/null +++ b/src/css/forkme.css @@ -0,0 +1,101 @@ +/*! + * "Fork me on GitHub" CSS ribbon v0.2.0 | MIT License + * https://github.com/simonwhitaker/codeforge-fork-ribbon-css +*/ +.codeforge-fork-ribbon { + width:12.1em; + height:12.1em; + position:absolute; + overflow:hidden; + top:0; + right:0; + z-index:9999; + pointer-events:none; + font-size:13px; + text-decoration:none; + text-indent:-999999px + cursor:pointer; +} +.codeforge-fork-ribbon.fixed { + position:fixed +} +.codeforge-fork-ribbon:before, +.codeforge-fork-ribbon:after { + position:fixed; + display:block; + width:15.38em; + height:1.54em; + bottom:3.23em; + right:-3.23em; + -webkit-transform:rotate(45deg); + -moz-transform:rotate(45deg); + -ms-transform:rotate(45deg); + -o-transform:rotate(45deg); + transform:rotate(45deg) +} +.codeforge-fork-ribbon:before { + + content:""; + padding:.38em 0; + background-color:#a0F; + background-image:-webkit-gradient(linear,left top,left bottom,from(rgba(0,0,0,0)),to(rgba(0,0,0,0.15))); + background-image:-webkit-linear-gradient(top,rgba(0,0,0,0),rgba(0,0,0,0.15)); + background-image:-moz-linear-gradient(top,rgba(0,0,0,0),rgba(0,0,0,0.15)); + background-image:-ms-linear-gradient(top,rgba(0,0,0,0),rgba(0,0,0,0.15)); + background-image:-o-linear-gradient(top,rgba(0,0,0,0),rgba(0,0,0,0.15)); + background-image:linear-gradient(to bottom,rgba(0,0,0,0),rgba(0,0,0,0.15)); + -webkit-box-shadow:0 .15em .23em 0 rgba(0,0,0,0.5); + -moz-box-shadow:0 .15em .23em 0 rgba(0,0,0,0.5); + pointer-events:auto +} +.codeforge-fork-ribbon:after { + content:attr(title); + color:#fff; + font:700 1em "Helvetica Neue",Helvetica,Arial,sans-serif; + line-height:1.54em; + text-decoration:none; + text-shadow:0 -.08em rgba(0,0,0,0.5); + text-align:center; + text-indent:0; + padding:.15em 0; + margin:.15em 0; + border-width:.08em 0; + border-style:dotted; + border-color:#fff; + border-color:rgba(255,255,255,0.7) +} +.codeforge-fork-ribbon.left-top, +.codeforge-fork-ribbon.left-bottom { + right:auto; + left:0 +} +.codeforge-fork-ribbon.left-bottom, +.codeforge-fork-ribbon.right-bottom { + top:auto; + bottom:0 +} +.codeforge-fork-ribbon.left-top:before, +.codeforge-fork-ribbon.left-top:after, +.codeforge-fork-ribbon.left-bottom:before, +.codeforge-fork-ribbon.left-bottom:after { + right:auto; + left:-3.23em +} +.codeforge-fork-ribbon.left-bottom:before, +.codeforge-fork-ribbon.left-bottom:after, +.codeforge-fork-ribbon.right-bottom:before, +.codeforge-fork-ribbon.right-bottom:after { + top:auto; + bottom:3.23em +} +.codeforge-fork-ribbon.left-top:before, +.codeforge-fork-ribbon.left-top:after, +.codeforge-fork-ribbon.right-bottom:before, +.codeforge-fork-ribbon.right-bottom:after { + -webkit-transform:rotate(-45deg); + -moz-transform:rotate(-45deg); + -ms-transform:rotate(-45deg); + -o-transform:rotate(-45deg); + transform:rotate(-45deg) +} + diff --git a/src/css/xrforge.max.css b/src/css/xrforge.max.css index 984bac6..d196e4a 100644 --- a/src/css/xrforge.max.css +++ b/src/css/xrforge.max.css @@ -16,12 +16,18 @@ body{ background-position:center; background-repeat: no-repeat; height:33vh; + transition: border-color .2s; /* Animation */ } + +.grid .tile .img:hover{ + border:1px solid #FFFA; +} + .grid .tile{ margin: 0px 20px 20px 0px; width:31%; float:left; - background-color:#2230; + background: linear-gradient(0deg, #2230, #2230, #223F, #2230); } @media (max-width: 470px){ diff --git a/src/page/footer.html b/src/page/footer.html index b65f7dd..10a836d 100644 --- a/src/page/footer.html +++ b/src/page/footer.html @@ -40,6 +40,8 @@ + + ${opts.plugin_global_footer_html} ${janusxr} diff --git a/src/page/header.html b/src/page/header.html index a98159f..d1bb0d1 100644 --- a/src/page/header.html +++ b/src/page/header.html @@ -6,7 +6,7 @@ ${opts.plugin_global_title} - ${opts.plugin_global_headertags} + ${opts.plugin_global_header_html} + ${opts.plugin_global_body_html}
diff --git a/src/plugin/global.lua b/src/plugin/global.lua index 8f8983a..d4fb046 100644 --- a/src/plugin/global.lua +++ b/src/plugin/global.lua @@ -92,13 +92,29 @@ local plugin = { values='' }, { - key='app.opts.plugin_global_headertags', - title='Header html', - info='Add extra header tags here', + key='app.opts.plugin_global_header_html', + title='Header HTML', + info='Add HTML header tags here', default = [[ - + + ]], + control='textarea', + values='' + }, + { + key='app.opts.plugin_global_body_html', + title='Body HTML', + info='Add extra HTML here', + default = [[]], + control='textarea', + values='' + }, + { + key='app.opts.plugin_global_footer_html', + title='Footer HTML', + info='Add extra HTML here', + default = [[ + ]], control='textarea', values=''