Server Browser Rules: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 9: Line 9:
==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"/>
 
    A brief description of the server. -->
<rule name="description" value="" />
 
<!-- A comma separated list of languages that the server supports (e.g. en). -->
<rule name="languages" value="" />
 
<!-- A comma separated list of tags that describe the server (e.g. freeroam,roleplay). -->
<rule name="tags" value="" />
 
<!-- The URL of the server's website. -->
<rule name="website_url" value="" />
 
<!-- A social media URL #1 (e.g. Discord). -->
<rule name="social_url_1" value="" />
 
<!-- A social media URL #2 (e.g. YouTube). -->
<rule name="social_url_2" value="" />
 
<!-- A social media URL #3 (e.g. Facebook). -->
<rule name="social_url_3" value="" />
</syntaxhighlight>
</syntaxhighlight>


Line 42: Line 21:
<li>[[getRuleValue]]</li>
<li>[[getRuleValue]]</li>
</ul>
</ul>
==Allowed 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:
{| class="wikitable"
! Key !! Explanation !! Accepted values
|-
| '''description''' || Human-readable brief description of your server || Text
|-
| '''languages''' || Comma separated list of languages that your server supports || en, fr, pt-pt
|-
| '''tags''' || Comma separated list of tags that describe your server || freeroam, roleplay
|}
WIP


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

Revision as of 11:51, 3 January 2025

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 main UDP Port (default 22003).

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:

Allowed 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
description Human-readable brief description of your server Text
languages Comma separated list of languages that your server supports en, fr, pt-pt
tags Comma separated list of tags that describe your server freeroam, roleplay

WIP

Useful Information

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