Difference between revisions of "Protocol"

From Mumble Wiki
Jump to: navigation, search
(UDP Ping packet: add link to K-10's mmping command plugin for an IPv6 ping example)
(add categories)
Line 64: Line 64:
  
 
An example script can be found at [https://gitorious.org/mumble-scripts/mumble-scripts/blobs/master/Non-RPC/mumble-ping.py mumble-ping.py]. A modified version of the script that also supports IPv6 is used by [[K-10]] for the mmping command, and can be found [https://bitbucket.org/Svedrin/k10-plugins/src/tip/BwCalc/plugin.py#cl-120 in Svedrin's BitBucket repository].
 
An example script can be found at [https://gitorious.org/mumble-scripts/mumble-scripts/blobs/master/Non-RPC/mumble-ping.py mumble-ping.py]. A modified version of the script that also supports IPv6 is used by [[K-10]] for the mmping command, and can be found [https://bitbucket.org/Svedrin/k10-plugins/src/tip/BwCalc/plugin.py#cl-120 in Svedrin's BitBucket repository].
 +
 +
 +
[[Category:Documentation Development]]

Revision as of 22:39, 3 May 2013

The Mumble Protocol is Open Source, just like Mumble itself. The source code for the current version can be found in the Git repository in the file Mumble.proto.

Protocol documentation

A complete documentation about the protocol can be found at mumble-protocol.pdf.

UDP Ping packet

Mumble supports querying the following data by sending a ping packet to the target server. Both the request and the response packets are formatted in Big Endian.

The ping request packet contains the following data:

Width Data type Value Comment
4 bytes int 0 Denotes the request type
8 bytes long long ident Used to identify the reponse.


The response will then contain the following data:

Width Data type Value Comment
4 bytes int Version e.g., \x0\x1\x2\x3 for 1.2.3. Can be interpreted as one single int or four signed chars.
8 bytes long long ident the ident value sent with the request
4 bytes int Currently connected users count
4 bytes int Maximum users (slot count)
4 bytes int Allowed bandwidth

An example script can be found at mumble-ping.py. A modified version of the script that also supports IPv6 is used by K-10 for the mmping command, and can be found in Svedrin's BitBucket repository.