Skip to content

Commit

Permalink
DOCS(dev): Add network protocol outdated and up-to-date information
Browse files Browse the repository at this point in the history
  • Loading branch information
Kissaki committed Feb 1, 2025
1 parent e4ea26d commit 7cee314
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 2 deletions.
7 changes: 7 additions & 0 deletions docs/dev/network-protocol/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,13 @@ Mumble VoIP 1.2.X server-client communication protocol. It reflects the state of
the protocol implemented in the Mumble 1.2.8 client and might be outdated by the
time you are reading this.

For up to date message type and message structure information
refer to the [`Mumble.proto`](https://github.com/mumble-voip/mumble/blob/master/src/Mumble.proto)
and [`MumbleUDP.proto`](https://github.com/mumble-voip/mumble/blob/master/src/MumbleUDP.proto)
protobuf definition files.

This documentation is split into

* [Overview](overview.md)
* [Protocol Stack (TCP)](protocol_stack_tcp.md)
* [Establishing a Connection](establishing_connection.md)
Expand Down
2 changes: 2 additions & 0 deletions docs/dev/network-protocol/establishing_connection.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ its certificate and it is recommended that the client checks this.
Once the TLS handshake is completed both sides should transmit their version
information using the Version message. The message structure is described below.

Note: This `Version` documentation is outdated. Please refer to the current proto definitions for up-to-date information.

| Field | Type |
| ------------ | -------- |
| `version` | `uint32` |
Expand Down
4 changes: 2 additions & 2 deletions docs/dev/network-protocol/protocol_stack_tcp.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ If not mentioned otherwise all fields outside the protobuf encoding are big-endi
| `24` | ServerConfig |
| `25` | SuggestConfig |

For raw representation of each packet type see the attached Mumble.proto [^2] file.
For raw representation of each packet type see the [`Mumble.proto`](https://github.com/mumble-voip/mumble/blob/master/src/Mumble.proto)
and [`MumbleUDP.proto`](https://github.com/mumble-voip/mumble/blob/master/src/MumbleUDP.proto) files.

[^1]: <https://github.com/google/protobuf>
[^2]: <https://raw.github.com/mumble-voip/mumble/master/src/Mumble.proto>

0 comments on commit 7cee314

Please sign in to comment.