3b3be4fd56b0a12b88a8860fe425852e240c8176
[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 INSTALL
18 -------
19
20     make 
21     cp udp-broadcast-relay /some/where
22
23 USAGE
24 -----
25
26     /some/where/udp-broadcast-relay id udp-port eth0 eth1...
27
28 udp-broadcast-relay must be run as root to be able to create a raw
29 socket (necessary) to send packets as though they originated from the
30 original sender.
31
32 COMPATIBILITY
33 -------------
34
35 -   I run debian woody with Linux 2.4.20, and here it works.
36
37 EXAMPLE
38 -------
39
40     /some/where/udp-broadcast-relay -f 1 6112 eth0 eth1  # forward Warcraft 3 broadcast packets
41
42 CONTRIBUTORS
43 -----------------
44
45 Over the last years, various people submitted code to the project. Note that I
46 do not use udp-broadcast-relay any more myself, so these changes were not
47 tested by me.
48
49 -   Patrick Huesmann submitted a patch to make udp-broadcast-relay send
50     the packes to those NICs it did not recieve it from, based on the
51     actual socket, not the broadcast IP. This is useful if more than one
52     physical networks share the same broadcast range.
53 -   Савченко В. М. submitted an `ip-up.local` an `ip-down.local` file to
54     automatically restart udp-broadcast-relay when new ppp-interfaces
55     come up, see `ppp-if.up-local` for details.
56 -   Roman Hoog Antink contributed the option `-s` to spoof the source IP of
57     forwarded packages.
58
59 Thanks to all contributors!
60
61 BUGS/CRITICISM/PATCHES/ETC
62 --------------------------
63
64 -   Web: <http://www.joachim-breitner.de/udp-broadcast-relay/>
65 -   e-mail:   Joachim Breitner <<mail@joachim-breitner.de>>
66 -   Github: <https://github.com/nomeata/udp-broadcast-relay/>
67
68 HISTORY
69 -------
70
71 *   0.3 2003-09-28
72
73     Sending packets also to ppp addresses
74
75 *   0.2 2003-09-18
76
77     Flags for debugging and forking, Compilefixes, Makefile-Target
78     "clean"
79
80 *   0.1 2003-09-15
81
82     Initial rewrite of udp_broadcast_fw
83
84 CREDITS
85 -------
86
87 This is based upon [udp_broadcast_fw](http://www.serverquery.com/udp_broadcast_fw/) by Nathan O'Sullivan.
88
89 HISTORY of udp_broadcast_fw
90 ---------------------------
91
92 *   0.1.1 - 19 Feb 02
93
94     Moved fork() code to just before main loop so that errors would
95     appear
96
97 *   0.1 - 18 Feb 02
98
99     Initial release
100
101 LICENSE
102 -------
103
104 This code is made available under the GPL. Read the COPYING file inside
105 the archive for more info.