Launcher protocol: Difference between revisions

Document 3.1's new extended info and PWAD hashes
(Remove Devfeature)
(Document 3.1's new extended info and PWAD hashes)
Line 2: Line 2:


== Protocol information ==
== Protocol information ==
Version: '''0.58''' (October 28, 2012), compatible with the developmental version, 1.1.
See "article history" to look up the protocol for prior versions.
See "article history" to look up the protocol for prior versions.


Line 174: Line 171:
|-
|-
| <tt>SQF_DEH</tt> || <tt>0x40000000</tt> || List of DEHACKED patches loaded by the server.
| <tt>SQF_DEH</tt> || <tt>0x40000000</tt> || List of DEHACKED patches loaded by the server.
|-
| <tt>SQF_EXTENDED_INFO</tt> || <tt>0x80000000</tt> || {{Devfeature|3.1|alpha}} Additional server information, see the table below for more information.
|}
=== Extended flags ===
{{Devfeature|3.1|alpha}}
{| class="wikitable"
! Name || Value || Description
|-
| <tt>SQF2_PWAD_HASHES</tt> || <tt>0x00000001</tt> || The MD5 hashes of the server's loaded PWADs.
|}
|}
<hr>


For example, to get the server's name and player count, you'd use <tt>(SQF_NAME|SQF_NUMPLAYERS)</tt>. Use these flags appropriately; doing so saves your users' and server hosters' bandwidth.
For example, to get the server's name and player count, you'd use <tt>(SQF_NAME|SQF_NUMPLAYERS)</tt>. Use these flags appropriately; doing so saves your users' and server hosters' bandwidth.
Line 188: Line 197:
|-
|-
|Long || Time || Current time, this will be sent back to you so you can determine ping.
|Long || Time || Current time, this will be sent back to you so you can determine ping.
|-
|Long || Flags2 || {{Devfeature|3.1|alpha}} The extended information you want. Ensure you specify <tt>SQF_EXTENDED_INFO</tt> in the normal Flags field as well. This field is optional - if this field is not present, its value is inferred to be 0.
|}
|}


Line 423: Line 434:
| <tt>SQF_DEH</tt>
| <tt>SQF_DEH</tt>
| Deh patch name (one string for each deh patch)
| Deh patch name (one string for each deh patch)
|-
| Long
| <tt>SQF_EXTENDED_INFO</tt>
| {{Devfeature|3.1|alpha}} The flags specifying extended server information you will receive. Check all <tt>SQF2</tt> values against field.
|-
| Byte
| <tt>SQF2_PWAD_HASHES</tt>
| {{Devfeature|3.1|alpha}} The number of hashes sent.
|-
| String
| <tt>SQF2_PWAD_HASHES</tt>
| {{Devfeature|3.1|alpha}} The hash of the PWAD, sent for each PWAD. The index is the same as in <tt>SQF_PWADS</tt>
|}
|}