README.md 2.88 KB
Newer Older
IASpace's avatar
IASpace committed
1
# Telemersive Gateway 1.0.0
maybites's avatar
maybites committed
2

IASpace's avatar
IASpace committed
3
Telemersive Gateway is a peer to peer application based on MaxMSP. It allows to converse with multiple peers in different networks. A central server (called the [telemersive-router](https://gitlab.zhdk.ch/telemersion/telemersive-router)) allows to create virtual rooms inside which all peers can share their available resources.
IASpace's avatar
IASpace committed
4

IASpace's avatar
IASpace committed
5
![Diagram](media/DiagramUserView.svg "Solution")
IASpace's avatar
IASpace committed
6

IASpace's avatar
IASpace committed
7
8
9
10
11
12
13
14
15
16
17
18
## Features

The gateway comes with an easy to use GUI to give an overview of all the peers participate inside the same room.

For each connection type it shows a matrix of all channels available, with icon indicators in which direction the data flows and framerates if available.

It is possible remote control the connections of each peer from another peer. If the connection is utilizing a CLI app like ultragrid or NatNet2OSC, it is possible to monitor the logout of these apps even from a remote peer to investigate problems.

The Userinterface makes the configuration of the CLI apps very simple and user friendly.

![Diagram](media/TG_device_ultragrid_2peers.png "GUI")

IASpace's avatar
IASpace committed
19
For more information please visit  the [documentation](https://gitlab.zhdk.ch/telemersion/telemersive-gateway/-/wikis/Welcome).
maybites's avatar
maybites committed
20
21
22
23

## Installation

### Requirements
IASpace's avatar
IASpace committed
24
You need to have [MaxMSP](https://cycling74.com/) installed. There is no need for a license if you just want to work with telemersive-gateway.
maybites's avatar
maybites committed
25
26

### Download
IASpace's avatar
IASpace committed
27
To install the Telemersive Gateway: download the [latest release](https://gitlab.zhdk.ch/telemersion/telemersive-gateway/-/releases) and drop the unpacked folder inside the [MaxMSP package folder](https://docs.cycling74.com/max8/vignettes/packages) and call it 'telemersive-gateway'. It is not important that the directory is called this way, but otherwise the MaxProject will not work.
maybites's avatar
maybites committed
28

IASpace's avatar
IASpace committed
29
Restart Max. Now you should be able to find the telemersive-gateway package inside the package manager.
maybites's avatar
maybites committed
30

IASpace's avatar
IASpace committed
31
32
### Dependencies
The easy way to install all dependencies: open the package launcher and follow the instructions.
maybites's avatar
maybites committed
33

IASpace's avatar
IASpace committed
34
The telemersive-gateway requires additional MaxMSP packages.
maybites's avatar
maybites committed
35

IASpace's avatar
IASpace committed
36
37
38
39
* Sadam Objects
* Zero
* Spout / Syphon
* shell
maybites's avatar
maybites committed
40

IASpace's avatar
IASpace committed
41
It also needs a local installation of
maybites's avatar
maybites committed
42

IASpace's avatar
IASpace committed
43
* [Ultragrid](https://www.ultragrid.cz/), an opensource video networking framework with extremely low latency. If you want to interface it with NDI, you need also to install the [NDI libraries](https://github.com/CESNET/UltraGrid/wiki/Syphon,-Spout-and-NDI#ndi) for your system.
IASpace's avatar
IASpace committed
44
* [NatNetThree2OSC](https://github.com/tecartlab/app_NatNetThree2OSC),  an opensource app to convert native [optitrack](https://optitrack.com/software/) tracking data to OSC. (windows only)
maybites's avatar
maybites committed
45

IASpace's avatar
IASpace committed
46
Make sure MaxMSP has read-write access rights on the folders ultragrid and NatNet2OSC reside in.
maybites's avatar
maybites committed
47

IASpace's avatar
IASpace committed
48
## Credits
maybites's avatar
maybites committed
49

IASpace's avatar
IASpace committed
50
Martin Froehlich (c) 2022 [Immersive Arts Space](http://immersive-arts.ch)
maybites's avatar
maybites committed
51

IASpace's avatar
IASpace committed
52
This project was only realized thanks to the generous support of the swiss national science foundation and the telematic project.