HPL3/Resources Configuration - Revision history

TiMan at 13:29, 8 June 2023

2023-06-08T13:29:59Z

TiMan at 14:40, 26 August 2020

2020-08-26T14:40:50Z

TiMan at 14:36, 26 August 2020

2020-08-26T14:36:06Z

TiMan at 12:48, 25 August 2020

2020-08-25T12:48:16Z

TiMan: /* Resources Configuration File */

2020-08-25T12:35:10Z

Resources Configuration File

TiMan: /* Resources Configuration File */

2020-08-25T12:32:40Z

Resources Configuration File

TiMan at 12:32, 25 August 2020

2020-08-25T12:32:32Z

TiMan: Created page with "Every HPL3 mod needs to point out all of the resources that are to be used in the mod. Resources are essentially collections of folders and files which are going to be used by..."

2020-08-25T12:10:14Z

Created page with "Every HPL3 mod needs to point out all of the resources that are to be used in the mod. Resources are essentially collections of folders and files which are going to be used by..."

New page

Every HPL3 mod needs to point out all of the resources that are to be used in the mod. Resources are essentially collections of folders and files which are going to be used by the mod. For example: 3D Models, Scripts, Audio, Textures, etc.
This article explains how to configure the resources for a mod.

==Resources Configuration File==
In order to make the mod load our resources / assets, we need to list where exactly those resources are located. All of the resources for the mod are listed inside a single XML file, called <code>resources.cfg</code>. The file should be located inside the main mod folder.

The syntax for adding a resource directory is as follows:
<syntaxhighlight lang="xml">
<Resources>
<Directory Path="/FolderName" AddSubDirs="true" />
</Resources></syntaxhighlight>

'''Path''' - The relative path to the folder that contains the resources.<br>
'''AddSubDirs''' - Whether to include sub-folders that are located inside the folder specified in <code>Path</code> as part of the resources or not. It is recommended to always set this to <code>true</code>.

{{note|The file lists directories in which the resources are located at in the form of relative path to the mod. That means you do not need to provide a full path for the folder.}}

@@ Line 1: / Line 1: @@
-{{shortPageTitlte}}
+{{shortPageTitle}}
 Every HPL3 mod needs to point out all of the resources that are to be used in the mod. Resources are essentially collections of folders and files which are going to be used by the mod. For example: 3D Models, Scripts, Audio, Textures, etc.
 This article explains how to configure the resources for a mod.

← Older revision		Revision as of 12:35, 25 August 2020
Line 19:		Line 19:

	{{note\|The file lists directories in which the resources are located at in the form of relative path to the mod. That means you do not need to provide a full path for the folder.}}		{{note\|The file lists directories in which the resources are located at in the form of relative path to the mod. That means you do not need to provide a full path for the folder.}}
		+
		+	===Example===
		+	Given the following mod structure:
		+	<syntaxhighlight lang="css">
		+	modFolder/
		+	├── config/
		+	│ ├── lang/
		+	│ │ ├── english.lang
		+	│ ├── main_init.cfg
		+	├── maps/
		+	├── script/
		+	├── static_objects/
		+	├── entry.hpc
		+	├── resources.cfg
		+	</syntaxhighlight>
		+	The resources file will look like this:
		+	<syntaxhighlight lang="xml">
		+	<Resources>
		+	<Directory Path="/config" AddSubDirs="true" />
		+	<Directory Path="/maps" AddSubDirs="true" />
		+	<Directory Path="/script" AddSubDirs="true" />
		+	<Directory Path="/static_objects" AddSubDirs="true" />
		+	</Resources>
		+	</syntaxhighlight>

@@ Line 10: / Line 10: @@
      <Directory Path="/FolderName" AddSubDirs="true" />
 </Resources></syntaxhighlight>
 {| class="wikitable"
 |Path
@@ Line 19: / Line 17: @@
 |Whether to include sub-folders that are located inside the folder specified in <code>Path</code> as part of the resources or not (recursive). It is recommended to always set this to <code>true</code>.
 |}
 {{note|The file lists directories in which the resources are located at in the form of relative path to the mod. That means you do not need to provide a full path for the folder.}}

@@ Line 3: / Line 3: @@
 ==Resources Configuration File==
-In order to make the mod load our resources / assets, we need to list where exactly those resources are located. All of the resources for the mod are listed inside a single XML file, called <code>resources.cfg</code>. The file should be located inside the main mod folder.
+In order to make the mod load our assets and maps, we need to list where exactly those resources are located. All of the resources for the mod are listed inside a single XML file, called <code>resources.cfg</code>. The file should be located inside the main mod folder.
 The syntax for adding a resource directory is as follows: