Project

General

Profile

Wiki » History » Version 40

Josip Almasi, 10/15/2021 04:52 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 23 Josip Almasi
h2. Playgrounds
24
25
Multi-user interaction, shared objects: https://playground.babylonjs.com/#ZBK155
26
Multi-user world: https://playground.babylonjs.com/#Y6ILJ5
27
Avatar selection, portals: https://playground.babylonjs.com/#HDV7LA
28 24 Josip Almasi
VR Avatar template world: https://www.babylonjs-playground.com/#VXA0R3
29 23 Josip Almasi
30 17 Josip Almasi
h1. Frequently Asked Questions
31
32
h2. Is this open source, free to use and share?
33
34
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.
35
36
h2. Is there any documentation?
37
38
This is good place to start, this page links to all available resources.
39
40
h2. How many users can share a “world/space” simultaneously?
41
42
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.
43
44 39 Josip Almasi
h2. How can I implement custom authentication and/or authorization?
45 1 Josip Almasi
46 39 Josip Almasi
Typically you will authenticate users on your web server, before they enter the world. 
47
If that's not enough, you can implement your own "ClientFactory":https://github.com/jalmasi/vrspace/blob/master/server/src/main/java/org/vrspace/server/core/ClientFactory.java and configure it in "application.properties":https://github.com/jalmasi/vrspace/blob/master/server/src/main/resources/application.properties file.
48 1 Josip Almasi
This allows you to do your own database queries, REST calls or whatever else you may need to identify your users.
49
50 39 Josip Almasi
h2. How is that different from a game server?
51 38 Josip Almasi
52 40 Josip Almasi
It's not all that different, though the emphasis is different: vrspace.org is not focused on games specifically. It's more about multi-user 3D web, in particular WebXR, open standards and open source.
53 39 Josip Almasi
So while game servers usually don't bother with video/audio streaming, vrspace.org provides it out of the box, using WebRTC. On the other hand, there's nothing like game level in vrspace.org.
54 38 Josip Almasi
55 4 Josip Almasi
h1. Setting up development environment
56
57
Here's all you need to start development on Windows.
58 20 Josip Almasi
Linux distributions include all these tools as native packages, so no additional downloads should be required.
59 4 Josip Almasi
60
h2. Basic setup
61
62
h3. Git bash
63
64
IDEs can work with github directly, but whatever you ask, you'll get a command line answer.
65
Command line git is simply a must have. Bash also includes a lot of goodies like ssh.
66
67
https://git-scm.com/downloads
68
69
h3. Java
70
71 21 Josip Almasi
Java 8 will work, java 11 recommended. JDK is required to build the server.
72
Get it either from Oracle or elsewhere, e.g. Zulu OpenJDK: https://www.azul.com/downloads/zulu-community/?package=jdk
73 4 Josip Almasi
74
h3. Node.js
75
76
Node is used by IDE to evaluate javascript. You'll also may need it if you modify any of babylon.js source.
77
Mind that IDE will complain if you installed unsupported version of Node; should that happen, remove Node, and install latest one supported.
78
79
Get it from https://nodejs.org/
80
81 19 Josip Almasi
h3. Maven
82
83
Apache Maven is used to build the server from command prompt.
84
85
Get it from https://maven.apache.org/download.cgi
86
87
88 4 Josip Almasi
h3. IDE
89
90
Eclipse for Java developers (not enterprise), with Spring and Web plugins:
91
92
Download eclipse here: https://www.eclipse.org/
93
94
And then go to Help -> Eclipse Marketplace
95
Search and install Spring Tools 4 and Wild Web Developer plugins.
96
97 6 Josip Almasi
You'll also need to download and install https://projectlombok.org/
98 8 Josip Almasi
Once done, restart the eclipse.
99 6 Josip Almasi
100 5 Josip Almasi
h2. Import and start the project
101
102 22 Josip Almasi
h3. IDE
103
104 5 Josip Almasi
In Eclipse, you can use either default or new workspace for the project.
105
Assuming you have cloned the project from the github, 
106
Go to File -> Open Projects From the Filesystem
107
Then choose vrspace directory.
108
109
This will import vrspace folders and project subfolders, click Finish.
110
111
In vrspace project folder, in src/main/java, there's org.vrspace.server.ServerApplication.java.
112
Open it, then right click on the code.
113
From the menu, choose either Run as or Debug as -> Spring Boot App.
114
115
Open http://localhost:8080/babylon/connect.html with two browsers, and navigate around.
116
117
That's all, you're all set!
118 22 Josip Almasi
119
h3. git bash
120
121
git clone https://github.com/jalmasi/vrspace.git
122
cd vrspace
123
mvn clean install
124
java -jar server/target/server-0.2.2.jar
125 4 Josip Almasi
126
h2. Advanced setup
127
128 12 Josip Almasi
h3. SSL
129 4 Josip Almasi
130 12 Josip Almasi
HTTPS is required for pretty much everything - WebXR, camera, mic access.
131
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:
132 1 Josip Almasi
133 12 Josip Almasi
<pre>
134
server.ssl.enabled=false
135
# default port 8080
136
#server.port=8443
137 13 Josip Almasi
</pre>
138 12 Josip Almasi
139
h3. Apache
140
141
Apache reverse proxy setup, linux, windows, TBD
142 4 Josip Almasi
143
h3. Docker and OpenVidu
144
145
OpenVidu voice/video chat server runs as docker image. This is only required for development of voice chat functions.
146
147 10 Josip Almasi
Local execution (development):
148 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
149 10 Josip Almasi
150
Running on server:
151 1 Josip Almasi
https://docs.openvidu.io/en/2.17.0/deployment/deploying-on-premises/
152 11 Josip Almasi
153
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
154 25 Josip Almasi
155
h1. Software Architecture
156 26 Josip Almasi
157
!https://redmine.vrspace.org/attachments/download/15/vrspace-diagram.png!
158
159
h2. Client-Server Communication
160
161 31 Josip Almasi
Clients communicate with server by sending JSON messages over "WebSockets":https://en.wikipedia.org/wiki/WebSocket. Reference javascript implementation of client communication layer is in "VRSpace.js":https://www.vrspace.org/docs/jsdoc/VRSpace.html.
162 26 Josip Almasi
163
General approach to communication is rather obscure Half-Object pattern: server-side and client-side object have same properties, but different implementations.
164
Whenever an object's property changes in (any) client's address space, it's transmitted to the server, that broadcasts it to all clients currently 'watching' the object.
165
166
Whenever a client wants to perform any change to any object in the space, it has to go through the VRSpace server.
167
Clients may or may not communicate directly, but this is out of the scope of VRSpace server.
168
169
h2. Server Responsibilities
170
171
Sole responsibility of VRSpace server is management of 3D space: persisting space objects, tracking their properties, processing and distributing events from/to objects.
172 27 Josip Almasi
Whenever we talk about objects, that includes clients, i.e. users - a client is a special case of an object.
173
The server does not even handle the authentication - it is assumed to be responsibility of web app serving the space.
174
3D geometry is also not in server's scope, it's just another property of an object (mesh).
175
176
h2. Server design
177
178
Key concepts here are Active Objects, Actor model, and Live distributed object.
179
180
"VRObject":https://github.com/jalmasi/vrspace/blob/master/server/src/main/java/org/vrspace/server/obj/VRObject.java is a basic shared object, with some basic properties like position and rotation, and of course, mesh. It essentially a "Live distributed object":https://en.wikipedia.org/wiki/Live_distributed_object.
181
182 28 Josip Almasi
"Client":https://github.com/jalmasi/vrspace/blob/master/server/src/main/java/org/vrspace/server/obj/Client.java extends VRObject, and adds capabilities to communicate over web sockets, and listen to changes to other objects. Typically, a client represents a remote user, but it can also represent a robot connected over a web socket, or be a base class for a server-side robot.
183
A Client can be thought of as "Active Object":https://en.wikipedia.org/wiki/Active_object or an "Actor":https://en.wikipedia.org/wiki/Actor_model, 
184 27 Josip Almasi
185
Server relies on Spring Boot and embedded Tomcat to handle all I/O and threads.
186 29 Josip Almasi
187 33 Josip Almasi
h3. Client
188 29 Josip Almasi
189 30 Josip Almasi
Each "Client":https://github.com/jalmasi/vrspace/blob/master/server/src/main/java/org/vrspace/server/obj/Client.java has it's own "Scene":https://github.com/jalmasi/vrspace/blob/master/server/src/main/java/org/vrspace/server/core/Scene.java that tracks all shared objects - including other clients - visible by the client. The scene is initially populated once the client logs in to the server, and starts the session. Scene is refreshed periodically, after a movement, or explicitly.
190 29 Josip Almasi
191
Scene maintains the event model, by adding the Client as listener to all other active objects (usually other users) in the scene.
192 1 Josip Almasi
193 30 Josip Almasi
Client simply notifies it's own listeners on any changes to any of it's own properties. As a listener, it propagates any observed change on any other object over the network, to the user.
194
195
Client has just a couple of persistent properties, like position, rotation and name. The name must be unique.
196
All other properties are transient.
197
198 33 Josip Almasi
"ClientFactory":https://github.com/jalmasi/vrspace/blob/master/server/src/main/java/org/vrspace/server/core/ClientFactory.java allows for customization of Client class and instances.
199 1 Josip Almasi
200 33 Josip Almasi
h3. Events and messages
201
202 30 Josip Almasi
Typically events exchanged are changes to properties of active objects, e.g. user moves around, changing own position and rotation. However, an object may emit any event, and the event gets propagated to all listeners.
203 1 Josip Almasi
This is to simplify client development: simply emit any custom event you want.
204 32 Josip Almasi
All distributed events are encapsulated in "VREvent":https://github.com/jalmasi/vrspace/blob/master/server/src/main/java/org/vrspace/server/dto/VREvent.java class.
205
206
However, there are other types of messages that are not distributed to other clients: commands and their return values, and errors.
207 1 Josip Almasi
Client will typically execute at least one command during the session - "Session":https://github.com/jalmasi/vrspace/blob/master/server/src/main/java/org/vrspace/server/dto/Session.java start. It will not receive any messages before that.
208
Should any server-side exception occur during the session, errors are sent to the client as simple JSON maps.
209 33 Josip Almasi
210
"WorldManager":https://github.com/jalmasi/vrspace/blob/master/server/src/main/java/org/vrspace/server/core/WorldManager.java manages clients and event distribution between them.
211
212
h3. Worlds
213
214
A server can host many worlds, i.e. shared spaces. A world contains users and other objects that are shared only within the world. It can be thought of as a chatroom, but mind the difference: being in the same world does not mean that users can see and talk to each other.
215
Client can enter another world by issuing "Enter":https://github.com/jalmasi/vrspace/blob/master/server/src/main/java/org/vrspace/server/dto/Enter.java command.
216
217 35 Josip Almasi
h3. Ownership and privacy
218
219
A class can be annotated as Owned, and all of instances automatically become owned as they are created. An owned object does not receive events from anyone by owner(s). A Client is owned, and nobody but himself can change his name.
220
On the other hand, a generic VRObject is public, and receives events from anyone. Like a door, anybody can open and close it. But even public objects can have some properties annotated as Owned, that can't be change by anyone but owner.
221
Fields of a class can be annotated as Private, and their contents will never be published.
222
223
"Dispatcher":https://github.com/jalmasi/vrspace/blob/master/server/src/main/java/org/vrspace/server/core/Dispatcher.java takes care of it before property changes are applied, and before they are published to listeners.
224
225 33 Josip Almasi
h3. Package structure
226
227
Package "org.vrspace.server":https://github.com/jalmasi/vrspace/tree/master/server/src/main/java/org/vrspace/server contains only main application class. Under it,
228
- config package contains server configuration classes that are executed only on server statup
229
- core is the core of the server
230 34 Josip Almasi
- dto is misnomer that stands Data Transfer Objects, though this package contains all objects that are not shared nor persisted
231 33 Josip Almasi
- obj contains persistent objects, most importantly Client and VRObject
232
- types are custom types used elsewhere, be it interfaces or annotations
233
- web is a primitive admin interface, disabled by default