Getting Started - Revision history

Joshcamas at 01:10, 22 May 2026

2026-05-22T01:10:59Z

← Older revision		Revision as of 21:10, 21 May 2026
Line 8:		Line 8:
	YourModDirectory		YourModDirectory
	mod_metadata.txt		mod_metadata.txt
			mod_manifest.txt
	Assets		Assets
	yourtexture.png		Textures
			yourtexture.png
	Scripts		Scripts
	yourscript.cs		yourscript.cs
Line 34:		Line 36:

	</syntaxhighlight>		</syntaxhighlight>

			=== Mod Asset Manifest ===
			You can define assets to import via the mod_manifest.txt file within your mod directory.

			See [[Custom Asset Importing\|Custom Asset Importing.]]

			=== Mod Scripts ===
			You can define C# scripts to be run within the Scripts directory, within your mod directory.

			See [[Mod Scripting\|Mod Scripting.]]

	=== Mod Template Builder ===		=== Mod Template Builder ===

Joshcamas at 17:52, 20 May 2026

2026-05-20T17:52:01Z

← Older revision		Revision as of 13:52, 20 May 2026
Line 2:		Line 2:

	=== Mod Structure ===		=== Mod Structure ===
	Here is the suggested structure for your Mod. Technically the only requirement is the mod_metadata.txt file being in the root directory of your mod.~~<syntaxhighlight>~~		Here is the suggested structure for your Mod. Technically the only requirement is the mod_metadata.txt file being in the root directory of your mod.
	Ardenfall_Data		Ardenfall_Data
	StreamingAssets		StreamingAssets
	Mods		Mods
	YourModDirectory		YourModDirectory
Line 12:		Line 12:
	Scripts		Scripts
	yourscript.cs		yourscript.cs
	~~</syntaxhighlight>~~

	=== Mod Metadata ===		=== Mod Metadata ===
Line 25:		Line 24:
	modDescription: The description displayed to the user. Can be empty.		modDescription: The description displayed to the user. Can be empty.

	modVersion: A version string (must be in a format supported by [https://learn.microsoft.com/en-us/dotnet/api/system.version?view=netframework-4.8.1 C#'s Version], such as "1", "1.0", or "3.2.7".		modVersion: A version string (must be in a format supported by [https://learn.microsoft.com/en-us/dotnet/api/system.version?view=netframework-4.8.1 C#'s Version], such as "1", "1.0", or "3.2.7".<syntaxhighlight lang="json">


	~~Example:~~<syntaxhighlight lang="json">
	{		{
	"modName": "Example Mod",		"modName": "Example Mod",
	"modAuthor": "joshcamas",		"modAuthor": "joshcamas",
	"modId": "f5c4ccca-87ab-40ed-8731-1e19aa17ab66",		"modId": "f5c4ccca-87ab-40ed-8731-1e19aa17ab66",
	"modDescription": "A simple mod that showcases a very simple scripting setup.",		"modDescription": "A simple mod that showcases a very simple scripting setup.",
	"modVersion": "0.0.1"		"modVersion": "0.0.1"
	}		}

	</syntaxhighlight>		</syntaxhighlight>

Joshcamas at 17:50, 20 May 2026

2026-05-20T17:50:21Z

← Older revision		Revision as of 13:50, 20 May 2026
Line 1:		Line 1:
	~~TODO~~		[IN PROGRESS]

			=== Mod Structure ===
			Here is the suggested structure for your Mod. Technically the only requirement is the mod_metadata.txt file being in the root directory of your mod.<syntaxhighlight>
			Ardenfall_Data
			StreamingAssets
			Mods
			YourModDirectory
			mod_metadata.txt
			Assets
			yourtexture.png
			Scripts
			yourscript.cs
			</syntaxhighlight>

			=== Mod Metadata ===
			The mod metadata file defines some top level values for your mod.

			modName: The name displayed to the user

			modAuthor: The author displayed to the user. Can be empty or multiple names, whatever.

			modId: The ID used by the modding system. Make sure this is unique - if two mods have the same id, they can't both be activated. You can use a GUID like the example below, or just write an id you think no one would use. The Mod Template Builder also auto generates this id.

			modDescription: The description displayed to the user. Can be empty.

			modVersion: A version string (must be in a format supported by [https://learn.microsoft.com/en-us/dotnet/api/system.version?view=netframework-4.8.1 C#'s Version], such as "1", "1.0", or "3.2.7".


			Example:<syntaxhighlight lang="json">
			{
			"modName": "Example Mod",
			"modAuthor": "joshcamas",
			"modId": "f5c4ccca-87ab-40ed-8731-1e19aa17ab66",
			"modDescription": "A simple mod that showcases a very simple scripting setup.",
			"modVersion": "0.0.1"
			}
			</syntaxhighlight>

			=== Mod Template Builder ===
			The Mod Template Builder tool allows you to create a mod starting point easily. It also includes the generation of a .csproj file, which will let you create scripts while referencing the actual codebase of ardenfall that mods have access to.

			Run the application ModTemplateBuilder.exe within your ardenfall's installation directory, and follow the prompts.

			The mod will be created in Ardenfall_Data/StreamingAssets/Mods.

Joshcamas: Created page with "TODO"

2026-05-20T06:08:17Z

Created page with "TODO"

New page

TODO