Server Browser Rules: Difference between revisions
Jump to navigation
Jump to search
Fernando187 (talk | contribs) (fix) |
Fernando187 (talk | contribs) (add full example) |
||
| Line 36: | Line 36: | ||
| '''description''' || Human-readable brief description of your server || Text || Custom cars and maps! Join various minigames from racing to drifting | | '''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 | | '''languages''' || Comma separated list of languages that your server supports || [[#Allowed Languages|See Allowed Languages]] || en, ru, ar | ||
|- | |- | ||
| '''tags''' || Comma separated list of tags that describe your server || [[#Allowed Tags|See Allowed Tags]] || freeroam, drifting | | '''tags''' || Comma separated list of tags that describe your server || [[#Allowed Tags|See Allowed Tags]] || freeroam, minigames, race, pvp, drifting | ||
|- | |- | ||
| '''website_url''' || Website URL of your server || Valid URL starting with https:// || https:// | | '''website_url''' || Website URL of your server || Valid URL starting with https:// || https://example-website.com | ||
|- | |- | ||
| '''social_url_1''' || Social media URL #1 || Valid URL starting with https:// || https://discord.com/invite/ | | '''social_url_1''' || Social media URL #1 || Valid URL starting with https:// || https://discord.com/invite/example | ||
|- | |- | ||
| '''social_url_2''' || Social media URL #2 || Valid URL starting with https:// || https:// | | '''social_url_2''' || Social media URL #2 || Valid URL starting with https:// || https://youtube.com/@exampleChannel | ||
|- | |- | ||
| '''social_url_3''' || Social media URL #3 || Valid URL starting with https:// || https:// | | '''social_url_3''' || Social media URL #3 || Valid URL starting with https:// || https://facebook.com/examplePage | ||
|} | |} | ||
==Full Example== | |||
Below is an example configuration that you can include in '''mtaserver.conf''': | |||
<syntaxhighlight lang="xml"> | |||
<rule name="description" value="Custom cars and maps! Join various minigames from racing to drifting" /> | |||
<rule name="languages" value="en, ru, ar" /> | |||
<rule name="tags" value="freeroam, minigames, race, pvp, drifting" /> | |||
<rule name="website_url" value="https://example-website.com" /> | |||
<rule name="social_url_1" value="https://discord.com/invite/example" /> | |||
<rule name="social_url_2" value="https://youtube.com/@exampleChannel" /> | |||
<rule name="social_url_3" value="https://facebook.com/examplePage" /> | |||
</syntaxhighlight> | |||
====Allowed Languages==== | ====Allowed Languages==== | ||
Revision as of 13:11, 5 January 2025
|
Warning: The system described in this article is still work-in-progress! |
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, ru, ar |
| tags | Comma separated list of tags that describe your server | See Allowed Tags | freeroam, minigames, race, pvp, drifting |
| website_url | Website URL of your server | Valid URL starting with https:// | https://example-website.com |
| social_url_1 | Social media URL #1 | Valid URL starting with https:// | https://discord.com/invite/example |
| social_url_2 | Social media URL #2 | Valid URL starting with https:// | https://youtube.com/@exampleChannel |
| social_url_3 | Social media URL #3 | Valid URL starting with https:// | https://facebook.com/examplePage |
Full Example
Below is an example configuration that you can include in mtaserver.conf:
<rule name="description" value="Custom cars and maps! Join various minigames from racing to drifting" /> <rule name="languages" value="en, ru, ar" /> <rule name="tags" value="freeroam, minigames, race, pvp, drifting" /> <rule name="website_url" value="https://example-website.com" /> <rule name="social_url_1" value="https://discord.com/invite/example" /> <rule name="social_url_2" value="https://youtube.com/@exampleChannel" /> <rule name="social_url_3" value="https://facebook.com/examplePage" />
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