Difference between revisions of "Meta.xml"

From Multi Theft Auto: Wiki
Jump to: navigation, search
(Example)
(57 intermediate revisions by 28 users not shown)
Line 1: Line 1:
 
The ''meta.xml'' file presents MTA with a set of metadata, such as the resource's name, the scripts to include, and which files to precache for sending to clients among other things. It is also the scope of "elements". It is written in XML, which is based on HTML and is the parent of XHTML.
 
The ''meta.xml'' file presents MTA with a set of metadata, such as the resource's name, the scripts to include, and which files to precache for sending to clients among other things. It is also the scope of "elements". It is written in XML, which is based on HTML and is the parent of XHTML.
  
=Tagi=
+
=Tags=
XML jest tekstowym formatem danych, który jest stosowany do prezentacji danych. MTA wykorzystuje opartą na XML język do opisu metadanych dla zasobów przy użyciu tagów poniżej:
+
XML is a textual data format which is widely used for the representation of data. MTA uses an XML-based language to describe the metadata for resources by using the tags below:
  
 
+
*'''<info />''' Information about this resource, possible parameters include (any arbitrary parameters can be used and read using [[getResourceInfo]]):
** '''author:''' Autor tego zasobu.
+
** '''author:''' The author of this resource
** '''version:''' Wersja tego zasobu.
+
** '''version:''' The version of this resource
** '''name:''' Nazwa tego zasobu.
+
** '''name:''' The name of this resource
** '''description:''' Krótki opis tego zasobu.
+
** '''description:''' A brief description of this resource
** '''type:''' Typ tego zasobu, które mogą być w postaci "gamemode", "script", "map" i "misc".
+
** '''type:''' The type of this resource, that can be "gamemode", "script", "map" or "misc".
*'''<script />''' Kod źródłowy dla tego zasobu, możliwe parametry:
+
** '''gamemodes:''' The gamemodes to be compatible with the resource. It must be the name of the gamemode resource, not the gamemode name. If you want it to be compatible with multiple gamemodes, it must be in a comma-separated list without spaces. (e.g. gamemodes="test1,test2").  
** '''src:''' Nazwa pliku z kodem źródłowym
+
*'''<script />''' Source code for this resource, possible parameters are:
** '''type:''' Rodzaj kodu źródłowego: "client" lub "server"
+
** '''src:''' The file name of the source code
<!--
+
** '''type:''' The type of source code: "client", "server" or "shared".
** '''protected:''' For client-side scripts, whether this script should or not be saved in the clients hard disk: "true" or "false". NOTE: [http://bugs.mtasa.com/view.php?id=6831 there might be a bug with this].
+
**'''cache:''' When the script file type is "client", this setting controls whether the file is saved on the clients' hard drive. Default is "true". Using "false" will mean the file is not saved. ''(Note: cache=false files are started at the client first, so lua file load order might differ when mixing cache settings)''
-->
+
**'''validate:''' If set to "false", compatibility checks are skipped.
*'''<map />''' Mapa do gamemode, możliwe parametry:
+
*'''<map />''' The map for a gamemode, possible parameters are:
**'''src:''' nazwa pliku .map ( może być ścieżka np."mapy/nazwapliku.map" )
+
**'''src:''' .map file name (can be path too eg. "maps/filename.map")
**'''dimension:''' Wymiar w którym mapa zostanie załadowana
+
**'''dimension:''' Dimension in which the map will be loaded (optional)
*'''<file />''' Zdjęcia i pliki w rozmiaże .txd, .dll, .col lub .jpg.
+
*'''<file />''' A client-side file. Generally these are images, .txd, .col, .dff or .xml files. They'll be downloaded by clients when the resources is started (or on join)
**'''src:''' Po stronie clienta nazwa pliku ( może być też ścieżka np."zdjęcia/nazwa.jpg" )
+
**'''src:''' client-side file name (can be path too eg. "images/image.png")
*'''<include />''' Obejmują środki, które będą używać ten zasób
+
**'''download:''' Whether or not to be sent to the client automatically (optional). Default is "true". Using "false" will mean they are not sent on resource start but could later be used by [[downloadFile]].
**'''resource:''' Nazwa zasobu, który chcesz uruchomić z tego zasobu
+
*'''<include />''' Include resources that this resource will use
**'''minversion:''' Minimalna wersja
+
**'''resource:''' Resource name that you want to start with this resource
**'''maxversion:''' Maxsymalna wersja
+
**'''minversion:''' Minimum version that '''resource''' needs to be (optional)
*'''<config />''' Config to poprostu XML, możliwe parametry:
+
**'''maxversion:''' Maximum version that '''resource''' needs to be (optional)
**'''src:''' Nazwa pliku z pliku konfiguracyjnego
+
*'''<config />''' Config file (.xml) can be accessed by resource, possible parameters are:
**'''type:''' Typ pliku konfiguracyjnym: "client" lub "server"
+
**'''src:''' The file name of the config file
*'''<export />''' Te funkcje eksportowane z tego zasobu, do innych zasobów może korzystać z nich [CALL []]
+
**'''type:''' The type of the config file: "client" or "server"
**'''function:''' Nazwa funkcji
+
*'''<export />''' This exports functions from this resource, so other resources can use them with [[call]]
**'''type''' Czy funkcja jest eksportowana po stronie servera lub po stronie clienta (ważne są następujące wartości: "server" i "client")
+
**'''function:''' The function name
**'''http:''' Czy funkcja jest wywoływana za pośrednictwem protokołu HTTP (true / false)
+
**'''type''' Whether function is exported server-side or client-side (valid values are: "client", "server" and "shared")
 +
**'''http:''' Can the function be called via HTTP (true/false)
 
*'''<html />'''
 
*'''<html />'''
**'''src:''' Nazwa pliku HTTP (może być ścieżka)
+
**'''src:''' The filename for the HTTP file (can be a path)
**'''default:''' Plik html jest jeden, który jest domyślnie wyświetlane podczas wizyty/resource Name/on the server. Tylko jeden html może być domyślne, reszta jest ignorowana. (true / false)
+
**'''default:''' The html file is one that is shown by default when visiting /resourceName/ on the server. Only one html can be default, the rest are ignored. (true/false)
**'''raw:''' Html nie jest przetwarzany przez interpreter LUA i jest traktowany jako dane binarne. Muszą być stosowane dla plików binarnych (zdjęcia głównie) (true / false)
+
**'''raw:''' The html file is not parsed by the Lua interpreter and is treated as binary data. Must be used for binary files (images mainly) (true/false)
*'''<settings> <setting name="" value=""/> </settings>:''' Większość gamemodes używać [[System Settings]], aby pozwolić administratorom serwerów skonfigurować go tak, jak im się podoba. Na przykład można ustawić okrągły czas, a następnie użyć [[dostać]] i [[zbiór]], aby uzyskać wartość lub ją zmienić, odpowiednio.
+
*'''<settings><setting name="" value="" /></settings>:''' Most gamemodes use [[settings system]] to let server admins to configure it how they like. For instance you could set round time and then use [[get]] and [[set]] to get the value or change it, respectively.
*'''<min_mta_version />''' Minimalne wymagania wersji dla tego zasobu do poprawnego działania. Kiedy zasoby autorskie, minimalna wersja powinna zwykle być ustawiony na bieżącej wydanej wersji MTA: SA (który w tej chwili jest "{{Current Version | pełny}}").
+
*'''<min_mta_version />''' Minimum version requirements for this resource to run correctly. When authoring resources, the minimum version should usually be set to the current released version of MTA:SA (which at the moment is "{{Current Version|full}}"). See example for example.
**'''client:''' Minimalna wersja clienta
+
**'''client:''' The minimum client version
**'''server:''' Minimalna wersja servera
+
**'''server:''' The minimum server version
*'''<aclrequest />''' Lista [[Access_Control_List | ACL]] prawa ten zasób będzie potrzebne.
+
*'''<aclrequest />''' A list of [[Access_Control_List|ACL]] rights this resource will need.
 +
{{New items|3.0132|1.3.1 r4141|
 +
*'''<sync_map_element_data />''' Controls whether map [[Element_data|element data]] such as "PosX" and "DoubleSided" are transferred to the client. This data is usually not required by most gamemodes or resources. (Map Editor and Interiors require this to be not set to false to work). When set in a gamemode meta.xml, the setting will apply to all maps loaded by that resource.
 +
**'''false:''' Disable transfer of map element data for all resources. This can reduce map download times considerably.
 +
**'''true:''' Enable transfer of map element data for all resources. (If '''false''' and '''true''' are set in different resources, true will have priority and all resources will transfer map element data)
 +
}}
 +
{{New items|3.0140|1.4.0 r5313|
 +
*'''<oop />''' OOP - Please refer to [[OOP]] for documentation.
 +
**'''false:''' Disable OOP.
 +
**'''true:''' Enable OOP.
 +
}}
 +
{{New feature/item|3.0150|1.5.0|7308|
 +
*'''<download_priority_group />''' If not set, the download priority group for a resource defaults to 0. If this is set higher than 0, then the resource will be downloaded and started on the client earlier than other resources. If set to less than 0, the resource will be downloaded and started on the client later than other resources.
 +
}}
  
== Przykład ==
+
== Example ==
Oto przykład pliku meta przy niektórych znaczników wymienionych:
+
Here's an example of a meta file using some of the tags mentioned:
{{#tag:code |
+
{{#tag:syntaxhighlight |
 
<meta>
 
<meta>
     <info name="race" author"SEBO" type="gamemode" version"1.0.0" />
+
     <info author="Slothman" version="1.0.2" name="Stealth" description="Allow scripts to insert a ped that simulates combat with a real player" type="gamemode" />
    <config src="help.xml" type="client"/>
 
    <min_mta_version client="{{Current Version|full}}" server="{{Current Version|full}}" />
 
  
 
     <script src="stealthmain_server.lua" />
 
     <script src="stealthmain_server.lua" />
Line 55: Line 67:
 
     <script src="gadgets_server.lua" />
 
     <script src="gadgets_server.lua" />
 
     <script src="gadgets_client.lua" type="client"/>
 
     <script src="gadgets_client.lua" type="client"/>
     <script src="stealthmain_client.lua" type="client"/>
+
     <script src="stealthmain_client.lua" type="client" validate="true"/>
 
     <script src="noisebar.lua" type="client"/>
 
     <script src="noisebar.lua" type="client"/>
 
     <script src="spycam.lua" type="client"/>
 
     <script src="spycam.lua" type="client"/>
     <script src="riemann_z_demonstration.lua" type="client"/>
+
     <script src="riemann_z_demonstration.lua" type="client" cache="false"/>
  
     <file src="riot_shield.txd" />
+
    <map src="base.map" dimension="1"/>
     <file src="riot_shield.dff" />
+
 
     <file src="riot_shield.col" />
+
     <file src="riot_shield.txd" download="false" />
     <file src="armor.png" download="true"/>
+
     <file src="riot_shield.dff" download="false" />
     <file src="camera.png" download="false"/>
+
     <file src="riot_shield.col" download="false" />
 +
     <file src="armor.png" />
 +
     <file src="camera.png" />
 
     <file src="cloak.png" />
 
     <file src="cloak.png" />
 
     <file src="goggles.png" />
 
     <file src="goggles.png" />
Line 74: Line 88:
 
     <include resource="killmessages" />
 
     <include resource="killmessages" />
 
     <include resource="maplimits" />
 
     <include resource="maplimits" />
 +
   
 +
    <config src="help.xml" type="client"/>
 +
 +
    <export function="exampleExport1" type="server" />
 +
    <export function="exampleExport2" type="client" />
 +
    <export function="exampleExport3" type="shared" />
  
 
     <settings>
 
     <settings>
        <setting name="roundlimit" value="[6]" /> <!-- round length in minutes -->
+
        <setting name="roundlimit" value="[6]" /> <!-- round length in minutes -->
<setting name="teamdamage" value="[1]" /> <!-- 0 for team protection off, 1 for team protection on -->
+
<setting name="teamdamage" value="[1]" /> <!-- 0 for team protection off, 1 for team protection on -->
<setting name="teambalance" value="[1]" /> <!--  difference limit of amount of players between teams -->
+
<setting name="teambalance" value="[1]" /> <!--  difference limit of amount of players between teams -->
<setting name="spazammo" value="[25]" /> <!-- ammo amounts -->
+
<setting name="spazammo" value="[25]" /> <!-- ammo amounts -->
<setting name="m4ammo" value="[100]" />
+
<setting name="m4ammo" value="[100]" />
<setting name="shotgunammo" value="[25]" />
+
<setting name="shotgunammo" value="[25]" />
<setting name="sniperammo" value="[20]" />
+
<setting name="sniperammo" value="[20]" />
<setting name="ak47ammo" value="[120]" />
+
<setting name="ak47ammo" value="[120]" />
<setting name="rifleammo" value="[40]" />
+
<setting name="rifleammo" value="[40]" />
<setting name="deserteagleammo" value="[45]" />
+
<setting name="deserteagleammo" value="[45]" />
<setting name="pistolammo" value="[132]" />
+
<setting name="pistolammo" value="[132]" />
<setting name="uziammo" value="[150]" />
+
<setting name="uziammo" value="[150]" />
<setting name="tec9ammo" value="[150]" />
+
<setting name="tec9ammo" value="[150]" />
<setting name="silencedammo" value="[65]" />
+
<setting name="silencedammo" value="[65]" />
<setting name="grenadeammo" value="[4]" />
+
<setting name="grenadeammo" value="[4]" />
<setting name="satchelammo" value="[4]" />
+
<setting name="satchelammo" value="[4]" />
<setting name="teargasammo" value="[4]" />
+
<setting name="teargasammo" value="[4]" />
<setting name="molatovammo" value="[4]" />
+
<setting name="molatovammo" value="[4]" />
    </settings>
+
<setting name="isAllowedToShoot" value="true" />
 +
    </settings>
 +
 
 +
    <min_mta_version server="1.5.2-9.07903" client="1.5.2-9.07903" />
  
    <aclrequest>
+
    <aclrequest>
<right name="function.startResource" access="true" />
+
        <right name="function.startResource" access="true" />
<right name="function.stopResource" access="true" />
+
        <right name="function.stopResource" access="true" />
<right name="function.setPlayerMuted" access="true" />
+
        <right name="function.setPlayerMuted" access="true" />
    </aclrequest>
+
    </aclrequest>
  
 +
    <sync_map_element_data>false</sync_map_element_data>
 +
 +
    <oop>false</oop>
 +
 +
    <download_priority_group>0</download_priority_group>
 
</meta>
 
</meta>
 
|lang="xml"}}
 
|lang="xml"}}
 
[[Category:Scripting Concepts]]
 
[[Category:Scripting Concepts]]
 +
[[hu:Meta.xml]]
 
[[cs:Meta.xml]]
 
[[cs:Meta.xml]]
 +
[[de:Meta.xml]]
 +
[[es:Sobre el archivo "meta.xml"]]
 +
[[it:Meta.xml]]
 +
[[pl:Meta.xml]]
 
[[ru:Meta.xml]]
 
[[ru:Meta.xml]]
[[es:Sobre el archivo "meta.xml"]]
 

Revision as of 12:54, 8 January 2019

The meta.xml file presents MTA with a set of metadata, such as the resource's name, the scripts to include, and which files to precache for sending to clients among other things. It is also the scope of "elements". It is written in XML, which is based on HTML and is the parent of XHTML.

Tags

XML is a textual data format which is widely used for the representation of data. MTA uses an XML-based language to describe the metadata for resources by using the tags below:

  • <info /> Information about this resource, possible parameters include (any arbitrary parameters can be used and read using getResourceInfo):
    • author: The author of this resource
    • version: The version of this resource
    • name: The name of this resource
    • description: A brief description of this resource
    • type: The type of this resource, that can be "gamemode", "script", "map" or "misc".
    • gamemodes: The gamemodes to be compatible with the resource. It must be the name of the gamemode resource, not the gamemode name. If you want it to be compatible with multiple gamemodes, it must be in a comma-separated list without spaces. (e.g. gamemodes="test1,test2").
  • <script /> Source code for this resource, possible parameters are:
    • src: The file name of the source code
    • type: The type of source code: "client", "server" or "shared".
    • cache: When the script file type is "client", this setting controls whether the file is saved on the clients' hard drive. Default is "true". Using "false" will mean the file is not saved. (Note: cache=false files are started at the client first, so lua file load order might differ when mixing cache settings)
    • validate: If set to "false", compatibility checks are skipped.
  • <map /> The map for a gamemode, possible parameters are:
    • src: .map file name (can be path too eg. "maps/filename.map")
    • dimension: Dimension in which the map will be loaded (optional)
  • <file /> A client-side file. Generally these are images, .txd, .col, .dff or .xml files. They'll be downloaded by clients when the resources is started (or on join)
    • src: client-side file name (can be path too eg. "images/image.png")
    • download: Whether or not to be sent to the client automatically (optional). Default is "true". Using "false" will mean they are not sent on resource start but could later be used by downloadFile.
  • <include /> Include resources that this resource will use
    • resource: Resource name that you want to start with this resource
    • minversion: Minimum version that resource needs to be (optional)
    • maxversion: Maximum version that resource needs to be (optional)
  • <config /> Config file (.xml) can be accessed by resource, possible parameters are:
    • src: The file name of the config file
    • type: The type of the config file: "client" or "server"
  • <export /> This exports functions from this resource, so other resources can use them with call
    • function: The function name
    • type Whether function is exported server-side or client-side (valid values are: "client", "server" and "shared")
    • http: Can the function be called via HTTP (true/false)
  • <html />
    • src: The filename for the HTTP file (can be a path)
    • default: The html file is one that is shown by default when visiting /resourceName/ on the server. Only one html can be default, the rest are ignored. (true/false)
    • raw: The html file is not parsed by the Lua interpreter and is treated as binary data. Must be used for binary files (images mainly) (true/false)
  • <settings><setting name="" value="" /></settings>: Most gamemodes use settings system to let server admins to configure it how they like. For instance you could set round time and then use get and set to get the value or change it, respectively.
  • <min_mta_version /> Minimum version requirements for this resource to run correctly. When authoring resources, the minimum version should usually be set to the current released version of MTA:SA (which at the moment is "1.5.6"). See example for example.
    • client: The minimum client version
    • server: The minimum server version
  • <aclrequest /> A list of ACL rights this resource will need.
  • <sync_map_element_data /> Controls whether map element data such as "PosX" and "DoubleSided" are transferred to the client. This data is usually not required by most gamemodes or resources. (Map Editor and Interiors require this to be not set to false to work). When set in a gamemode meta.xml, the setting will apply to all maps loaded by that resource.
    • false: Disable transfer of map element data for all resources. This can reduce map download times considerably.
    • true: Enable transfer of map element data for all resources. (If false and true are set in different resources, true will have priority and all resources will transfer map element data)
  • <oop /> OOP - Please refer to OOP for documentation.
    • false: Disable OOP.
    • true: Enable OOP.
  • <download_priority_group /> If not set, the download priority group for a resource defaults to 0. If this is set higher than 0, then the resource will be downloaded and started on the client earlier than other resources. If set to less than 0, the resource will be downloaded and started on the client later than other resources.

Example

Here's an example of a meta file using some of the tags mentioned:

<meta>
    <info author="Slothman" version="1.0.2" name="Stealth" description="Allow scripts to insert a ped that simulates combat with a real player" type="gamemode" />

    <script src="stealthmain_server.lua" />
    <script src="noiseblip.lua" />
    <script src="mission_timer.lua" />
    <script src="gadgets_server.lua" />
    <script src="gadgets_client.lua" type="client"/>
    <script src="stealthmain_client.lua" type="client" validate="true"/>
    <script src="noisebar.lua" type="client"/>
    <script src="spycam.lua" type="client"/>
    <script src="riemann_z_demonstration.lua" type="client" cache="false"/>

    <map src="base.map" dimension="1"/>

    <file src="riot_shield.txd" download="false" />
    <file src="riot_shield.dff" download="false" />
    <file src="riot_shield.col" download="false" />
    <file src="armor.png" />
    <file src="camera.png" />
    <file src="cloak.png" />
    <file src="goggles.png" />
    <file src="mine.png" />
    <file src="radar.png" />
    <file src="shield.png" />

    <include resource="scoreboard" />
    <include resource="killmessages" />
    <include resource="maplimits" />
    
    <config src="help.xml" type="client"/>

    <export function="exampleExport1" type="server" />
    <export function="exampleExport2" type="client" />
    <export function="exampleExport3" type="shared" />

    <settings>
        <setting name="roundlimit" value="[6]" /> 
	<setting name="teamdamage" value="[1]" /> 
	<setting name="teambalance" value="[1]" /> 
	<setting name="spazammo" value="[25]" /> 
	<setting name="m4ammo" value="[100]" />
	<setting name="shotgunammo" value="[25]" />
	<setting name="sniperammo" value="[20]" />
	<setting name="ak47ammo" value="[120]" />
	<setting name="rifleammo" value="[40]" />
	<setting name="deserteagleammo" value="[45]" />
	<setting name="pistolammo" value="[132]" />
	<setting name="uziammo" value="[150]" />
	<setting name="tec9ammo" value="[150]" />
	<setting name="silencedammo" value="[65]" />
	<setting name="grenadeammo" value="[4]" />
	<setting name="satchelammo" value="[4]" />
	<setting name="teargasammo" value="[4]" />
	<setting name="molatovammo" value="[4]" />
	<setting name="isAllowedToShoot" value="true" />
    </settings>

    <min_mta_version server="1.5.2-9.07903" client="1.5.2-9.07903" />

    <aclrequest>
        <right name="function.startResource" access="true" />
        <right name="function.stopResource" access="true" />
        <right name="function.setPlayerMuted" access="true" />
    </aclrequest>

    <sync_map_element_data>false</sync_map_element_data>

    <oop>false</oop>

    <download_priority_group>0</download_priority_group>
</meta>