• Table of contents
• Welcome!
• Setting up development environment
  • Basic setup
    • Git bash
    • Java
    • Node.js
    • IDE
  • Import and start the project
  • Advanced setup
    • SSL
    • Apache
    • Docker and OpenVidu

Welcome!¶

External resources:

Demo site: https://www.vrspace.org/

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

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

VR Days video (features, technologies): https://vimeo.com/475142708

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

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

Client API jsdoc: https://www.vrspace.org/docs/jsdoc/index.html

Server javadoc: https://www.vrspace.org/docs/javadoc/index.html?overview-summary.html

Setting up development environment¶

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

Basic setup¶

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

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

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/

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.

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!

Advanced setup¶

SSL¶

HTTPS is required for pretty much everything - WebXR, camera, mic access.
By default, the server runs on 8080 port with plain HTTP. To enable HTTPS, edit application.properties (found in src/main/resources), and change following properties:

server.ssl.enabled=false
# default port 8080
#server.port=8443

Apache¶

Apache reverse proxy setup, linux, windows, TBD

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=YOUR_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/

Then either modify openvidu.publicurl and openvidu.secret in application.properties, or run server.jar with -Dopenvidu.publicurl=YOUR_URL and -Dopenvidu.secret=YOUR_SECRET