Resources: Difference between revisions

← Older edit

Resources (view source)

Revision as of 03:58, 5 September 2025

1,881 bytes added , Friday at 03:58

no edit summary

Vortrex

Interface administrators, moderator

2,770

edits

@@ Line 11: / Line 11: @@
 </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).
@@ 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 would contain who made the script, the type of script and the version of the script.<br>
+Example
-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>
-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.
 {{XMLCode|1=<meta>
 	<info author="" type="" version="" description="" />
@@ Line 57: / Line 48: @@
 	<file url="" src="" type=""  />
 </meta>}}
+Some notes:
+* 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>
+* 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 ==
+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]<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.