Project

General

Profile

Wiki » History » Version 57

Josip Almasi, 12/07/2021 01:27 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 45 Josip Almasi
h2. I want to build my space, where do I start?
41
42 46 Josip Almasi
This question prompted writing Getting Started section of this wiki, but set up basic development environment first.
43
You don't need to modify any of the server code, but you need to be able to get it from github and build it.
44
Once you do, start it up, and everything else is html 5 and javascript ES6.
45 45 Josip Almasi
46 17 Josip Almasi
h2. How many users can share a “world/space” simultaneously?
47
48
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.
49
50 39 Josip Almasi
h2. How can I implement custom authentication and/or authorization?
51 1 Josip Almasi
52 39 Josip Almasi
Typically you will authenticate users on your web server, before they enter the world. 
53
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.
54 1 Josip Almasi
This allows you to do your own database queries, REST calls or whatever else you may need to identify your users.
55
56 57 Josip Almasi
57 39 Josip Almasi
h2. How is that different from a game server?
58 38 Josip Almasi
59 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.
60 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.
61 38 Josip Almasi
62 42 Josip Almasi
h2. How does inverse kinematics and motion tracking work in vrspace.org characters?
63 41 Josip Almasi
64 44 Josip Almasi
Everything is encapsulated Avatar class, but relies on observed glTF avatar structure. Heuristics used to analyze the character structure is explained in depth in "this paper":https://redmine.vrspace.org/attachments/download/17/vrspace-characters.doc.
65 41 Josip Almasi
66 56 Josip Almasi
h2. Why websockets?
67
68
Since death of internet explorer, websockets just work, in any browser. Some reliable multicast protocol would do better job for object state distribution, but no such protocol is supported by web browsers. WebRTC on the other hand is widely supported, but is unreliable, and requires complex development environment setup.
69
70 47 Josip Almasi
h1. Getting started
71
72
So, you're new to VRSpace, and you want to make yourself a new virtual world.
73
You will not need to change any of the server code, but you need to get it from github, build it, and start it.
74
Once done, familiarize yourself with directory structure, and especially with template world, as this is intended stating point.
75
76
h2. Directory structure
77
78
h3. server
79
80
Contains the server code and configuration. Generally you don't need to change the code, but you may want to change the configuration. Main configuration file is in src/main/resources/application.properties, have a look at what you can change.
81 50 Josip Almasi
The server executable is a jar file in target subdirectory.
82 47 Josip Almasi
83
h3. babylon
84
85
This is reference Babylon.js client implementation. You don't really need any of it, but it is highly recommended to build on top of it, using javascript code provided there.
86
Html files there implement and/or test different functions available, like avatar loading and movement, video/audio streaming etc.
87
Most important one is avatar-selection.html, this is main entry point that allows user to select avatar and enter a world.
88
89
h3. web
90
91
This is the actual web site that's available online on vrspace.org, your final web site will probably look somewhat like this.
92
93
h3. content
94
95
Actual web content used to build virtual worlds, with self-explanatory directory names. Two of these contain special attention though:
96
97
h4. char
98
99
Characters, under female, male and other subdirectories. These directories are listed and presented by avatar-selection.html, you will probably to change how it works eventually.
100 48 Josip Almasi
But adding or removing characters is as simple as dropping them here.
101 47 Josip Almasi
102
h4. worlds
103
104 48 Josip Almasi
Available worlds, also listed by avatar-selection.html, and displayed as portals. Every subdirectory contains one world, and also note there's an image with the same name - that's thumbnail displayed on the portal.
105 49 Josip Almasi
Every world has some specific features.
106
Paris is huge, a real-life model.
107
Persian city and Aladin both feature the same procedural terrain and plants.
108 1 Josip Almasi
Cave is an actual game level, and utilizes floors built with vrspace.org floor editor.
109 50 Josip Almasi
Classrooom allows for sharing screen.
110
But the template is where you start - copy it over to another directory, and edit to suit your needs.
111
112
h2. Your first world
113
114 51 Josip Almasi
So with the server running, copy the template directory to your own. This world is immediately listed at http://localhost:8080/content/worlds/ and also available in http://localhost:8080/babylon/avatar-selection.html as a portal.
115 1 Josip Almasi
All you need to do to replace that dolphin with your own world is to replace this.file='dolphin.glb' in world.js with your own file name. Or really, delete the entire constructor, and save your world as scene.gltf in the same directory.
116 51 Josip Almasi
Hit reload button/key in your web browser, changes become visible immediately.
117 50 Josip Almasi
118
There are two files there, a html and a js, but html also contains some javascript.
119 52 Josip Almasi
The idea behind this separation of concerns is that world.js contains all programming logic that relates to the world itself, it should not depend on any server functionality. So build your world first, then add multi-user functions to it. Javascript in the world.html file shows some basic multiuser functions. As these grow, you'll probably want them in another javascript file, but these are minimum to get started.
120 50 Josip Almasi
121 51 Josip Almasi
Hopefully comments world.js and world.html explain enough to get started. As you need more functionality, look at other worlds and copy it over.
122 47 Josip Almasi
123 4 Josip Almasi
h1. Setting up development environment
124
125
Here's all you need to start development on Windows.
126 20 Josip Almasi
Linux distributions include all these tools as native packages, so no additional downloads should be required.
127 4 Josip Almasi
128
h2. Basic setup
129
130
h3. Git bash
131
132
IDEs can work with github directly, but whatever you ask, you'll get a command line answer.
133
Command line git is simply a must have. Bash also includes a lot of goodies like ssh.
134
135
https://git-scm.com/downloads
136
137
h3. Java
138
139 21 Josip Almasi
Java 8 will work, java 11 recommended. JDK is required to build the server.
140
Get it either from Oracle or elsewhere, e.g. Zulu OpenJDK: https://www.azul.com/downloads/zulu-community/?package=jdk
141 4 Josip Almasi
142
h3. Node.js
143
144
Node is used by IDE to evaluate javascript. You'll also may need it if you modify any of babylon.js source.
145
Mind that IDE will complain if you installed unsupported version of Node; should that happen, remove Node, and install latest one supported.
146
147
Get it from https://nodejs.org/
148
149 19 Josip Almasi
h3. Maven
150
151
Apache Maven is used to build the server from command prompt.
152
153
Get it from https://maven.apache.org/download.cgi
154
155
156 4 Josip Almasi
h3. IDE
157
158
Eclipse for Java developers (not enterprise), with Spring and Web plugins:
159
160
Download eclipse here: https://www.eclipse.org/
161
162
And then go to Help -> Eclipse Marketplace
163
Search and install Spring Tools 4 and Wild Web Developer plugins.
164
165 6 Josip Almasi
You'll also need to download and install https://projectlombok.org/
166 8 Josip Almasi
Once done, restart the eclipse.
167 6 Josip Almasi
168 5 Josip Almasi
h2. Import and start the project
169
170 22 Josip Almasi
h3. IDE
171
172 5 Josip Almasi
In Eclipse, you can use either default or new workspace for the project.
173
Assuming you have cloned the project from the github, 
174
Go to File -> Open Projects From the Filesystem
175
Then choose vrspace directory.
176
177
This will import vrspace folders and project subfolders, click Finish.
178
179
In vrspace project folder, in src/main/java, there's org.vrspace.server.ServerApplication.java.
180
Open it, then right click on the code.
181
From the menu, choose either Run as or Debug as -> Spring Boot App.
182
183
Open http://localhost:8080/babylon/connect.html with two browsers, and navigate around.
184
185
That's all, you're all set!
186 22 Josip Almasi
187
h3. git bash
188
189
git clone https://github.com/jalmasi/vrspace.git
190
cd vrspace
191
mvn clean install
192
java -jar server/target/server-0.2.2.jar
193 4 Josip Almasi
194
h2. Advanced setup
195
196 12 Josip Almasi
h3. SSL
197 4 Josip Almasi
198 12 Josip Almasi
HTTPS is required for pretty much everything - WebXR, camera, mic access.
199
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:
200 1 Josip Almasi
201 12 Josip Almasi
<pre>
202
server.ssl.enabled=false
203
# default port 8080
204
#server.port=8443
205 13 Josip Almasi
</pre>
206 12 Josip Almasi
207
h3. Apache
208
209
Apache reverse proxy setup, linux, windows, TBD
210 4 Josip Almasi
211
h3. Docker and OpenVidu
212
213
OpenVidu voice/video chat server runs as docker image. This is only required for development of voice chat functions.
214
215 10 Josip Almasi
Local execution (development):
216 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
217 10 Josip Almasi
218
Running on server:
219 1 Josip Almasi
https://docs.openvidu.io/en/2.17.0/deployment/deploying-on-premises/
220 11 Josip Almasi
221
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
222 25 Josip Almasi
223
h1. Software Architecture
224 26 Josip Almasi
225
!https://redmine.vrspace.org/attachments/download/15/vrspace-diagram.png!
226
227
h2. Client-Server Communication
228
229 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.
230 26 Josip Almasi
231
General approach to communication is rather obscure Half-Object pattern: server-side and client-side object have same properties, but different implementations.
232
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.
233
234
Whenever a client wants to perform any change to any object in the space, it has to go through the VRSpace server.
235
Clients may or may not communicate directly, but this is out of the scope of VRSpace server.
236
237
h2. Server Responsibilities
238
239
Sole responsibility of VRSpace server is management of 3D space: persisting space objects, tracking their properties, processing and distributing events from/to objects.
240 27 Josip Almasi
Whenever we talk about objects, that includes clients, i.e. users - a client is a special case of an object.
241
The server does not even handle the authentication - it is assumed to be responsibility of web app serving the space.
242
3D geometry is also not in server's scope, it's just another property of an object (mesh).
243
244
h2. Server design
245
246
Key concepts here are Active Objects, Actor model, and Live distributed object.
247
248 53 Josip Almasi
"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 "Business object":https://en.wikipedia.org/wiki/Business_object acting as a "Live distributed object":https://en.wikipedia.org/wiki/Live_distributed_object.
249 27 Josip Almasi
250 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.
251
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, 
252 27 Josip Almasi
253
Server relies on Spring Boot and embedded Tomcat to handle all I/O and threads.
254 29 Josip Almasi
255 55 Josip Almasi
Design does not require websockets in particular, in fact some reliable multicast protocol would surely fit better. Websockets work in web browsers.
256
257 33 Josip Almasi
h3. Client
258 29 Josip Almasi
259 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.
260 29 Josip Almasi
261
Scene maintains the event model, by adding the Client as listener to all other active objects (usually other users) in the scene.
262 1 Josip Almasi
263 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.
264
265
Client has just a couple of persistent properties, like position, rotation and name. The name must be unique.
266
All other properties are transient.
267
268 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.
269 1 Josip Almasi
270 33 Josip Almasi
h3. Events and messages
271
272 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.
273 1 Josip Almasi
This is to simplify client development: simply emit any custom event you want.
274 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.
275
276
However, there are other types of messages that are not distributed to other clients: commands and their return values, and errors.
277 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.
278
Should any server-side exception occur during the session, errors are sent to the client as simple JSON maps.
279 33 Josip Almasi
280
"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.
281
282
h3. Worlds
283
284
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.
285
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.
286
287 35 Josip Almasi
h3. Ownership and privacy
288
289
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.
290
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.
291
Fields of a class can be annotated as Private, and their contents will never be published.
292
293
"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.
294
295 33 Josip Almasi
h3. Package structure
296
297
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,
298
- config package contains server configuration classes that are executed only on server statup
299
- core is the core of the server
300 34 Josip Almasi
- dto is misnomer that stands Data Transfer Objects, though this package contains all objects that are not shared nor persisted
301 33 Josip Almasi
- obj contains persistent objects, most importantly Client and VRObject
302
- types are custom types used elsewhere, be it interfaces or annotations
303
- web is a primitive admin interface, disabled by default
304 54 Josip Almasi
- api contains REST controllers