Project

General

Profile

Wiki » History » Version 69

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