Documentation update

**Authors of the original conception**: Čeněk Šašinka, Jiří Chmelík, Alžběta Šašinková, Zdeněk Stachoň.

# Software Development Contributions

## Core module

* Additional content creation: Vojtěch Juránek, Vladimír Žbánek

## Teaching Modules

###  Contour Lines

###  Contour Lines [not released yet]

* Authors of the scenario conception: Šašinka, Chmelík, Stachoň

* Instructional design: Stachoň, Šašinka. Šašinková, Švedová, Jochecová, Káčová

* Software design: Chmelík, Brůža   

---

# Other Contributors

Authors of the original conception: Čeněk Šašinka, Jiří Chmelík, Alžběta Šašinková, Zdeněk Stachoň

# Funding

The eDIVE platform is developed in the research project of the Technology Agency of the Czech Republic (TL03000346 Education in Collaborative Immersive Virtual Reality) at the Department of Information and Library Studies and Department of Visual Computing, Masaryk University.

![logo TACR - technology agency of Czech Republic](../resources/logo_TACR_en_red.png)

--- 

* If your are looking for information how to setup or run existing eDIVE scenarios, check [For Users](User_Manual.md) section.

>[!NOTE]

>The name EDIVE should be spelled... somehow. What seem most logical is the following: Starting with capital 'E', then lowercase 'd' (for **Ed**ucation), and capital IVE (for **I**mmersive **V**irtual **E**nvironments). Nevertheless, the correct spelling is **eDIVE**.

## How to start developing using eDIVE?

1. If not familiar with eDIVE platform yet, we recommend to read through short [Description](Description.md) of the system, its architecture and features.

3. Install downloaded .apk into your headset. Several ways to do this exists, such as:

   1. Using [Meta Quest Developer Hub](https://developer.oculus.com/documentation/unity/ts-odh/) application

   2. Using [SideQuest](https://sidequestvr.com/) application

3. DONE.

4. DONE.

## 2.3 Server Application - Desktop

### Requirements

- common desktop PC, laptop or virtual machine with **static, public IP addres** 

- common desktop PC, laptop or virtual machine with **static, public IP address** 

- No GPU is required - eDIVE servers runs as console application, without graphical output.

- Windows OS - currently, we are providing pre-made binaries only for Windows platform, but it should be possible (we didn't try, yet) to create binaries also for Mac OS and Linux operating systems

- Network architecture allowing comminication on "higher" port numbers (e.g. port 60621). This could be problematic at e.g. University campus network high level of network security settings. If not sure, please contact administrators of your network. 

- Network architecture allowing communication on "higher" port numbers (e.g. port 60621). This could be problematic at e.g. University campus network high level of network security settings. If not sure, please contact administrators of your network. 

### Installation and Setup Process

   2. Change the title (name) of your server instance. E.g.: `server_title=My cool server name`. Try to keep naming conventions clear - if you will be running more server at the time, you should be able to recognize "which is which" by these server titles.

   3. If you plan to run multiple servers from the same machine, you need to manually set different port number for every server (automatic port assignment is on our development TODO list). You can select arbitrary port number in range 1024 to 65535. Range between 49152 and 65535 is recommended. Example: `port=54321`.

6. Check, that server is "visible" to clients

   1. 

6. Optional  - check, that server is "visible" to clients

   1. Open relay server web page:

      1. In case of pre-made binaries or if you are developer from MUNI, it is [here](http://decibel.fi.muni.cz/edive/).

      ![Screenshot](../resources/Relay_Server.png)

      2. If you are operating your own relay server (see next section), it has its own front-end and its own web-address.

   2. If your server is running, but it is not visible, see [Troubleshooting](#4-trouble-shooting) section

## 2.4 Relay Server

The pre-made binaries are linked with relay-server operated by Masaryk University. You can freely use it and there is nothing to install or set-up.

It is possible to run eDIVE in scope of your own, completely separated eco-system - your own binaries and separed relay-server. If your are considering this option, please contact us at: [info@edive.muni.cz](mailto:info@edive.muni.cz) and we will get in touch with you.

It is possible to run eDIVE in scope of your own, completely separated eDIVE eco-system (e. g. in scope of your university or corporate). This will require your own binaries and separated relay-server. Source codes for relay server and documentation how to deploy it will be released soon.

---

> on the very last line of console

> 

> also add screenshot here

---

# 4 Trouble-shooting

## Server is not Visible on Relay

The most common cause of this issues is network setting of either machine running the server or university/corporate network.

What to try (after each step, try to close the server, run it again, wait for few seconds and refresh the web-page with Relay Server)

1. Double check the server console for possible error messages such as `server registration failed`.

2. Double-check that your machine has public IP.

3. Check the settings of Windows Defender Firewall and other security SW on the machine. Make sure, that the server binary is allowed to make network connection. E.g. settings of Windows Defender Firewall rules:

4. ![screenshot](../resources/Firewal_Settings.png)

5. Contact administrators of your network and ask them about port filtering or other security measurements. If needed, ask them to allow some reasonable range of ports for eDIVE. E.g.: port numbers 60621 to 60671 - this will allow you to run up to 50 servers in the same time.

If you are still not able to see your server on the Relay, there is always an option to run eDIVE in [Local Network mode](#5-local-network-mode).

It is less convenient to run, but should work even in quite improvised network conditions (such as a running a server on a laptop with 5G internet connection and WIFI hotspot providing local network for all VR headsets).

---

# 5 Local Network Mode

This was developed mainly as back-up option for situations where network communication between teaching server and relay server do not work (see [troubleshooting](#4-trouble-shooting) section for possible fixes).

1. Check, that the server and all clients (VR headsets or desktop clients) are on the same local network.

2. Find the **local** IP address of machine running the server. E.g. writting `ipconfig /all` into Console or Power Shell will provide the data.

3. Run the server as usual - no extra settings are needed

4. Run the client(s) as usual. In the **Lobby** environment, click on `connect with IP` and enter the **local** IP of the server machine. TODO screenshot here

5. DONE.

>[!NOTE]

>You still need some internet connection for audio-chat feature. 

 No newline at end of file