Project

General

Profile

Wiki » History » Version 21

Josip Almasi, 05/07/2021 01:56 PM

1 4 Josip Almasi
{{toc}}
2
3 1 Josip Almasi
h1. Welcome!
4 2 Josip Almasi
5 18 Josip Almasi
h2. External resources
6 4 Josip Almasi
7 14 Josip Almasi
Demo site: https://www.vrspace.org/
8
9 15 Josip Almasi
Github project page: https://github.com/jalmasi/vrspace
10 2 Josip Almasi
11 16 Josip Almasi
OpenSource.com article (motivation): https://opensource.com/article/20/12/virtual-reality-server
12 3 Josip Almasi
13 15 Josip Almasi
VR Days video (features, technologies): https://vimeo.com/475142708
14 3 Josip Almasi
15 15 Josip Almasi
Youtube channel: https://www.youtube.com/channel/UCLdSg22i9MZ3u7ityj_PBxw
16 1 Josip Almasi
17 16 Josip Almasi
Facebook page: https://fb.com/vrspace.org
18 14 Josip Almasi
19
Client API jsdoc: https://www.vrspace.org/docs/jsdoc/index.html
20
21
Server javadoc: https://www.vrspace.org/docs/javadoc/index.html?overview-summary.html
22 4 Josip Almasi
23 17 Josip Almasi
h1. Frequently Asked Questions
24
25
h2. Is this open source, free to use and share?
26
27
Yes, it's all free and open. Server and client code is published under Apache 2 license, all 3D models published by their respective authors under Creative Commons Attribution license.
28
29
h2. Is there any documentation?
30
31
This is good place to start, this page links to all available resources.
32
33
h2. How many users can share a “world/space” simultaneously?
34
35
By default, number of users per space is not limited. There is a server parameter to limit that (org.vrspace.server.maxSessions) that can be specified either in config file or command line. Users that hit the limit remain in the queue for configurable timeout (org.vrspace.server.sessionStartTimeout, zero by default) until someone leaves. An error is raised on timeout.
36
37 4 Josip Almasi
h1. Setting up development environment
38
39
Here's all you need to start development on Windows.
40 20 Josip Almasi
Linux distributions include all these tools as native packages, so no additional downloads should be required.
41 4 Josip Almasi
42
h2. Basic setup
43
44
h3. Git bash
45
46
IDEs can work with github directly, but whatever you ask, you'll get a command line answer.
47
Command line git is simply a must have. Bash also includes a lot of goodies like ssh.
48
49
https://git-scm.com/downloads
50
51
h3. Java
52
53 21 Josip Almasi
Java 8 will work, java 11 recommended. JDK is required to build the server.
54
Get it either from Oracle or elsewhere, e.g. Zulu OpenJDK: https://www.azul.com/downloads/zulu-community/?package=jdk
55 4 Josip Almasi
56
h3. Node.js
57
58
Node is used by IDE to evaluate javascript. You'll also may need it if you modify any of babylon.js source.
59
Mind that IDE will complain if you installed unsupported version of Node; should that happen, remove Node, and install latest one supported.
60
61
Get it from https://nodejs.org/
62
63 19 Josip Almasi
h3. Maven
64
65
Apache Maven is used to build the server from command prompt.
66
67
Get it from https://maven.apache.org/download.cgi
68
69
70 4 Josip Almasi
h3. IDE
71
72
Eclipse for Java developers (not enterprise), with Spring and Web plugins:
73
74
Download eclipse here: https://www.eclipse.org/
75
76
And then go to Help -> Eclipse Marketplace
77
Search and install Spring Tools 4 and Wild Web Developer plugins.
78
79 6 Josip Almasi
You'll also need to download and install https://projectlombok.org/
80 8 Josip Almasi
Once done, restart the eclipse.
81 6 Josip Almasi
82 5 Josip Almasi
h2. Import and start the project
83
84
In Eclipse, you can use either default or new workspace for the project.
85
Assuming you have cloned the project from the github, 
86
Go to File -> Open Projects From the Filesystem
87
Then choose vrspace directory.
88
89
This will import vrspace folders and project subfolders, click Finish.
90
91
In vrspace project folder, in src/main/java, there's org.vrspace.server.ServerApplication.java.
92
Open it, then right click on the code.
93
From the menu, choose either Run as or Debug as -> Spring Boot App.
94
95
Open http://localhost:8080/babylon/connect.html with two browsers, and navigate around.
96
97
That's all, you're all set!
98 4 Josip Almasi
99
h2. Advanced setup
100
101 12 Josip Almasi
h3. SSL
102 4 Josip Almasi
103 12 Josip Almasi
HTTPS is required for pretty much everything - WebXR, camera, mic access.
104
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:
105 1 Josip Almasi
106 12 Josip Almasi
<pre>
107
server.ssl.enabled=false
108
# default port 8080
109
#server.port=8443
110 13 Josip Almasi
</pre>
111 12 Josip Almasi
112
h3. Apache
113
114
Apache reverse proxy setup, linux, windows, TBD
115 4 Josip Almasi
116
h3. Docker and OpenVidu
117
118
OpenVidu voice/video chat server runs as docker image. This is only required for development of voice chat functions.
119
120 10 Josip Almasi
Local execution (development):
121 11 Josip Almasi
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
122 10 Josip Almasi
123
Running on server:
124 1 Josip Almasi
https://docs.openvidu.io/en/2.17.0/deployment/deploying-on-premises/
125 11 Josip Almasi
126
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