Project

General

Profile

Wiki » History » Version 42

Josip Almasi, 10/17/2021 04:38 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 42 Josip Almasi
h2. How does inverse kinematics and motion tracking work in vrspace.org characters?
56 41 Josip Almasi
57
Everything is encapsulated Avatar class, but relies on observed glTF avatar structure.
58
59 4 Josip Almasi
h1. Setting up development environment
60
61
Here's all you need to start development on Windows.
62 20 Josip Almasi
Linux distributions include all these tools as native packages, so no additional downloads should be required.
63 4 Josip Almasi
64
h2. Basic setup
65
66
h3. Git bash
67
68
IDEs can work with github directly, but whatever you ask, you'll get a command line answer.
69
Command line git is simply a must have. Bash also includes a lot of goodies like ssh.
70
71
https://git-scm.com/downloads
72
73
h3. Java
74
75 21 Josip Almasi
Java 8 will work, java 11 recommended. JDK is required to build the server.
76
Get it either from Oracle or elsewhere, e.g. Zulu OpenJDK: https://www.azul.com/downloads/zulu-community/?package=jdk
77 4 Josip Almasi
78
h3. Node.js
79
80
Node is used by IDE to evaluate javascript. You'll also may need it if you modify any of babylon.js source.
81
Mind that IDE will complain if you installed unsupported version of Node; should that happen, remove Node, and install latest one supported.
82
83
Get it from https://nodejs.org/
84
85 19 Josip Almasi
h3. Maven
86
87
Apache Maven is used to build the server from command prompt.
88
89
Get it from https://maven.apache.org/download.cgi
90
91
92 4 Josip Almasi
h3. IDE
93
94
Eclipse for Java developers (not enterprise), with Spring and Web plugins:
95
96
Download eclipse here: https://www.eclipse.org/
97
98
And then go to Help -> Eclipse Marketplace
99
Search and install Spring Tools 4 and Wild Web Developer plugins.
100
101 6 Josip Almasi
You'll also need to download and install https://projectlombok.org/
102 8 Josip Almasi
Once done, restart the eclipse.
103 6 Josip Almasi
104 5 Josip Almasi
h2. Import and start the project
105
106 22 Josip Almasi
h3. IDE
107
108 5 Josip Almasi
In Eclipse, you can use either default or new workspace for the project.
109
Assuming you have cloned the project from the github, 
110
Go to File -> Open Projects From the Filesystem
111
Then choose vrspace directory.
112
113
This will import vrspace folders and project subfolders, click Finish.
114
115
In vrspace project folder, in src/main/java, there's org.vrspace.server.ServerApplication.java.
116
Open it, then right click on the code.
117
From the menu, choose either Run as or Debug as -> Spring Boot App.
118
119
Open http://localhost:8080/babylon/connect.html with two browsers, and navigate around.
120
121
That's all, you're all set!
122 22 Josip Almasi
123
h3. git bash
124
125
git clone https://github.com/jalmasi/vrspace.git
126
cd vrspace
127
mvn clean install
128
java -jar server/target/server-0.2.2.jar
129 4 Josip Almasi
130
h2. Advanced setup
131
132 12 Josip Almasi
h3. SSL
133 4 Josip Almasi
134 12 Josip Almasi
HTTPS is required for pretty much everything - WebXR, camera, mic access.
135
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:
136 1 Josip Almasi
137 12 Josip Almasi
<pre>
138
server.ssl.enabled=false
139
# default port 8080
140
#server.port=8443
141 13 Josip Almasi
</pre>
142 12 Josip Almasi
143
h3. Apache
144
145
Apache reverse proxy setup, linux, windows, TBD
146 4 Josip Almasi
147
h3. Docker and OpenVidu
148
149
OpenVidu voice/video chat server runs as docker image. This is only required for development of voice chat functions.
150
151 10 Josip Almasi
Local execution (development):
152 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
153 10 Josip Almasi
154
Running on server:
155 1 Josip Almasi
https://docs.openvidu.io/en/2.17.0/deployment/deploying-on-premises/
156 11 Josip Almasi
157
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
158 25 Josip Almasi
159
h1. Software Architecture
160 26 Josip Almasi
161
!https://redmine.vrspace.org/attachments/download/15/vrspace-diagram.png!
162
163
h2. Client-Server Communication
164
165 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.
166 26 Josip Almasi
167
General approach to communication is rather obscure Half-Object pattern: server-side and client-side object have same properties, but different implementations.
168
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.
169
170
Whenever a client wants to perform any change to any object in the space, it has to go through the VRSpace server.
171
Clients may or may not communicate directly, but this is out of the scope of VRSpace server.
172
173
h2. Server Responsibilities
174
175
Sole responsibility of VRSpace server is management of 3D space: persisting space objects, tracking their properties, processing and distributing events from/to objects.
176 27 Josip Almasi
Whenever we talk about objects, that includes clients, i.e. users - a client is a special case of an object.
177
The server does not even handle the authentication - it is assumed to be responsibility of web app serving the space.
178
3D geometry is also not in server's scope, it's just another property of an object (mesh).
179
180
h2. Server design
181
182
Key concepts here are Active Objects, Actor model, and Live distributed object.
183
184
"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.
185
186 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.
187
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, 
188 27 Josip Almasi
189
Server relies on Spring Boot and embedded Tomcat to handle all I/O and threads.
190 29 Josip Almasi
191 33 Josip Almasi
h3. Client
192 29 Josip Almasi
193 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.
194 29 Josip Almasi
195
Scene maintains the event model, by adding the Client as listener to all other active objects (usually other users) in the scene.
196 1 Josip Almasi
197 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.
198
199
Client has just a couple of persistent properties, like position, rotation and name. The name must be unique.
200
All other properties are transient.
201
202 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.
203 1 Josip Almasi
204 33 Josip Almasi
h3. Events and messages
205
206 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.
207 1 Josip Almasi
This is to simplify client development: simply emit any custom event you want.
208 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.
209
210
However, there are other types of messages that are not distributed to other clients: commands and their return values, and errors.
211 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.
212
Should any server-side exception occur during the session, errors are sent to the client as simple JSON maps.
213 33 Josip Almasi
214
"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.
215
216
h3. Worlds
217
218
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.
219
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.
220
221 35 Josip Almasi
h3. Ownership and privacy
222
223
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.
224
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.
225
Fields of a class can be annotated as Private, and their contents will never be published.
226
227
"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.
228
229 33 Josip Almasi
h3. Package structure
230
231
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,
232
- config package contains server configuration classes that are executed only on server statup
233
- core is the core of the server
234 34 Josip Almasi
- dto is misnomer that stands Data Transfer Objects, though this package contains all objects that are not shared nor persisted
235 33 Josip Almasi
- obj contains persistent objects, most importantly Client and VRObject
236
- types are custom types used elsewhere, be it interfaces or annotations
237
- web is a primitive admin interface, disabled by default