Project

General

Profile

Wiki » History » Version 65

Josip Almasi, 01/25/2022 09:49 AM

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