https://janusvr.github.io/guide/

Documentation and guides on building with Janus VR
https://janusvr.github.io/guide/

Last synced: about 1 month ago
JSON representation

Documentation and guides on building with Janus VR

• Host: GitHub
• URL: https://janusvr.github.io/guide/
• Owner: janusvr
• License: mit
• Created: 2019-08-19T17:14:29.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-02-05T07:57:13.000Z (almost 2 years ago)
• Last Synced: 2024-08-02T06:13:15.678Z (4 months ago)
• Size: 315 KB
• Stars: 5
• Watchers: 2
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-metaverse - Janus Guide - Learn to build open source self-hosted virtual worlds (Social VR / Open Source Frameworks)
• awesome-metaverse-zh - Janus Guide - JanusXR 是一个开源的 3D 浏览器和可视化编辑器 (社交虚拟现实（Social VR）)

README

        
# Guide

## :books: Documention for building with Janus VR

Table of Contents

:wrench: **Build**: Create immersive worlds with JML

- [Assets](https://github.com/janusvr/guide/blob/master/docs/build/assets.md) - List of assets that can be used throughout a web space

- [Javascript](https://github.com/janusvr/guide/blob/master/docs/build/javascript.md) - Overview of the scripting compatible with janus native

- [Rooms](https://github.com/janusvr/guide/blob/master/docs/build/room.md) - Section of JML that declares how assets appear in the web space

- [Server](https://github.com/janusvr/guide/blob/master/docs/build/server.md) - Server API for the networking layer (WIP)

:notebook: **Guides**: Useful tutorials made by the community

- [Unity to JanusVR](https://github.com/janusvr/guide/blob/master/docs/guide/unity.md) - Guide on exporting unity scenes to webvr compatible JML

- [Vesta Basics](https://github.com/janusvr/guide/blob/master/guide/tutorials/vestabasics.md) - Tutorial on how to use Vesta with native client editor

- [Collision Meshes](https://github.com/janusvr/guide/blob/master/guide/tutorials/Collision-Meshes.md) - How to create your own collision mesh for use in janusweb

:mount_fuji: **[JanusWeb](https://github.com/jbaicoianu/janusweb)**: Web framework for building interconnected 3D experiences

- [Demo](https://web.janusvr.com/) - Walk through the Vesta frontpage in a procedural 3D world 

- [Vesta](https://vesta.janusvr.com/) - Social network for people to build and share WebVR content 

- [Examples](https://github.com/janusvr/janusvr-examples) - Download example janusweb files locally

- [Wiki](https://github.com/jbaicoianu/janusweb/wiki) - The janusweb wiki located on the Github repo

- [Custom Components](https://github.com/janusvr/janus-custom-components) - The current collection of ready to use janusweb custom components

:pushpin: **Useful links**

- [JML Documentation](http://janusvr.com/docs/build/introtojml/index.html) - **Official** documentation site for JML

- [JML Cheat sheet](https://github.com/janusvr/guide/blob/master/guide/cheatsheet.md) - Cheatsheet for mastering JML with code snippets

- [Janus Examples](https://github.com/janusvr/janusvr-examples) - Example rooms for people to download and test locally

- [Interactive Tutorials](https://github.com/jbaicoianu/janusvr-tutorials) - Prototype of an interactive tutorial for learning JML

- [Vesta Templates](https://vesta.janusvr.com/search/template/1) - Search through JML templates you can clone on Vesta

- [FireVR](https://github.com/spyduck/firevr) - Blender to JML Import/Export Addon with IPFS and Vesta support

***

:pencil2: **To do**

- [ ] install / download page

- [ ] use the program (controls)

- [ ] overview of current feature set

- [ ] main background image

- [ ] collapsable sidebar menus

- [ ] update all the pictures

- [ ] cover missing features

- [ ] add more information about light / shadow in a blog

- [ ] add links to demos of examples for people to experiment

- [ ] spicy tutorials with links to the 'ingredients' in recipe

- [x] test frameworks to autogen beautiful themed documentation sites