Server Browser Rules: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
(fix)
(11 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Warning|The system described in this article is still work-in-progress!|true}}
{{Note|Developers are working on creating a new Server Browser Interface. Check these issues on GitHub: [https://github.com/multitheftauto/mtasa-blue/issues/2104 Add banner, server description and tags  #2104] [https://github.com/multitheftauto/mtasa-blue/issues/998 Revamp server browser #998] [https://github.com/multitheftauto/mtasa-blue/issues/759 Language filter/search #759]}}
==Information==
==Information==


"'''Server Browser Rules'''" are ''key-value'' string pairs defined server-side.
"'''Server Browser Rules'''" are ''key-value'' string pairs defined server-side.


These values are automatically transmitted/announced/broadcasted by your MTA Server using the ASE (All-Seeing Eye) protocol, when queried on the main UDP Port (default 22003).
These values are automatically transmitted/announced/broadcasted by your MTA Server using the ASE (All-Seeing Eye) protocol, when queried on the ASE UDP Port (server port + 123).


This data is to be received and parsed by MTA Clients (in the Server Browser) to display the list of online MTA servers with custom information for each server.
This data is to be received and parsed by MTA Clients (in the Server Browser) to display the list of online MTA servers with custom information for each server.
Line 9: Line 12:
==Setting & Getting==
==Setting & Getting==


These ''rules'' can be set in your MTA Server's configuration file ([[Server_mtaserver.conf]]):
These ''rules'' can be set in your MTA Server's configuration file ([[Server_mtaserver.conf]]) using the following XML format:


<syntaxhighlight lang="xml">
<syntaxhighlight lang="xml">
<!-- The rule parameters are optional settings that the server will make public for the server browser/list.
<rule name="NAME_HERE" value="VALUE_HERE"/>
</syntaxhighlight>
 
They can also be defined and obtained using these two server-side functions:
 
<ul>
<li>[[setRuleValue]]</li>
<li>[[getRuleValue]]</li>
</ul>
 
==Expected Values==


    A brief description of the server. -->
The maximum amount of characters allowed in a rule value is '''200'''.
<rule name="description" value="" />


<!-- A comma separated list of languages that the server supports (e.g. en). -->
The Server Browser looks for the following information (optional) provided by servers:
<rule name="languages" value="" />


<!-- A comma separated list of tags that describe the server (e.g. freeroam,roleplay). -->
{| class="wikitable"
<rule name="tags" value="" />
! Key !! Explanation !! Accepted values || Example
|-
| '''description''' || Human-readable brief description of your server || Text || Custom cars and maps! Join various minigames from racing to drifting
|-
| '''languages''' || Comma separated list of languages that your server supports || [[#Allowed Languages|See Allowed Languages]] || en
|-
| '''tags''' || Comma separated list of tags that describe your server || [[#Allowed Tags|See Allowed Tags]] || freeroam, drifting
|-
| '''website_url''' || Website URL of your server || Valid URL starting with https:// || https://multitheftauto.com
|-
| '''social_url_1''' || Social media URL #1 || Valid URL starting with https:// || https://discord.com/invite/mtasa
|-
| '''social_url_2''' || Social media URL #2 || Valid URL starting with https:// || https://www.youtube.com/user/MTAQA
|-
| '''social_url_3''' || Social media URL #3 || Valid URL starting with https:// || https://www.facebook.com/multitheftauto
|}


<!-- The URL of the server's website. -->
====Allowed Languages====
<rule name="website_url" value="" />


<!-- A social media URL #1 (e.g. Discord). -->
WIP
<rule name="social_url_1" value="" />


<!-- A social media URL #2 (e.g. YouTube). -->
{| class="wikitable"
<rule name="social_url_2" value="" />
! Tag !! Language !! Flag
|-
| '''en''' || English || 🇺🇸
|-
| '''pt-pt''' || European Portuguese || 🇵🇹
|-
| '''pt-br''' || Brazilian Portuguese || 🇧🇷
|-
| '''es''' || Spanish || 🇪🇸
|-
| '''fr''' || French || 🇫🇷
|-
| '''de''' || German || 🇩🇪
|-
| '''it''' || Italian || 🇮🇹
|-
| '''ru''' || Russian || 🇷🇺
|-
| '''zh''' || Chinese (Simplified) || 🇨🇳
|-
| '''zh-tw''' || Chinese (Traditional, Taiwan) || 🇹🇼
|-
| '''ja''' || Japanese || 🇯🇵
|-
| '''ko''' || Korean || 🇰🇷
|-
| '''ar''' || Arabic || 🇸🇦
|-
| '''hi''' || Hindi || 🇮🇳
|-
| '''bn''' || Bengali || 🇧🇩
|-
| '''tr''' || Turkish || 🇹🇷
|-
| '''nl''' || Dutch || 🇳🇱
|-
| '''sv''' || Swedish || 🇸🇪
|-
| '''no''' || Norwegian || 🇳🇴
|-
| '''da''' || Danish || 🇩🇰
|-
| '''fi''' || Finnish || 🇫🇮
|-
| '''pl''' || Polish || 🇵🇱
|-
| '''cs''' || Czech || 🇨🇿
|-
| '''hu''' || Hungarian || 🇭🇺
|-
| '''ro''' || Romanian || 🇷🇴
|-
| '''el''' || Greek || 🇬🇷
|-
| '''he''' || Hebrew || 🇮🇱
|-
| '''vi''' || Vietnamese || 🇻🇳
|-
| '''th''' || Thai || 🇹🇭
|-
| '''id''' || Indonesian || 🇮🇩
|}


<!-- A social media URL #3 (e.g. Facebook). -->
<rule name="social_url_3" value="" />
</syntaxhighlight>


They can also be defined and obtained using these two server-side functions:
====Allowed Tags====


<ul>
WIP
<li>[[setRuleValue]]</li>
<li>[[getRuleValue]]</li>
</ul>


==Useful Information==
==Useful Information==

Revision as of 14:00, 3 January 2025

Dialog-warning.png Warning: The system described in this article is still work-in-progress!
[[{{{image}}}|link=|]] Note: Developers are working on creating a new Server Browser Interface. Check these issues on GitHub: Add banner, server description and tags #2104 Revamp server browser #998 Language filter/search #759

Information

"Server Browser Rules" are key-value string pairs defined server-side.

These values are automatically transmitted/announced/broadcasted by your MTA Server using the ASE (All-Seeing Eye) protocol, when queried on the ASE UDP Port (server port + 123).

This data is to be received and parsed by MTA Clients (in the Server Browser) to display the list of online MTA servers with custom information for each server.

Setting & Getting

These rules can be set in your MTA Server's configuration file (Server_mtaserver.conf) using the following XML format: 

<rule name="NAME_HERE" value="VALUE_HERE"/>

They can also be defined and obtained using these two server-side functions:

Expected Values

The maximum amount of characters allowed in a rule value is 200.

The Server Browser looks for the following information (optional) provided by servers:

Key Explanation Accepted values Example
description Human-readable brief description of your server Text Custom cars and maps! Join various minigames from racing to drifting
languages Comma separated list of languages that your server supports See Allowed Languages en
tags Comma separated list of tags that describe your server See Allowed Tags freeroam, drifting
website_url Website URL of your server Valid URL starting with https:// https://multitheftauto.com
social_url_1 Social media URL #1 Valid URL starting with https:// https://discord.com/invite/mtasa
social_url_2 Social media URL #2 Valid URL starting with https:// https://www.youtube.com/user/MTAQA
social_url_3 Social media URL #3 Valid URL starting with https:// https://www.facebook.com/multitheftauto

Allowed Languages

WIP

Tag Language Flag
en English 🇺🇸
pt-pt European Portuguese 🇵🇹
pt-br Brazilian Portuguese 🇧🇷
es Spanish 🇪🇸
fr French 🇫🇷
de German 🇩🇪
it Italian 🇮🇹
ru Russian 🇷🇺
zh Chinese (Simplified) 🇨🇳
zh-tw Chinese (Traditional, Taiwan) 🇹🇼
ja Japanese 🇯🇵
ko Korean 🇰🇷
ar Arabic 🇸🇦
hi Hindi 🇮🇳
bn Bengali 🇧🇩
tr Turkish 🇹🇷
nl Dutch 🇳🇱
sv Swedish 🇸🇪
no Norwegian 🇳🇴
da Danish 🇩🇰
fi Finnish 🇫🇮
pl Polish 🇵🇱
cs Czech 🇨🇿
hu Hungarian 🇭🇺
ro Romanian 🇷🇴
el Greek 🇬🇷
he Hebrew 🇮🇱
vi Vietnamese 🇻🇳
th Thai 🇹🇭
id Indonesian 🇮🇩


Allowed Tags

WIP

Useful Information

Retrieved from "https://wiki.multitheftauto.com/wiki/Server_Browser_Rules?oldid=81627"