📃 master: update documentation
This commit is contained in:
parent
432459ab2b
commit
d3acffa39d
6 changed files with 161 additions and 34 deletions
53
README.md
53
README.md
|
|
@ -2,9 +2,35 @@ XRForge is a tiny, powerful tool to interconnect XR experiences via 3D portals..
|
|||
<br>
|
||||
An open, seamless XR web built from simple URLs and directories, without gatekeepers, built upon Next Generation Internet (NGI) specs:<br>
|
||||
<br>
|
||||
<h1><center><a href="https://xrforge.isvery.ninja" style="border:1px solid #888; border-radius:10px; padding:10px">Try online version here</a></center></h1>
|
||||
|
||||
<img src="https://codeberg.org/coderofsalvation/xrforge-v2/raw/branch/master/src/img/badges.png"/>
|
||||
|
||||
<div class="p" id="radical">
|
||||
|
||||
## Usage / Radical Opensource
|
||||
|
||||
Download [xrforge.com](releases) and open your windows/mac/linux terminal:
|
||||
|
||||
```bash
|
||||
$ ./xrforge.com
|
||||
Usage: ./xrforge.com <cmd> [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
|
||||
|
||||
</div>
|
||||
|
||||
<br>
|
||||
<h1><center><a href="https://xrforge.isvery.ninja" style="border:1px solid #888; border-radius:10px; padding:10px">Try online version here</a></center></h1>
|
||||
<br>
|
||||
<a href="screenshot.jpg" target="_blank">
|
||||
<img src="screenshot.jpg"/>
|
||||
|
|
@ -50,31 +76,6 @@ An open, seamless XR web built from simple URLs and directories, without gatekee
|
|||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="p" id="radical">
|
||||
|
||||
## Usage / Radical Opensource
|
||||
|
||||
Download [xrforge.com](releases) and open your windows/mac/linux terminal:
|
||||
|
||||
```bash
|
||||
$ ./xrforge.com
|
||||
Usage: ./xrforge.com <cmd> [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
|
||||
|
||||
</div>
|
||||
|
||||
<div class="p" id="content">
|
||||
|
||||
## Example content
|
||||
|
|
|
|||
101
src/css/forkme.css
Normal file
101
src/css/forkme.css
Normal file
|
|
@ -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)
|
||||
}
|
||||
|
||||
|
|
@ -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){
|
||||
|
|
|
|||
|
|
@ -41,6 +41,8 @@
|
|||
</tr>
|
||||
</table>
|
||||
|
||||
${opts.plugin_global_footer_html}
|
||||
|
||||
<!-- JanusXR portalroom, see https://janusxr.org for markup -->
|
||||
${janusxr}
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
<base href="${opts.baseurl}" />
|
||||
<title>${opts.plugin_global_title}</title>
|
||||
<link rel="stylesheet" href="css/xrforge.css"></link>
|
||||
${opts.plugin_global_headertags}
|
||||
${opts.plugin_global_header_html}
|
||||
<noscript>
|
||||
{if urlpath == '/' or urlpath == '/index.html' then
|
||||
print('<meta http-equiv="refresh" content="0;url=${opts.plugin_diskscan_dirname}">')
|
||||
|
|
@ -14,6 +14,7 @@
|
|||
</noscript>
|
||||
</head>
|
||||
<body background="#000000" class="${page}">
|
||||
${opts.plugin_global_body_html}
|
||||
<table width="100%" class="header">
|
||||
<tr>
|
||||
<td>
|
||||
|
|
|
|||
|
|
@ -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 = [[
|
||||
<!--
|
||||
<link rel="stylesheet" type="text/css" href="https://my.org/foo.css" media="all" />
|
||||
-->
|
||||
<link rel="stylesheet" type="text/css" href="css/forkme.css" media="all" />
|
||||
]],
|
||||
control='textarea',
|
||||
values=''
|
||||
},
|
||||
{
|
||||
key='app.opts.plugin_global_body_html',
|
||||
title='Body HTML',
|
||||
info='Add extra HTML here',
|
||||
default = [[<!-- html here -->]],
|
||||
control='textarea',
|
||||
values=''
|
||||
},
|
||||
{
|
||||
key='app.opts.plugin_global_footer_html',
|
||||
title='Footer HTML',
|
||||
info='Add extra HTML here',
|
||||
default = [[
|
||||
<a class="codeforge-fork-ribbon right-bottom" href="https://codeberg.org/coderofsalvation/xrforge-v2" title="Make this 100% yours" style="border:none"></a>
|
||||
]],
|
||||
control='textarea',
|
||||
values=''
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue