Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Rackover authored Sep 1, 2020
1 parent c1bf014 commit 646b9c9
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ Notes :
| Create a new lobby | client.CreateLobby(...) | The lobby you just created, but with an ID delivered by the server | |
| Update information for my lobby | client.UpdateLobby(<Lobby> object) | Nothing | |
| Kill my lobby and remove it from Broadcast | client.DestroyLobby(uint lobbyID) | Nothing | |
| Hole-punch the host to allow myself through the host's NAT | client.PunchLobby(uint lobbyID) | Nothing | Only works if the lobby uses `ETransportProtocol.UDP` |
| Requests the host to hole-punch me. | client.PunchLobby(uint lobbyID) | Nothing | Only works if the lobby uses `ETransportProtocol.UDP` |

## Server
Download a binary from the /Releases section according to what you have
- winx86 for Windows 32 bit
Expand All @@ -48,3 +48,5 @@ Unzip and run `Broadcast`(.exe). This should work out of the box.
- Lobby that hasn't sent trace of life in the past 30 seconds are cleaned up and destroyed from the server
- Broadcast uses the major version number (X) to signal compatibility break. Minor version number and revision number (Y and Z) are usually quality of life improvements or bugfixes, but no protocol change.
- Broadcast returns maximum 200 lobbies when queried
- Broadcast does not implement hole punching: it only implements a message "requesting" a punch from the client to the host. The actual punching implementation is left to the application.

0 comments on commit 646b9c9

Please sign in to comment.