Note that iptables can do it as well
[udp-broadcast-relay.git] / README.md
1 UDP Broadcast Packet Relay
2 ==========================
3
4 This program listens for packets on a specified UDP broadcast port. When
5 a packet is received, it sends that packet to all specified interfaces
6 but the one it came from as though it originated from the original
7 sender.
8
9 The primary purpose of this is to allow games on machines on separated
10 local networks (Ethernet, WLAN) that use udp broadcasts to find each
11 other to do so.
12
13 It also works on ppp links, so you can log in from windows boxes (e.g.
14 using pptp) and play LAN-based games together. Currently, you have to
15 care about upcoming or downgoing interfaces yourself.
16
17 Note that [it is possible to achieve this using `iptables` as
18 well](https://odi.ch/weblog/posting.php?posting=731).
19
20 INSTALL
21 -------
22
23     make 
24     cp udp-broadcast-relay /some/where
25
26 USAGE
27 -----
28
29     /some/where/udp-broadcast-relay id udp-port eth0 eth1...
30
31 udp-broadcast-relay must be run as root to be able to create a raw
32 socket (necessary) to send packets as though they originated from the
33 original sender.
34
35 COMPATIBILITY
36 -------------
37
38 -   I run debian woody with Linux 2.4.20, and here it works.
39
40 EXAMPLE
41 -------
42
43     /some/where/udp-broadcast-relay -f 1 6112 eth0 eth1  # forward Warcraft 3 broadcast packets
44
45 CONTRIBUTORS
46 -----------------
47
48 Over the last years, various people submitted code to the project. Note that I
49 do not use udp-broadcast-relay any more myself, so these changes were not
50 tested by me.
51
52 -   Patrick Huesmann submitted a patch to make udp-broadcast-relay send
53     the packes to those NICs it did not recieve it from, based on the
54     actual socket, not the broadcast IP. This is useful if more than one
55     physical networks share the same broadcast range.
56 -   Савченко В. М. submitted an `ip-up.local` an `ip-down.local` file to
57     automatically restart udp-broadcast-relay when new ppp-interfaces
58     come up, see `ppp-if.up-local` for details.
59 -   Roman Hoog Antink contributed the option `-s` to spoof the source IP of
60     forwarded packages.
61
62 Thanks to all contributors!
63
64 BUGS/CRITICISM/PATCHES/ETC
65 --------------------------
66
67 -   Web: <http://www.joachim-breitner.de/udp-broadcast-relay/>
68 -   e-mail:   Joachim Breitner <<mail@joachim-breitner.de>>
69 -   Github: <https://github.com/nomeata/udp-broadcast-relay/>
70
71 HISTORY
72 -------
73
74 *   0.3 2003-09-28
75
76     Sending packets also to ppp addresses
77
78 *   0.2 2003-09-18
79
80     Flags for debugging and forking, Compilefixes, Makefile-Target
81     "clean"
82
83 *   0.1 2003-09-15
84
85     Initial rewrite of udp_broadcast_fw
86
87 CREDITS
88 -------
89
90 This is based upon [udp_broadcast_fw](http://www.serverquery.com/udp_broadcast_fw/) by Nathan O'Sullivan.
91
92 HISTORY of udp_broadcast_fw
93 ---------------------------
94
95 *   0.1.1 - 19 Feb 02
96
97     Moved fork() code to just before main loop so that errors would
98     appear
99
100 *   0.1 - 18 Feb 02
101
102     Initial release
103
104 LICENSE
105 -------
106
107 This code is made available under the GPL. Read the COPYING file inside
108 the archive for more info.