Server Browser Rules: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 37: Line 37:
| '''tags''' || Comma separated list of tags that describe your server || freeroam, roleplay
| '''tags''' || Comma separated list of tags that describe your server || freeroam, roleplay
|-
|-
| '''website_url''' || The URL of your server's website || Valid URL starting with https://
| '''website_url''' || Website URL of your server || Valid URL starting with https://
|-
|-
| '''social_url_1''' || Social media URL #1 || Valid URL starting with https://
| '''social_url_1''' || Social media URL #1 || Valid URL starting with https://

Revision as of 11:55, 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:

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
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
website_url Website URL of your server Valid URL starting with https://
social_url_1 Social media URL #1 Valid URL starting with https://
social_url_2 Social media URL #2 Valid URL starting with https://
social_url_3 Social media URL #3 Valid URL starting with https://

Useful Information