Launcher protocol: Difference between revisions

Adjust the wording of the country codes section
(3.1 is released, so Devfeature templates have been removed)
(Adjust the wording of the country codes section)
Line 483: Line 483:
Zandronum 3.1 introduces the ability to server hosts to specify the country their server is located in via a new CVAR, <tt>sv_country</tt>. This was introduced to allow hosts to combat the inaccuracies of IP geolocation that launchers rely on. This value is specified to launchers via the new <tt>SQF2_COUNTRY</tt> field, which can have the following values:
Zandronum 3.1 introduces the ability to server hosts to specify the country their server is located in via a new CVAR, <tt>sv_country</tt>. This was introduced to allow hosts to combat the inaccuracies of IP geolocation that launchers rely on. This value is specified to launchers via the new <tt>SQF2_COUNTRY</tt> field, which can have the following values:


* '''an ISO 3166-1 alpha-3 country code.''' Note that Zandronum doesn't validate whether the country code supplied in <tt>sv_country</tt> is a registered country code. If the launcher does not recognise the given code, then it should display a generic "unknown" flag.
* '''an ISO 3166-1 alpha-3 country code.''' Note that Zandronum doesn't validate whether the country code supplied in <tt>sv_country</tt> is a registered country code. If the launcher does not recognise the given code, then it should display the server's country as unknown.
* '''the value <tt>XIP</tt>''', which suggests to the launcher that it should attempt IP geolocation to determine the server's country. The default value of <tt>sv_country</tt> will cause it to return this by default, to preserve existing behaviour and make it easier for casual hosts. If geolocation is unsupported, disabled, or fails, then a generic "unknown" flag should be displayed.
* '''the value <tt>XIP</tt>''', which suggests to the launcher that it should attempt IP geolocation to determine the server's country. The default value of <tt>sv_country</tt> will cause it to return this by default, to preserve existing behaviour and make it easier for casual hosts. If geolocation is unsupported, disabled, or fails, then the server's country should be displayed as unknown.
* '''the value <tt>XUN</tt>''', in which case the launcher should display a generic "unknown" flag.
* '''the value <tt>XUN</tt>''', in which case the launcher should display the server's country as unknown.


Also see {{Issue|3894|Allow servers to present their country to launchers}}.
Also see {{Issue|3894|Allow servers to present their country to launchers}}.


[[Category:Developers_Articles]]
[[Category:Developers_Articles]]