janusweb 1.5.56 → 1.7.1

package/.github/workflows/deploy.yml

@@ -0,0 +1,71 @@
+name: Build and Deploy to Pages
+
+on:
+  push:
+    # Monitor all branches so we can catch '#deploy' in commit messages
+    branches: ["**"]
+    tags:
+      - "v*.*.*"
+
+permissions: write-all
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  build-and-deploy:
+    # Run only on the master branch OR if the commit message contains '#deploy'
+    runs-on: ubuntu-latest
+    
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20' # Change to your preferred version
+          cache: 'npm'       # Only works if you have a package-lock.json
+
+      - name: Install dependencies
+        # Only runs if package.json exists; avoids errors if it doesn't
+        run: |
+          if [ -f package.json ]; then
+            npm install
+          fi
+
+      - name: Run build script
+        run: |
+          chmod +x ./utils/build.sh
+          ./utils/build.sh
+          ./utils/release.binary.sh
+
+      - name: Create Release and Upload Assets
+        uses: softprops/action-gh-release@v3
+        with:
+          files: |
+            build/janusweb-*.tar.gz 
+            build/*/janusxr.com
+        #env: # only needed when creating a release in other repo
+        #  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Organize build artifacts
+        # Creates a clean 'www' folder and copies your build/sub/folders into it
+        run: |
+          mkdir -p www
+          cp -r build/*/* www/ 2>/dev/null || cp -r build/* www/
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: 'www'
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
+

package/Dockerfile

@@ -0,0 +1,14 @@
+FROM busybox:latest
+
+ARG JANUSXR_VERSION="1.5.56"
+
+WORKDIR /www
+COPY build/$JANUSXR_VERSION/janusxr.com .
+
+# assimilate the crossplatform binary into host architecture
+# otherwise docker will complain with 'Exec format error'
+RUN wget https://cosmo.zip/pub/cosmos/bin/assimilate && \
+    chmod +x assimilate && \
+    ./assimilate ./janusxr.com 
+
+CMD ["/www/janusxr.com"]

package/README.md

@@ -1,6 +1,6 @@
 <p align="center"><a href="https://web.janusvr.com" target="_blank"><img width="480" alt="JanusWeb" src="https://imgur.com/ejvyphR.jpg"></a></p>
 
-<p align="center"><b>A web framework for building social virtual reality experiences.</b></p>
+<p align="center"><b>A web framework/browser for building rich virtual reality experiences.</b></p>
 
 <div align="center">
   <a href="https://janusvr.com">Site</a>
@@ -11,7 +11,9 @@
   &mdash;
   <a href="https://web.janusvr.com">Demo</a>
   &mdash;
-  <a href="https://github.com/madjin/janus-guide">Docs</a>
+  <a href="https://coderofsalvation.github.io/janus-guide/">Docs</a>
+  &mdash;
+  <a href="https://discord.gg/7eyK2wE">Discord</a>
 </div>
 
 
@@ -39,20 +41,24 @@
 
 ## Features
 
+- [Open Immersive Web-layer](https://madjin.github.io/janus-guide/#/home/about) for browsing XR experiences across the web 
 - Build immersive 3D environments for desktop, mobile, and VR devices using HTML and JS
 - Rendering functionality provided by Three.js / WebGL
+- Separately host WebXR experiences via ([JML](https://madjin.github.io/janus-guide/#/examples/markup) in) any textfile.
 - Oculus Rift, Vive, GearVR, Daydream, and Cardboard support via WebVR API
-- Realtime collaboration across all devices via built-in networking
+- [Realtime collaboration](https://madjin.github.io/janus-guide/#/home/usecases) across all devices via built-in networking
 - Import Collada, OBJ, glTF, and other popular 3d file formats
 - 3D positional audio
 - Gamepad support via the HTML5 Gamepad API
 - Supports hand tracking peripherals like Leap Motion, Oculus Touch, and Vive controllers
 - Support for 2d, sbs3d/ou3d, and 360 degree video textures using HTML5 Video
 - Scriptable client enables many customized uses
+- And [much more](https://madjin.github.io/janus-guide/#/home/toc)
+
 
 ## Using
 
-There are several different ways to use JanusWeb, depending on how much control you want to 
+There are [several different ways](https://madjin.github.io/janus-guide/#/home/usecases) to use JanusWeb, depending on how much control you want to 
 have over the whole system.
 
 ### Use our viewer
@@ -64,10 +70,188 @@ You can even put your mark-up onto sites like PasteBin or PiratePad.  Then just
 in our viewer by entering the URL into the navigation bar, and you can link directly to it, share 
 on social media, or embed our viewer directly into other webpages, blog posts, or articles.
 
-See also **Using a specific version of JanusWeb** below.
+### Single-binary server+client 
+
+Use our all-in-one **janusxr.com** multi-platform binary file:
+Run a **local-first** viewer locally on your desktop, raspberry pi (ARM64) or server.<br>
+
+| executable    | platforms |
+|-|-|
+| [janusxr.com](https://jbaicoianu.github.io/janusweb/janusxr.com) | <img src="https://i.imgur.com/v7cYVq1.png"/> |
+
+Run `janusxr.com` from anywhere, or put it into a folder with your 3D models or JanusXR rooms:
+
+```
+$ chmod +x janusxr.com          # only for non-windows users
+
+$ ./janusxr.com 
+I2026-01-19T15:41:10 (srvr) listen http://127.0.0.1:8080
+I2026-01-19T15:41:10 (srvr) listen http://192.168.1.168:8080
+Launching browser..
+```
+
+A browser will popup, and connect to `https://janusxr.org` via Janusweb.<br>
+Webbrowsers on the same network can access your node `https://192.168.1.168:8080`
+
+> Optionally, you can expose this janusweb-node to the internet. Check [here](https://redbean.dev) for more commandline options.
+</details>
+
+<details>
+<summary><b>Usecase:</b> 3D file viewer</summary>
+<br>
+Make sure `janusxr.com` is in a folder with your 3D models
+
+```
+$ ls 
+janusxr.com
+world1.glb
+world2.glb
+```
+
+Then make sure you rename `janusxr.com` to whatever you want to set as homepage:
+
+```
+$ mv janusxr.com world1.com
+$ ./world1.com 
+I2026-01-19T15:41:10 (srvr) listen http://127.0.0.1:8080
+I2026-01-19T15:41:10 (srvr) listen http://192.168.1.168:8080
+✅ detected /world1.glb (setting as spatial home)
+Launching browser..
+```
+</details>
+
+<details>
+<summary><b>Usecase:</b> all-in-one JanusXR runtime</summary>
+<br>
+You can bundle all your XR experiences with the server/client binary.<br>
+Just Make sure `janusxr.com` is in a folder with your JanusXR rooms or 3D models
+
+```
+$ ls 
+janusxr.com
+world1.html
+world2.html
+foo.glb
+```
+
+Then make sure you rename `janusxr.com` to whatever you want to set as homepage:
+
+```
+$ zip -r janusxr.com *              # add janus files to janusxr.com
+$ mv janusxr.com world1.com         # hint homepage room (world1.html) sidecarfile
+$ ./world1.com                       
+✅ detected /world1.html (setting as spatial home)
+I2026-01-19T15:41:10 (srvr) listen http://127.0.0.1:8080
+I2026-01-19T15:41:10 (srvr) listen http://192.168.1.168:8080
+Launching browser..
+```
+
+Profit! You can now send `world1.com` to a friend, and his browser will launch straight into world1.html 
+
+> NOTE: you can also point directly to a 3D model (`foo.com` would load `foo.glb`) or PDF-file etc!
+</details>
+
+
+<details>
+<summary><b>Usecase:</b> run as a docker</summary>
+<br>
+You can run our docker-image as following:
+
+```
+$ docker run -p 8080:8080 codeberg.org/coderofsalvation/janusxr:1.5.56
+```
+
+Profit! You can now point your browser to `http://localhost:8080` or configure your reverseproxy for SSL certs/domain etc.<br>
+Or optionally, serve your own XR experiences with it:
+
+```
+$ ls
+myworld1.xml myworld2.html myworld3.glb
+$ 
+$ docker run -p 8081:8080 -v $(pwd):/data codeberg.org/coderofsalvation/janusxr:1.5.56 /www/janusxr.com -D /data
+```
+
+Profit! You can now use URLs like `http://localhost:8080/#janus.url=https://localhost:8080/myworld1.xml` e.g.<br>
+Btw. you can build the docker image yourself too:
+
+```
+$ utils/release.binary.sh # build the janusxr.com binary 
+$ docker build -t janusxr.com .
+$ docker run -p 8080:8080 janusxr
+```
+
+</summary>
+</details>
+
+<details>
+<summary><b>Usecase:</b> serve all-in-one-binary in different docker/OCI container</summary>
+<br>
+
+Make sure to run you're in a folder with your JanusXR rooms or 3D models, and `janusxr.com`
+
+```
+$ ls 
+janusxr.com
+
+$ unzip janusxr.com          # extract the viewer files
+
+$ ls 
+janusxr.com
+world1.html
+world2.html
+foo.glb
+
+$ docker run -d -v ./:/www -p 8080:8080 --name janusweb busybox:latest /bin/httpd -f -h /www -p 8080
+e7928798379e872983b7ec9b89237ebc
+
+$ docker ps
+CONTAINER ID  IMAGE                             COMMAND               CREATED         STATUS         PORTS                   NAMES
+6711ed9739f3  docker.io/library/busybox:latest  /bin/httpd -f -h ...  16 seconds ago  Up 16 seconds  0.0.0.0:8080->8080/tcp  janusweb
+```
+
+Profit! You can now point your browser to `http://127.0.0.1:8080` or configure your reverseproxy for SSL certs/domain etc.
+
+</details>
+
+<details>
+<summary><b>Usecase:</b> deploy janusweb as github/gitlab/codeforge webpage</summary>
+
+<br>
+*TODO* provide action-files
+</details>
+
+<details>
+<summary><b>Usecase:</b> get the latest build files</summary>
+
+<br>
+Sometimes, developers just want the latest janusweb **files**.<br>
+Good news, the executable is also a zip-file.<br>
+
+```
+$ ls 
+janusxr.com
+$ unzip janusxr.com
+$ ls
+index.html
+janusweb.js
+(...)
+
+$ janusxr.com 
+I2026-01-19T15:41:10 (srvr) listen http://127.0.0.1:8080
+I2026-01-19T15:41:10 (srvr) listen http://192.168.1.168:8080
+Launching browser..
+
+( the webserver will prioritize the unzipped files )
+
+$ zip janusxr.com index.html   # you can even update the binary 
+```
+
+> Profit!
+
+</details>
 
 ### Pull our scripts into your page
-Using the above method, all of your links would go through our servers.  If you'd prefer to 
+Using the above method, all of your links would go through community CORS-proxies. If you'd prefer to 
 link to your own servers, you can pull our JS into your page and use JanusWeb as a scriptable
 client via its API.  This looks something like this:
 
@@ -91,13 +275,38 @@ client via its API.  This looks something like this:
 ```
 
 The `elation.janusweb.init()` function can take a number of arguments, and returns a promise which
-receives an instance of the client.  This client reference can be controlled via its API.  See the 
-sections on **Arguments** and **Scripting** below.
+receives an instance of the client.  This client reference can be controlled via its API:
 
-See also **Using a specific version of JanusWeb** below.
+```html
+<html>
+  <head>
+    <title>My JanusVR Room</title>
+  </head>
+  <body>
+    <script src="https://web.janusvr.com/janusweb.js"></script>
+    <script>
+        elation.janusweb.init({url: document.location.href })
+        .then( (client)=> console.log("rendering this page's virtual twin") )
+    </script>
+
+    <!-- 
+    <fireboxroom>
+      <room use_local_asset="room1">
+        <object id="cube" pos="0 1 5" />
+        <text col="1 0 0" pos="0 2 4">my first room</text>
+      </room>
+    </fireboxroom>
+    -->
 
-### Install from ZIPs
-(TODO - we will start shipping zip builds of JanusWeb once we release v1.0)
+  </body>
+</html>
+```
+
+> **NOTE**: you can also update the `janusxr.com` binary to your likings: (`unzip janusxr.com index.html && vi index.html && zip janusxr.com index.html` see 'get the latest build files' above)
+
+See the sections on **Arguments** and **Scripting** below.
+
+> See also **Using a specific version of JanusWeb** below.
 
 ### Install from NPM
 (TODO - we will start shipping official NPM packages of JanusWeb once we release v1.0)
@@ -126,7 +335,9 @@ JanusWeb supports several arguments at initialization time to control how it beh
 <table>
   <tr><th> Name           </th><th> Description                            </th><th> Default                  </th></tr>
 
-  <tr><td> autoload       </td><td> Load URL by default or wait for script </td><td> true                     </td></tr>
+  <tr><td> autostart      </td><td> call `elation.janusweb.init({..})` automatically or manually </td><td> true                     </td></tr>
+
+  <tr><td> autoload      </td><td> Load URL by default or wait for script </td><td> true                     </td></tr>
 
   <tr><td> crosshair      </td><td> Show player crosshair                  </td><td> true                     </td></tr>
 
@@ -142,10 +353,6 @@ JanusWeb supports several arguments at initialization time to control how it beh
 
   <tr><td> server         </td><td> Presence server to connect to          </td><td> wss://presence.janusvr.com:5567/</td></tr>
 
-  <tr><td> shownavigation </td><td> Control visibility of navigation bar   </td><td> true                     </td></tr>
-
-  <tr><td> showchat       </td><td> Control visibility of chat             </td><td> true                     </td></tr>
-
   <tr><td> stats          </td><td> Enable render performance stats        </td><td> false                    </td></tr>
 
   <tr><td> url            </td><td> Default page to load                   </td><td> (homepage)               </td></tr>
@@ -160,12 +367,18 @@ JanusWeb supports several arguments at initialization time to control how it beh
                                     for Opus via WebAudio)                 </td><td> false                    </td></tr>
 </table>
 
+> NOTE: see [client.js](https://github.com/jbaicoianu/janusweb/blob/master/scripts/client.js#L65) for the most up to date arguments 
+
 ## Scripting
 After initializing the client, `elation.janusweb.init()` returns a Promise which provides a reference to the client.
 You can programatically control this client to do all sorts of things.  For instance, we can make the client load a
 URL, wait for the world and all of its assets to load, and then take a screenshot of the world after a specified delay:
 
 ```javascript
+<janus-viewer autostart="false">     <!-- disable autostart, we will   -->
+</janus-viewer>                      <!-- call elation.janusweb.init() -->
+
+<script>
 var pageinfo = elation.utils.parseURL(document.location.href),
     urlargs = pageinfo.args || {},
     hashargs = pageinfo.hash || {};
@@ -173,11 +386,11 @@ var pageinfo = elation.utils.parseURL(document.location.href),
 var url = elation.utils.any(hashargs.url, urlargs.url, 'http://www.janusvr.com/index.html'),
     delay = elation.utils.any(hashargs.delay, urlargs.delay, 1000);
 
-elation.janusweb.init({
+elation.janusweb.init({ 
   url: url,
   resolution: '1920x1080',
-  showchat: false,
-  shownavigation: false
+  uiconfig: "./media/assets/webui/default.json" // tweak ui here
+  // more options at https://github.com/jbaicoianu/janusweb/blob/master/scripts/client.js#L93
 }).then(function(client) {
   elation.events.add(client.janusweb.currentroom, 'room_load_complete', function() {
     setTimeout(function() {
@@ -188,7 +401,9 @@ elation.janusweb.init({
       });
     }, delay);
   });
+  elation.janusweb.init = function(){} // init only once 
 });
+</script>
 
 ```
 
@@ -209,6 +424,30 @@ If you need to load a specific version of JanusWeb, all previous versions are st
 
 JanusWeb versions follow the [Semantic Versioning 2.0.0](http://semver.org/) spec, which follows the format ```<major>.<minor>.<patch>``` - for example, at the time of writing (March 2017) the current stable release is **1.0.15**.  So if you want to view this version, you could go to https://web.janusvr.com/1.0.15/ and if you wanted to pull this specific version into your page, you could do so with ```<script src="https://web.janusvr.com/1.0.15/janusweb.js"></script>```.  We also support aliases for the most current version - for instance, https://web.janusvr.com/1.0/ will always refer to the most recent 1.0 release, https://web.janusvr.com/0.9/ the final 0.9 release, etc.
 
+## Ecosystem
+
+Platforms using JanusXR + JanusWeb:
+
+|    | URL | source / docker |
+|----|-----|------------|
+| <img src="https://imgur.com/JMYi81Z.png"/><br><br> | [vesta.janusxr.org](https://vesta.janusxr.org) | |
+| <img src="https://codeberg.org/coderofsalvation/xrforge/media/branch/master/xrforge.jpg"/><br><br> | [xrforge.isvery.ninja](https://xrforge.isvery.ninja) | [codeberg.org](https://codeberg.org/coderofsalvation/xrforge)
+
+Visualisations of hyperlinked Janus clusters across the web:
+* [augmentedperception.com](https://augmentedperception.com) 
+* [panopticon](https://panopticon.spyduck.net/) 
+
+Extra Tools / Components:
+* [custom components](https://github.com/jbaicoianu/janus-custom-components)
+* [janusxr-cli](https://github.com/coderofsalvation/janusxr-cli) swiss army CLI knife for room health/preservation #cli
+* [corsanywhere](https://github.com/Rob--W/cors-anywhere) for hasslefree hopping clusters #stack
+* [janus-gateway](https://janus.conf.meetecho.com/) webrtc/voip-layer [docs](https://janus.conf.meetecho.com/) #stack
+* [janus-server](https://github.com/janusvr/janus-server) multiuser presence layer #stack
+
+Reference:
+* [quick scripting reference](https://github.com/jbaicoianu/janusweb/wiki/Scripting-Support-2.0)
+* [janus guide](https://coderofsalvation.github.io/janus-guide/)
+
 ## Contributing
 JanusWeb is open source, and we welcome any contributions!  Please do report bugs using GitHub Issues,
 and all pull requests will be considered.  We could especially use help with documentation!

package/janusxr.com/.args

@@ -0,0 +1,2 @@
+-D
+.

package/janusxr.com/.init.lua

@@ -0,0 +1,30 @@
+HidePath("/usr/share/zoneinfo/")
+HidePath("/usr/share/ssl/")
+homepage = false
+homepath = false
+home = arg[-1]:gsub(".*/","")
+              :gsub(".com","")
+ext = { "txt", "xml", "html", "pdf", "mp3", "yaml", "json", "xlsx", "png", "jpg", "glb", "gltf", "dae", "obj"}
+for k,v in pairs(ext) do
+  file = string.format("%s.%s", home, v)
+  if( path.exists( file ) ) then homepath = "/" .. file; end
+end
+
+if( homepath ) then 
+  print("✅ detected " .. homepath .. " (setting as spatial home)")
+  homepage = Slurp("/zip/index.html"):gsub("<janus%-viewer .-</janus%-viewer>","<janus-viewer src=\"" .. homepath .. "\"></janus-viewer>")
+
+  function OnHttpRequest()
+    path = GetPath()
+    if( homepage and path == "/" ) then
+      SetStatus(200)
+      SetHeader("Content-Type", "text/html; charset=utf-8")
+      SetHeader("Access-Control-Allow-Origin", "*")
+      Write(homepage)
+    else
+      Route()
+    end
+  end
+end
+LaunchBrowser()
+

package/media/assets/webui/apps/comms/voip.js

@@ -681,35 +681,37 @@ console.log('[voip-remoteuser] got a remote voip user', data);
       this.audio = audio;
       this.appendChild(audio);
 
-      audio.play()
-        .then(() => {
-          console.log('[voip-remoteuser] remote user audio playing', audio, this);
-          this.hasaudio = true;
-        });
+      room.getAudioNodes().then(() => {
+        audio.play()
+          .then(() => {
+            console.log('[voip-remoteuser] remote user audio playing', audio, this);
+            this.hasaudio = true;
+          });
 
-      let listener = player.engine.systems.sound.getRealListener();
-      let context = listener.context;
-      let analyser = context.createAnalyser();
-      let source = context.createMediaStreamSource(audio.srcObject);
-      source.connect(analyser);
+        let listener = player.engine.systems.sound.getRealListener();
+        let context = listener.context;
+        let analyser = context.createAnalyser();
+        let source = context.createMediaStreamSource(audio.srcObject);
+        source.connect(analyser);
 
-      analyser.fftSize = 32;
-      this.analyser = analyser;
-      this.audiobuffer = new Uint8Array(analyser.frequencyBinCount);
+        analyser.fftSize = 32;
+        this.analyser = analyser;
+        this.audiobuffer = new Uint8Array(analyser.frequencyBinCount);
 
-      if (this.updateVolumeInterval) {
-        clearInterval(this.updateVolumeInterval);
-        this.updateVolumeInterval = false;
-      }
-      this.updateVolumeInterval = setInterval(() => {
-        analyser.getByteFrequencyData(this.audiobuffer);
-        let sum = 0;
-        for (let i = 0; i < this.audiobuffer.length; i++) {
-          sum += this.audiobuffer[i];
+        if (this.updateVolumeInterval) {
+          clearInterval(this.updateVolumeInterval);
+          this.updateVolumeInterval = false;
         }
-        let avg = sum / this.audiobuffer.length;
-        this.updateVolume(avg / 100);
-      }, 20);
+        this.updateVolumeInterval = setInterval(() => {
+          analyser.getByteFrequencyData(this.audiobuffer);
+          let sum = 0;
+          for (let i = 0; i < this.audiobuffer.length; i++) {
+            sum += this.audiobuffer[i];
+          }
+          let avg = sum / this.audiobuffer.length;
+          this.updateVolume(avg / 100);
+        }, 20);
+      });
     }
 
     let remoteuser = janus.network.remoteplayers[this.id];

package/media/assets/webui/apps/editor/editor.js

@@ -320,7 +320,23 @@ console.log('set translation snap', ev.data, ev);
   }
   handleExportClick(ev) {
     let exporter = new THREE.GLTFExporter();
+    let userDatas = new Map();
+    // Store and nullify userData objects for each object before serializing
+    room._target.objects['3d'].traverse(n => {
+      userDatas.set(n, n.userData);
+      n.userData = {};
+      elation.events.fire({element: this, type: 'webui_editor_export_node', data:{n,userData: userDatas.get(n)} })
+    });
+    elation.events.fire({element: this, type: 'webui_editor_export', data:{ scene: room._target.objects['3d']} })
+
     exporter.parse(room._target.objects['3d'], (data) => {
+      // Restore userData objects
+      room._target.objects['3d'].traverse(n => {
+        if (userDatas.has(n)) {
+          n.userData = userDatas.get(n);
+        }
+      });
+
       let filedata = new Blob([data], {type: 'model/gltf-binary'});
 
       var url = window.URL.createObjectURL(filedata);

package/media/assets/webui/apps/locomotion/locomotion-assets.json

@@ -0,0 +1,3 @@
+[
+  { "assettype": "sound", "name": "button-teleport", "src": "./teleport.mp3" }
+]