Commit bc19ac81 authored by Roman Haefeli's avatar Roman Haefeli
Browse files

add installation section to README.txt

parent 38a4b635
......@@ -24,7 +24,8 @@ For more information visit:
Installation
------------
Make sure to get the latest Pure Data from:
Install Pure Data with your package manager or get binaries
from:
https://puredata.info/downloads/
......@@ -36,6 +37,33 @@ You need the following externals to run tpf-client
You can install externals through the Pd menu:
'Help' -> 'Find Externals'
tpf-server uses netpd-server as a git submodule, thus make
sure to clone the repository like this:
git clone --recursive https://gitlab.zhdk.ch/TPF/tpf-server
Run tpf-server
--------------
For the server to be reachable by the clients, it should run on
a machine with a public IP address. On a head-less machine, you
probably want to run it in nogui mode:
pd -nogui -open tpf-server/tpf-server.pd
The server opens a listening socket on TCP-port 3025. So make
sure that this port is open in your firewall configuration.
The TCP-Port 3025 is only used for client communication and not for
audio transmission. The audio transmission is using UDP-Port 4460
and requires a separate Python script to be running:
./tpf-udp-proxy.py
This waits for incoming client connections and relays UDP packets
between clients.
Authors
-------
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment