Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOCS(dev): Add network protocol outdated and up-to-date information #6718

Merged
merged 1 commit into from
Feb 1, 2025
Merged

DOCS(dev): Add network protocol outdated and up-to-date information #6718

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/dev/network-protocol/README.md
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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>
Loading