Resources - Revision history

Mex at 13:04, 12 March 2026

2026-03-12T13:04:11Z

← Older revision		Revision as of 13:04, 12 March 2026
Line 46:		Line 46:
	<dependency src="" />		<dependency src="" />
	<map src="" type="" />		<map src="" type="" />
	<file ~~url=""~~ src="" type="" />		<file src="" type="" />
	</meta>}}		</meta>}}

Vortrex at 03:58, 5 September 2025

2025-09-05T03:58:01Z

← Older revision		Revision as of 03:58, 5 September 2025
Line 50:		Line 50:

	Some notes:		Some notes:
	* All "src" attributes are a relative path to the file, with the resource's folder as the root~~. See the "Sandbox" section above for more info on that~~.		* All "src" attributes are a relative path to the file, with the resource's folder as the root.
	* The <code>info</code> node contains attributes that indicates who made the resource, it's type (custom description), custom version number, and a description of the resource<br>		* The <code>info</code> node contains attributes that indicates who made the resource, it's type (custom description), custom version number, and a description of the resource<br>
	* Every script file needs to have a <code><script></code> node, each with a "type" attribute that refers to what side the script will run on (server or client), a language attribute that tells the server/client which language the script file uses (see [[ScriptingLanguages\|supported scripting languages]]), and a "src" attribute with the file name as a relative path (i.e. "example.js" or "foo/bar.js".		* Every script file needs to have a <code><script></code> node, each with a "type" attribute that refers to what side the script will run on (server or client), a language attribute that tells the server/client which language the script file uses (see [[ScriptingLanguages\|supported scripting languages]]), and a "src" attribute with the file name as a relative path (i.e. "example.js" or "foo/bar.js".
Line 60:		Line 60:

	== Other Notes ==		== Other Notes ==
	* The server will ignore any folders named with open and close square brackets, meaning they will not be loaded or cached as resources. This is useful if you want to group resources into subfolders for organization. Example name: [foobar]		* The server will ignore any folders named with open and close square brackets, meaning they will not be loaded or cached as resources. This is useful if you want to group resources into subfolders for organization. Example name: [foobar]<br>
			* Resources are completely sandboxed on both server and client, and any file paths are jailed in the resource's folder. All available file-related functions are carefully set up to only allow access to files within the resource. This also applies to client-side resource cache.
			* Client side ''scripts'' (provided by a <script> tags in meta.xml) are sent separately to clients using the server's game/sync networking and are NOT saved to the cache. This helps lower the chances of script theft. Only files provided with <file> tags are sent via the HTTP server.
			* Scripts and files that are only server-side are not accessible to clients. If your ''server-only'' scripts or files are stolen or leaked, it's not GTA Connected's fault. There is likely a security exploit somewhere on the machine or hosting service that you're running the server on.

Vortrex at 06:01, 23 July 2025

2025-07-23T06:01:58Z

← Older revision		Revision as of 06:01, 23 July 2025
Line 36:		Line 36:


	== Meta File ==		== Meta.xml File ==
	~~Here~~ is ~~an example for the contents of the meta file:~~		This is used to provide some basic information and what scripts/files it provides.<br>
	~~{{XMLCode\|1=<meta>~~		'''All resources must have a meta.xml, or the resource won't load!'''
	~~<info author="jack9267" type="script" version="1~~.~~0.0" description="Provides something awesome." />~~

	<~~script src="server.lua" type="server" language="lua" /~~>
	</meta~~>}}~~

	~~The info element contains who made the script~~, the ~~type of script and the version of the script.<br>~~

	You would have a script element for each script file you wish to load, each with a "type" attribute that refers to what side the script will run on (server or client), a language attribute that tells the server/client which language the script file uses (see [[ScriptingLanguages\|supported scripting languages]]), and a "src" attribute with the file name as a relative path (i.e. "example.js" or "foo/bar.js".		Example

	~~Below is a list of all accepted meta.xml nodes.~~
	{{XMLCode\|1=<meta>		{{XMLCode\|1=<meta>
	<info author="" type="" version="" description="" />		<info author="" type="" version="" description="" />
Line 56:		Line 48:
	<file url="" src="" type="" />		<file url="" src="" type="" />
	</meta>}}		</meta>}}

			Some notes:
			* All "src" attributes are a relative path to the file, with the resource's folder as the root. See the "Sandbox" section above for more info on that.
			* The <code>info</code> node contains attributes that indicates who made the resource, it's type (custom description), custom version number, and a description of the resource<br>
			* Every script file needs to have a <code><script></code> node, each with a "type" attribute that refers to what side the script will run on (server or client), a language attribute that tells the server/client which language the script file uses (see [[ScriptingLanguages\|supported scripting languages]]), and a "src" attribute with the file name as a relative path (i.e. "example.js" or "foo/bar.js".
			* Every custom file needs to have a <code><file></code> node, each with a "src" attribute for the file's path, and a "type" attribute indicating whether it's for the client or server.
			* Any <code><dependency></code> node, with a "src" attribute with the other resource's name, will require the other resource to be loaded BEFORE this one.

	== Client-side Files ==		== Client-side Files ==

Vortrex at 05:43, 23 July 2025

2025-07-23T05:43:35Z

← Older revision		Revision as of 05:43, 23 July 2025
Line 46:		Line 46:
	The info element contains who made the script, the type of script and the version of the script.<br>		The info element contains who made the script, the type of script and the version of the script.<br>

	You would have a script element for each script file you wish to load, each with a "type" attribute that refers to what side the script will run on (server or client), a language attribute that tells the server/client which language the script file uses (see [[~~SupportedLanguages~~\|supported scripting languages]]), and a "src" attribute with the file name as a relative path (i.e. "example.js" or "foo/bar.js".		You would have a script element for each script file you wish to load, each with a "type" attribute that refers to what side the script will run on (server or client), a language attribute that tells the server/client which language the script file uses (see [[ScriptingLanguages\|supported scripting languages]]), and a "src" attribute with the file name as a relative path (i.e. "example.js" or "foo/bar.js".

	Below is a list of all accepted meta.xml nodes.		Below is a list of all accepted meta.xml nodes.

Vortrex at 05:42, 23 July 2025

2025-07-23T05:42:53Z

← Older revision		Revision as of 05:42, 23 July 2025
Line 44:		Line 44:
	</meta>}}		</meta>}}

	The info element ~~would contain~~ who made the script, the type of script and the version of the script.<br>		The info element contains who made the script, the type of script and the version of the script.<br>
	You would have a script element for each script file you wish to load~~.<br>~~
	~~The~~ type attribute refers to ~~where~~ the script will run~~, specify "~~server~~" for server code~~ or "client~~" to have the script download and run on the client.<br>~~		You would have a script element for each script file you wish to load, each with a "type" attribute that refers to what side the script will run on (server or client), a language attribute that tells the server/client which language the script file uses (see [[SupportedLanguages\|supported scripting languages]]), and a "src" attribute with the file name as a relative path (i.e. "example.js" or "foo/bar.js".
	~~The~~ language attribute tells the server which language ~~to interpret~~ the script~~. <br>GTA Connected supports Lua~~ (~~language=~~"~~lua~~"~~), JavaScript~~ (~~language=~~"~~javascript~~"~~), and Squirrel (language=~~"~~squirrel~~")

	Below is a list of all accepted meta.xml nodes.		Below is a list of all accepted meta.xml nodes.

Vortrex at 05:23, 23 July 2025

2025-07-23T05:23:48Z

← Older revision		Revision as of 05:23, 23 July 2025
Line 11:		Line 11:
	</resources>}}		</resources>}}

	You can also start, stop, restart and refresh resources without restarting the server. To do this, type one of the commands (start, stop, refresh, or restart) in the server console. Example: <code>start something</code>. ~~The refresh command is needed when you're finished editing a resource because the server loads all resources into memory so any edits won't have any effect until you use the refresh command.~~ You can also use these commands in game, if your [[client.administrator\|client.administrator]] is set to true (any running resource can set this).		You can also start, stop, restart and refresh resources without restarting the server. To do this, type one of the commands (start, stop, refresh, or restart) in the server console. Example: <code>start something</code>. You can also use these commands in game, if your [[client.administrator\|client.administrator]] is set to true (any running resource can set this).

Vortrex at 03:29, 10 March 2024

2024-03-10T03:29:00Z

← Older revision		Revision as of 03:29, 10 March 2024
Line 60:		Line 60:
	== Client-side Files ==		== Client-side Files ==
	Resources that contain client-side files are cached. If the built-in HTTP server is enabled, this will be used to distribute these files to clients when they connect or when the resource is updated and restarted. The default folder is "htdocs" in the GTAC server's main directory. You can also use your own HTTP server (like apache2 or nginx) as long as you add a virtual directory pointing to that "htdocs" folder in your GTAC server. Please note that this only applies to client-side files (used in ''<file>'' tag of the resource's meta.xml), not script files!		Resources that contain client-side files are cached. If the built-in HTTP server is enabled, this will be used to distribute these files to clients when they connect or when the resource is updated and restarted. The default folder is "htdocs" in the GTAC server's main directory. You can also use your own HTTP server (like apache2 or nginx) as long as you add a virtual directory pointing to that "htdocs" folder in your GTAC server. Please note that this only applies to client-side files (used in ''<file>'' tag of the resource's meta.xml), not script files!

			== Other Notes ==
			* The server will ignore any folders named with open and close square brackets, meaning they will not be loaded or cached as resources. This is useful if you want to group resources into subfolders for organization. Example name: [foobar]

Vortrex at 20:19, 19 February 2024

2024-02-19T20:19:42Z

← Older revision		Revision as of 20:19, 19 February 2024
Line 57:		Line 57:
	<file url="" src="" type="" />		<file url="" src="" type="" />
	</meta>}}		</meta>}}

			== Client-side Files ==
			Resources that contain client-side files are cached. If the built-in HTTP server is enabled, this will be used to distribute these files to clients when they connect or when the resource is updated and restarted. The default folder is "htdocs" in the GTAC server's main directory. You can also use your own HTTP server (like apache2 or nginx) as long as you add a virtual directory pointing to that "htdocs" folder in your GTAC server. Please note that this only applies to client-side files (used in ''<file>'' tag of the resource's meta.xml), not script files!

Mex at 17:22, 17 October 2021

2021-10-17T17:22:34Z

← Older revision		Revision as of 17:22, 17 October 2021
Line 19:		Line 19:

	Script files can be created with any of the supported languages: Lua, Squirrel, or JavaScript. These can be mixed in the same resource (although in different files). You can have one file running Lua, another with JavaScript, and another with Squirrel, all working together in the same resource.		Script files can be created with any of the supported languages: Lua, Squirrel, or JavaScript. These can be mixed in the same resource (although in different files). You can have one file running Lua, another with JavaScript, and another with Squirrel, all working together in the same resource.


			== Example Directory Structure ==

			Server.exe<br>
			Server.xml<br>
			resources/<br>
			resources/resource1/<br>
			resources/resource1/meta.xml<br>
			resources/resource1/ResourceScript.js<br>
			resources/resource2/<br>
			resources/resource2/meta.xml<br>
			resources/resource2/ResourceScript.js<br>
			resources/resource2/ResourceScript.lua<br>
			resources/resource2/ResourceScript.nut

Vortrex at 13:21, 12 August 2021

2021-08-12T13:21:24Z

← Older revision		Revision as of 13:21, 12 August 2021
Line 1:		Line 1:
	== What is a resource? ==		== What is a resource? ==
	Resources contain content for a server. This can include scripts, audio, images, game files, etc. You can reload, start, and stop resources, and you can have more than 1 resource running at the same time. Resources would usually contain a script for game modes or can also contain other tasks to help control/manage the server, add commands, provide separate content, etc.		Resources contain content for a server. This can include scripts, audio, images, game files, etc. You can reload, start, and stop resources, and you can have more than 1 resource running at the same time. Resources would usually contain a script for game modes or can also contain other tasks to help control/manage the server, add commands, provide separate content, etc.
	A ~~resource~~ can be used ~~by placing it's content~~ in either a folder or zipped up in a [https://en.wikipedia.org/wiki/Tar_(computing) tar file].		A resources' content can be used in either a folder or zipped up in a [https://en.wikipedia.org/wiki/Tar_(computing) tar file].