VRSpace.org

{{toc}}

h1. Welcome!

External resources:

Github page: https://github.com/jalmasi/vrspace

Facebook page: https://fb.com/vrspace.org

Youtube channel: https://www.youtube.com/channel/UCLdSg22i9MZ3u7ityj_PBxw

VR Days video: https://vimeo.com/475142708

OpenSource.com article: https://opensource.com/article/20/12/virtual-reality-server

h1. Setting up development environment

Here's all you need to start development on Windows.

h2. Basic setup

h3. Git bash

IDEs can work with github directly, but whatever you ask, you'll get a command line answer.

Command line git is simply a must have. Bash also includes a lot of goodies like ssh.

https://git-scm.com/downloads

h3. Java

Java 8 will work, java 11 recommended. Get it either from Oracle or elsewhere, e.g. Zulu OpenJDK: https://www.azul.com/downloads/zulu-community/?package=jdk

h3. Node.js

Node is used by IDE to evaluate javascript. You'll also may need it if you modify any of babylon.js source.

Mind that IDE will complain if you installed unsupported version of Node; should that happen, remove Node, and install latest one supported.

Get it from https://nodejs.org/

h3. IDE

Eclipse for Java developers (not enterprise), with Spring and Web plugins:

Download eclipse here: https://www.eclipse.org/

And then go to Help -> Eclipse Marketplace

Search and install Spring Tools 4 and Wild Web Developer plugins.

You'll also need to download and install https://projectlombok.org/

Once done, restart the eclipse.

h2. Import and start the project

In Eclipse, you can use either default or new workspace for the project.

Assuming you have cloned the project from the github, 

Go to File -> Open Projects From the Filesystem

Then choose vrspace directory.

This will import vrspace folders and project subfolders, click Finish.

In vrspace project folder, in src/main/java, there's org.vrspace.server.ServerApplication.java.

Open it, then right click on the code.

From the menu, choose either Run as or Debug as -> Spring Boot App.

Open http://localhost:8080/babylon/connect.html with two browsers, and navigate around.

That's all, you're all set!

h2. Advanced setup

h3. Apache

Apache as reverse proxy provides SSL, which is required for both VR and audio streaming.

I.e. browsers don't trust even the localhost, and enforce SSL.

TBD

h3. Docker and OpenVidu

OpenVidu voice/video chat server runs as docker image. This is only required for development of voice chat functions.

Local execution (development):

docker run -p 4443:4443 --rm -e OPENVIDU_SECRET=MY_SECRET -e DOMAIN_OR_PUBLIC_IP= *YOUR_IP* openvidu/openvidu-server-kms:2.17.0

Running on server:

https://docs.openvidu.io/en/2.17.0/deployment/deploying-on-premises/