Table of Contents
Target Namespace
http://gtan.azurewebsites.net/schema/server
Element and Attribute Namespaces
Global element and attribute declarations belong to this schema's target namespace.
By default, local element declarations belong to this schema's target namespace.
By default, local attribute declarations have no namespace.
Declared Namespaces
Prefix
Namespace
Default namespace
http://gtan.azurewebsites.net/schema/server
xs
http://www.w3.org/2001/XMLSchema
xhtml
http://www.w3.org/1999/xhtml
xml
http://www.w3.org/XML/1998/namespace
Schema Component Representation
<
xs:schema
targetNamespace ="
http://gtan.azurewebsites.net/schema/server "
elementFormDefault ="
qualified ">
...
</
xs:schema >
Name
acl_enabled
Type
xs :boolean
Nillable
no
Abstract
no
Default Value
true
Documentation
Defines whether the ACL is enabled.
XML Instance Representation
<acl_enabled>
xs :boolean </acl_enabled>
Schema Component Representation
<
xs:element
name ="
acl_enabled "
type ="
xs :boolean
"
default ="
true "/>
Name
allowcefdevtool
Type
xs :boolean
Nillable
no
Abstract
no
Default Value
false
Documentation
Defines whether the CEF dev tools can be used on clients.
XML Instance Representation
<allowcefdevtool>
xs :boolean </allowcefdevtool>
Schema Component Representation
<
xs:element
name ="
allowcefdevtool "
type ="
xs :boolean
"
default ="
false "/>
Name
announce
Type
xs :boolean
Nillable
no
Abstract
no
Default Value
true
Documentation
Defines whether to announce server, so it will be visible on the master list.
XML Instance Representation
<announce>
xs :boolean </announce>
Schema Component Representation
<
xs:element
name ="
announce "
type ="
xs :boolean
"
default ="
true "/>
Name
announce_lan
Type
xs :boolean
Nillable
no
Abstract
no
Default Value
true
Documentation
Defines whether to announce server in a local network, so it will be visible in LAN.
XML Instance Representation
<announce_lan>
xs :boolean </announce_lan>
Schema Component Representation
<
xs:element
name ="
announce_lan "
type ="
xs :boolean
"
default ="
true "/>
Name
config
Type
configElements
Nillable
no
Abstract
no
Documentation
Defines a configuration for a GTAN Server which provides some global settings.
This is the root element.
XML Instance Representation
<config>
Start Choice
[0..*]
Start Choice
[1]
End Choice
End Choice
Start Choice
[1]
Start Choice
[0..*]
Start Choice
[1]
End Choice
End Choice
Start Choice
[0..*]
Start Choice
[1]
End Choice
End Choice
End Choice
Start Choice
[0..*]
Start Choice
[1]
End Choice
End Choice
</config>
Name
conntimeout
Type
xs :boolean
Nillable
no
Abstract
no
Default Value
true
Documentation
Defines whether the client should automatically reconnect within 60 seconds after a timeout.
XML Instance Representation
<conntimeout>
xs :boolean </conntimeout>
Schema Component Representation
<
xs:element
name ="
conntimeout "
type ="
xs :boolean
"
default ="
true "/>
Element: fqdn
Name
fqdn
Type
xs :anyURI
Nillable
no
Abstract
no
Documentation
The ability to use FQDNs instead of IP addresses.
If the IP matches the resolved domain name, then the IP gets replaced by the FQDN.
Schema Component Representation
<
xs:element
name ="
fqdn "
type ="
xs :anyURI
"/>
Element: hash
Schema Component Representation
<
xs:element
name ="
hash "
type ="
xs :string
"/>
Name
httpserver
Type
xs :boolean
Nillable
no
Abstract
no
Default Value
false
Documentation
Enable an HTTP server for file transfer.
XML Instance Representation
<httpserver>
xs :boolean </httpserver>
Schema Component Representation
<
xs:element
name ="
httpserver "
type ="
xs :boolean
"
default ="
false "/>
Name
local_address
Type
xs :anyURI
Nillable
no
Abstract
no
Default Value
0.0.0.0
Documentation
Specifies a local IP address to bind the server to.
XML Instance Representation
<local_address>
xs :anyURI </local_address>
Schema Component Representation
<
xs:element
name ="
local_address "
type ="
xs :anyURI
"
default ="
0.0.0.0 "/>
Element: log
Name
log
Type
xs :boolean
Nillable
no
Abstract
no
Default Value
true
Documentation
Defines whether the console output should be written to a file.
Schema Component Representation
<
xs:element
name ="
log "
type ="
xs :boolean
"
default ="
true "/>
Schema Component Representation
<
xs:element
name ="
loglevel "
type ="
logLevelType
"
default ="
0 "/>
Name
masterserver
Type
xs :anyURI
Nillable
no
Abstract
no
Default Value
http://master.gtanet.work
Documentation
Address of the master server to register to. Should not usually be modified.
XML Instance Representation
<masterserver>
xs :anyURI </masterserver>
Schema Component Representation
<
xs:element
name ="
masterserver "
type ="
xs :anyURI
"
default ="
http://master.gtanet.work "/>
Name
maxplayers
Type
playerCountType
Nillable
no
Abstract
no
Default Value
16
Documentation
Maxplayers is a mandatory setting according to this schema definition.
Can only be specified once in a settings.xml.
Name
minclientversion
Type
versionNumberType
Nillable
no
Abstract
no
Default Value
0.0.0.0
Documentation
Require clients to have a minimum version of GTAN to be able to connnect.
Name
minclientversion_auto_update
Type
xs :boolean
Nillable
no
Abstract
no
Default Value
true
Documentation
Autoupdate client's files before connecting to the server.
XML Instance Representation
<minclientversion_auto_update>
xs :boolean </minclientversion_auto_update>
Schema Component Representation
<
xs:element
name ="
minclientversion_auto_update "
type ="
xs :boolean
"
default ="
true "/>
Element: mod
Schema Component Representation
<
xs:element
name ="
mod "
type ="
xs :string
"/>
Name
onfoot_lagcomp
Type
xs :boolean
Nillable
no
Abstract
no
Default Value
true
Documentation
On-foot lag compensation.
Disabling may result in smoother sync, but delayed data.
XML Instance Representation
Schema Component Representation
Name
password
Type
xs :token
Nillable
no
Abstract
no
Default Value
Documentation
Can be used to set a password for the server.
Leave it blank to remove any password.
XML Instance Representation
<password>
xs :token </password>
Schema Component Representation
<
xs:element
name ="
password "
type ="
xs :token
"
default =""/>
Name
refresh_rate
Type
xs :nonNegativeInteger
Nillable
no
Abstract
no
Default Value
120
Documentation
Server refresh rate (tick rate in Hz).
XML Instance Representation
<refresh_rate>
xs :nonNegativeInteger </refresh_rate>
Schema Component Representation
<
xs:element
name ="
refresh_rate "
type ="
xs :nonNegativeInteger
"
default ="
120 "/>
Name
resource
Type
Locally-defined complex type
Nillable
no
Abstract
no
Documentation
A resource to be loaded by the server which is specified by it's source.
XML Instance Representation
<resource
src="
xs :anyURI
[1] " />
Schema Component Representation
<
xs:element
name ="
resource ">
<
xs:complexType >
<
xs:attribute
name ="
src "
type ="
xs :anyURI
"
use ="
required "/>
</
xs:complexType >
</
xs:element >
Name
servername
Type
xs :string
Nillable
no
Abstract
no
Documentation
Servername is a mandatory setting according to this schema definition.
Can only be specified once in a settings.xml.
XML Instance Representation
<servername>
xs :string </servername>
Schema Component Representation
<
xs:element
name ="
servername "
type ="
xs :string
"/>
Name
serverport
Type
xs :unsignedShort
Nillable
no
Abstract
no
Default Value
4499
Documentation
Specifies a port number to communicate over UDP and TCP.
XML Instance Representation
<serverport>
xs :unsignedShort </serverport>
Schema Component Representation
<
xs:element
name ="
serverport "
type ="
xs :unsignedShort
"
default ="
4499 "/>
Name
trust_client_entity_properties
Type
xs :boolean
Nillable
no
Abstract
no
Default Value
false
Documentation
Allow client-side entity properties to be trusted and accepted by the server.
XML Instance Representation
<trust_client_entity_properties>
xs :boolean </trust_client_entity_properties>
Schema Component Representation
<
xs:element
name ="
trust_client_entity_properties "
type ="
xs :boolean
"
default ="
false "/>
Element: upnp
Name
upnp
Type
xs :boolean
Nillable
no
Abstract
no
Default Value
false
Documentation
Use Universal Plug and Play protocol to automatically forward ports.
XML Instance Representation
<upnp>
xs :boolean </upnp>
Schema Component Representation
<
xs:element
name ="
upnp "
type ="
xs :boolean
"
default ="
false "/>
Name
vehicle_lagcomp
Type
xs :boolean
Nillable
no
Abstract
no
Default Value
true
Documentation
Vehicle lag compensation.
Disabling may result in smoother sync, but delayed data.
XML Instance Representation
<vehicle_lagcomp>
xs :boolean </vehicle_lagcomp>
Schema Component Representation
<
xs:element
name ="
vehicle_lagcomp "
type ="
xs :boolean
"
default ="
true "/>
Name
whitelist
Type
xs :string
Nillable
no
Abstract
no
Documentation
Whitelist of mods based on hash.
XML Instance Representation
<whitelist>
xs :string </whitelist>
Schema Component Representation
<
xs:element
name ="
whitelist "
type ="
xs :string
"/>
Super-types:
None
Sub-types:
None
Name
configElements
Abstract
no
Documentation
A server configuration should atleast include a servername and a valid amount for maxplayers.
Apart from that, there are further optional settings. As all settings can occur in any kind of order,
this type covers all cases.
See optional settings for a better overview.
XML Instance Representation
<...>
Start Choice
[0..*]
Start Choice
[1]
End Choice
End Choice
Start Choice
[1]
Start Choice
[0..*]
Start Choice
[1]
End Choice
End Choice
Start Choice
[0..*]
Start Choice
[1]
End Choice
End Choice
End Choice
Start Choice
[0..*]
Start Choice
[1]
End Choice
End Choice
</...>
Schema Component Representation
<
xs:complexType
name ="
configElements ">
<
xs:sequence >
<
xs:choice
minOccurs ="
0 "
maxOccurs ="
unbounded ">
</
xs:choice >
<
xs:choice
minOccurs ="
1 ">
<
xs:sequence >
<
xs:choice
minOccurs ="
0 "
maxOccurs ="
unbounded ">
</
xs:choice >
</
xs:sequence >
<
xs:sequence >
<
xs:choice
minOccurs ="
0 "
maxOccurs ="
unbounded ">
</
xs:choice >
</
xs:sequence >
</
xs:choice >
<
xs:choice
minOccurs ="
0 "
maxOccurs ="
unbounded ">
</
xs:choice >
</
xs:sequence >
</
xs:complexType >
Name
optionalSettings
Documentation
A group of optional settings which might be omitted.
Although this schema allows using these elements multiple times, it is
highly advised to make sure that they are only used once in a settings.xml.
Schema Component Representation
<
xs:group
name ="
optionalSettings ">
<
xs:choice >
<
xs:element
ref ="
upnp
"/>
<
xs:element
ref ="
log
"/>
<
xs:element
ref ="
mod
"/>
<
xs:element
ref ="
hash
"/>
<
xs:element
ref ="
fqdn
"/>
</
xs:choice >
</
xs:group >
Super-types:
xs :nonNegativeInteger < logLevelType (by restriction)
Sub-types:
None
Name
logLevelType
Content
Base XSD Type: nonNegativeInteger
Documentation
Specifies a log level especially for debugging purposes.
Error
Debug
Verbose
Schema Component Representation
<
xs:simpleType
name ="
logLevelType ">
<
xs:restriction
base ="
xs :nonNegativeInteger
">
<xs:maxInclusive
value ="3 "/>
</
xs:restriction >
</
xs:simpleType >
Super-types:
xs :positiveInteger < playerCountType (by restriction)
Sub-types:
None
Name
playerCountType
Content
Base XSD Type: positiveInteger
Documentation
Amount of players that can connect to a server.
Schema Component Representation
<
xs:simpleType
name ="
playerCountType ">
<
xs:restriction
base ="
xs :positiveInteger
">
<xs:maxExclusive
value ="1500 "/>
</
xs:restriction >
</
xs:simpleType >
Super-types:
xs :token < versionNumberType (by restriction)
Sub-types:
None
Name
versionNumberType
Content
pattern = [0-9]+(\.?[0-9]+)*
Documentation
Version number which must contain atleast one number and
might have an unlimited amount of numbers and points as separators allowing SemVer.
Schema Component Representation
<
xs:simpleType
name ="
versionNumberType ">
<
xs:restriction
base ="
xs :token
">
<xs:pattern
value ="[0-9]+(\.?[0-9]+)* "/>
</
xs:restriction >
</
xs:simpleType >
Complex Type:
Schema Component Type
AusAddress
Schema Component Name
Super-types:
Address < AusAddress (by extension)
Sub-types:
QLDAddress (by restriction)
If this schema component is a type definition, its type hierarchy is shown in a gray-bordered box.
The table above displays the properties of this schema component.
XML Instance Representation
<...
country="Australia "
>
<unitNo> string </unitNo> [0..1]
<houseNo> string </houseNo> [1]
<street> string </street> [1]
Start Choice
[1]
<city> string </city> [1]
<town> string </town> [1]
End Choice
<state> AusStates </state> [1]
<postcode> string <<pattern = [1-9][0-9]{3}>> </postcode> [1]
?
</...>
The XML Instance Representation table above shows the schema component's content as an XML instance.
The minimum and maximum occurrence of elements and attributes are provided in square brackets, e.g. [0..1].
Model group information are shown in gray, e.g. Start Choice ... End Choice.
For type derivations, the elements and attributes that have been added to or changed from the base type's content are shown in bold .
If an element/attribute has a fixed value, the fixed value is shown in green, e.g. country="Australia".
Otherwise, the type of the element/attribute is displayed.
If the element/attribute's type is in the schema, a link is provided to it.
For local simple type definitions, the constraints are displayed in angle brackets, e.g. <<pattern = [1-9][0-9]{3}>>.
If a local element/attribute has documentation, it will be displayed in a window that pops up when the question mark inside the attribute or next to the element is clicked, e.g. <postcode>.
Schema Component Representation
<complexType
name ="AusAddress ">
<complexContent >
<extension
base ="
Address
">
<sequence >
<element
name ="state " type ="
AusStates
"/>
<element
name ="postcode ">
<simpleType >
<restriction
base ="
string
">
<pattern
value ="[1-9][0-9]{3} "/>
</restriction >
</simpleType >
</element >
</sequence >
<attribute
name ="country " type ="
string
" fixed ="Australia "/>
</extension >
</complexContent >
</complexType >
The Schema Component Representation table above displays the underlying XML representation of the schema component. (Annotations are not shown.)
Abstract
(Applies to complex type definitions and element declarations). An abstract element or complex type cannot used to validate an element instance. If there is a reference to an abstract element, only element declarations that can substitute the abstract element can be used to validate the instance. For references to abstract type definitions, only derived types can be used.
All Model Group
Child elements can be provided in any order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-all .
Choice Model Group
Only one from the list of child elements and model groups can be provided in instances. See: http://www.w3.org/TR/xmlschema-1/#element-choice .
Collapse Whitespace Policy
Replace tab, line feed, and carriage return characters with space character (Unicode character 32). Then, collapse contiguous sequences of space characters into single space character, and remove leading and trailing space characters.
Disallowed Substitutions
(Applies to element declarations). If substitution is specified, then substitution group members cannot be used in place of the given element declaration to validate element instances. If derivation methods , e.g. extension, restriction, are specified, then the given element declaration will not validate element instances that have types derived from the element declaration's type using the specified derivation methods. Normally, element instances can override their declaration's type by specifying an xsi:type attribute.
Key Constraint
Like Uniqueness Constraint , but additionally requires that the specified value(s) must be provided. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions .
Key Reference Constraint
Ensures that the specified value(s) must match value(s) from a Key Constraint or Uniqueness Constraint . See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions .
Model Group
Groups together element content, specifying the order in which the element content can occur and the number of times the group of element content may be repeated. See: http://www.w3.org/TR/xmlschema-1/#Model_Groups .
Nillable
(Applies to element declarations). If an element declaration is nillable, instances can use the xsi:nil attribute. The xsi:nil attribute is the boolean attribute, nil , from the http://www.w3.org/2001/XMLSchema-instance namespace. If an element instance has an xsi:nil attribute set to true, it can be left empty, even though its element declaration may have required content.
Notation
A notation is used to identify the format of a piece of data. Values of elements and attributes that are of type, NOTATION, must come from the names of declared notations. See: http://www.w3.org/TR/xmlschema-1/#cNotation_Declarations .
Preserve Whitespace Policy
Preserve whitespaces exactly as they appear in instances.
Prohibited Derivations
(Applies to type definitions). Derivation methods that cannot be used to create sub-types from a given type definition.
Prohibited Substitutions
(Applies to complex type definitions). Prevents sub-types that have been derived using the specified derivation methods from validating element instances in place of the given type definition.
Replace Whitespace Policy
Replace tab, line feed, and carriage return characters with space character (Unicode character 32).
Sequence Model Group
Child elements and model groups must be provided in the specified order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-sequence .
Substitution Group
Elements that are members of a substitution group can be used wherever the head element of the substitution group is referenced.
Substitution Group Exclusions
(Applies to element declarations). Prohibits element declarations from nominating themselves as being able to substitute a given element declaration, if they have types that are derived from the original element's type using the specified derivation methods.
Target Namespace
The target namespace identifies the namespace that components in this schema belongs to. If no target namespace is provided, then the schema components do not belong to any namespace.
Uniqueness Constraint
Ensures uniqueness of an element/attribute value, or a combination of values, within a specified scope. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions .