Ardenfall Wiki - User contributions [en]

Creating a Quest

2026-06-03T19:14:53Z

Joshcamas:

== Quest System Overview ==
The Quest System is useful for creating quests for the player to complete, unmarked interactions, and even gameplay systems.

'''Quest Data'''

Quest Data is the core asset that holds all the static information related to a quest - objects, phases, etc.

'''Quest State'''

A quest may be in one of these states: Unstarted, Started, Completed, or Failed

'''Quest Phase'''

A quest is broken up into phases. A quest may only have one phase active at once. Each phase can have multiple objectives.

'''Quest Objective'''

A quest objective is a goal for the player. It can be hidden or displayed at any time if the phase is active. It can have its state changed at any time regardless of the owning phase's state.

== Quest Data ==
TODO

== Quest Phases ==
TODO

== Quest Objectives ==
TODO

== Quest Objects ==
TODO

== Best Practices ==
'''Storing State'''

Objectives and Phases are a great way to store state. If you have an objective 'pick up the apple', then there's no need to have a bool variable 'applePickedUp'. This reduces the potential for bugs and desyncing.

Creating Dialog

2026-05-29T20:32:00Z

Joshcamas:

=== Dialog Graph Builder ===
TODO

=== Registering Dialog to NPC ===
TODO

=== Quest Dialog ===
TODO

=== Graph View Tool ===
TODO

Creating Dialog

2026-05-24T01:48:27Z

Joshcamas:

=== Dialog Graph Builder ===
The Dialog Graph Builder is a way to build dialog with C#.

TODO

Example:<syntaxhighlight lang="c#">
var b= new DialogGraphBuilder(graph);
var greet = b.Greeting("Hello!");
var speak = b.Speak("How can I help?");
var mc = b.MultipleChoice();
var c0 = mc.AddChoice("Tell me more");
var c1 = mc.AddChoice("Goodbye");
b.Connect(greet, speak);
b.Connect(speak, mc);
var topic = b.Topic("Tell me more");
var close = b.Finish(closeDialog: true);
b.Connect(c0, topic); b.Connect(c1, close);
b.Connect(topic, fin);
</syntaxhighlight>

=== Registering Dialog to NPC ===
TODO

=== Quest Dialog ===
TODO

=== Graph View Tool ===
TODO

Main Page

2026-05-24T01:47:55Z

Joshcamas:

Welcome to Ardenfall's '''Modding Wiki.'''

The goal for this wiki is to document modding tools, ardenfall's API, and also data mined components from the game itself.

It is officially maintained by Spellcast Studios, but is also opened to the public for editing, so there is no promise of complete correctness. (Although we'll do our best to ensure high quality pages!)

It ''can'' be treated as a standard game wiki (documenting quests and existing content), but the focus will still primarily centered on modding.

=== Modding Overview ===
[[Getting Started]]

[[Mod Scripting]]

[[Custom Asset Importing|Asset Importing]]

=== Official Tools ===
[[Game Debugger]]

=== Userbase Tools ===
- Your tool here

=== Scripting API ===
[[Codebase Overview]]

[[Messaging System]]

[[Asset Lookup Table]]

=== Tutorials ===
[[Creating Custom Items]]

[[Creating a Quest]]

[[Creating Dialog]]

Main Page

2026-05-24T00:39:53Z

Joshcamas:

Creating a Quest

2026-05-24T00:39:29Z

Joshcamas: Created page with "== Quest Data == TODO == Quest Phases == TODO == Quest Objectives == TODO == Quest Objects == TODO"

== Quest Data ==
TODO

== Quest Phases ==
TODO

== Quest Objectives ==
TODO

== Quest Objects ==
TODO

Main Page

2026-05-24T00:27:32Z

Joshcamas:

Asset Lookup Table

2026-05-24T00:26:56Z

Joshcamas: Created page with "The Asset Lookup Table is a key value store that holds many common pieces of data (Scriptable Objects) for the game to access at any time. This includes all items, all character data assets, all dialog/quest datas, and more. Note that NOT all data can be found in the lookup table. If you ever want some data to be included, ask us in the Discord. If it's reasonable, it may be able to be added in a future update. Internally it is used for any dataset that is referenced..."

The Asset Lookup Table is a key value store that holds many common pieces of data (Scriptable Objects) for the game to access at any time.

This includes all items, all character data assets, all dialog/quest datas, and more.

Note that NOT all data can be found in the lookup table. If you ever want some data to be included, ask us in the Discord. If it's reasonable, it may be able to be added in a future update.

Internally it is used for any dataset that is referenced in a save file, but for you, it's a treasure trove of data to dig through.

=== Asset IDs ===
For any built in asset, the IDs are in a format tied to unity's asset system.

You can use the ''LookupTable Searcher'' tool to find an item's ID, or you can use the LookupTable Dump button to dump all ids into a file you can read.

For custom assets, you can technically use any ID you want - however, I advise having it in the format of yourmod.itemid. For example: CoolCustomWeaponMod.GoldenSwordOfDoom. This ensures another mod that happens to also have a golden sword of doom doesn't clash with yours

=== API ===
TODO

Creating Custom Items

2026-05-24T00:24:13Z

Joshcamas: Created page with "The easiest way to create a custom item is to copy an existing ItemData in the Asset Lookup Table, then register your new ItemData back into the Asset Lookup Table. This will allow this item to be spawned, picked up, sold, and stolen. === Simple Item Example === TODO === Weapon Example === TODO === Armor Example === TODO"

The easiest way to create a custom item is to copy an existing ItemData in the Asset Lookup Table, then register your new ItemData back into the Asset Lookup Table.

This will allow this item to be spawned, picked up, sold, and stolen.

=== Simple Item Example ===
TODO

=== Weapon Example ===
TODO

=== Armor Example ===
TODO

Custom Asset Importing

2026-05-23T17:38:37Z

Joshcamas:

At some point you may want to import a new model, texture, sound, etc.

This can be done one of two ways - manually via scripting, or by using the built in mod asset importer feature. I suggest the latter, unless you want to do something funky.

=== Asset Manifest ===
Every mod can have an asset manifest file defined. This lists out all assets you want to import.

Create a file called manifest.txt in your mod directory.

''Example Asset Manifest''<syntaxhighlight lang="json">
{
"assets": [
{
"assetId": "testmod.dog",
"type": "texture",
"properties": [
{
"name": "path",
"value": "Assets/dog.png"
}
]
}
]
}
</syntaxhighlight>

=== Built in Importers ===
There are several built in importers to load up your assets. Most of them are pretty self explanatory!
{| class="wikitable"
|+
!Name
!Description
!ID
!Properties
|-
|GLTFScene
|Imports a GLTF file as a GameObject. Ideal for weapons, items, simple objects.
You can define a built in material to use, and it will automatically apply said material + hook up included textures.
|gltf_scene
|path: the path to the gltf file
shader: (optional) the shader id to import.
|-
|Texture
|Imports a .png or .jpeg as a Texture2D
|texture
|path: the path to the image file
|-
|AudioClip
|Imports a .mp3, .wav, or .ogg as an ArdenAudioClip
|audio_clip
|path: the path to the audio file
|-
|AssetBundle
|Imports a unity asset bundle.
|asset_bundle
|path: the path to the asset bundle file
|}

==== GLTFScene ====
A GLTF scene / model importer. Will import the GLTF object as a gameobject.

Supports material applying using ModMaterialResolver.

Built on the [https://docs.unity3d.com/Packages/com.unity.cloud.gltfast@6.0/manual/index.html GLTFFast] library.

Properties
{| class="wikitable"
|+
!Property
!Required
!Default
!Description
|-
|path
|YES
| -
|The path to the gltf / glb file
|-
|shader
|NO
|"Ardenfall/SimpleDiffuse"
|Defines the shader to be imported.
Only a single shader per scene is supported at the moment.

See Common Shaders for a list of shaders to try out.

If you leave it blank, will not import any materials.
|}

=== Common Shaders ===

==== SimpleDiffuse ====
''"Ardenfall/Simple Diffuse"''

The most common shader used in Ardenfall. An opaque shader that supports:

- Texture, Color, Cullmode, Cutoff

- Specularity, Fake Specularity

- Emission Texture, Emission Color, Emission Fading, Time of Day Emission

- Pivot Rotation Animation

- Vertex Wind Animation

- Fresnel

- Triplaner Texture

'''SimpleDiffuse Transparent'''

''"Ardenfall/Simple Diffuse Transparent"''

A version of the Simple Diffuse shader that is transparent.

'''EnchantableItem'''

''"Ardenfall/Enchantable Item Diffuse"''

The shader used for items that have enchanted glows. (Weapons)

==== CharacterSkin ====
''"Ardenfall/Avatar/Character Skin"''

The shader used for characters (humanoid skin, monsters bodies).

'''CharacterClothing'''

''"Ardenfall/Avatar/Character Clothing"''

The shader used for character clothing/armor.

=== Example: A Custom Weapon ===
TODO

Custom Asset Importing

2026-05-23T17:36:11Z

Joshcamas:

At some point you may want to import a new model, texture, sound, etc.

This can be done one of two ways - manually via scripting, or by using the built in mod asset importer feature. I suggest the latter, unless you want to do something funky.

=== Asset Manifest ===
Every mod can have an asset manifest file defined. This lists out all assets you want to import.

Create a file called manifest.txt in your mod directory.

''Example Asset Manifest''<syntaxhighlight lang="json">
{
"assets": [
{
"assetId": "testmod.dog",
"type": "texture",
"properties": [
{
"name": "path",
"value": "Assets/dog.png"
}
]
}
]
}
</syntaxhighlight>

=== Built in Importers ===
There are several built in importers to load up your assets. Most of them are pretty self explanatory!
{| class="wikitable"
|+
!Name
!Description
!ID
!Properties
|-
|GLTFScene
|Imports a GLTF file as a GameObject. Ideal for weapons, items, simple objects.
You can define a built in material to use, and it will automatically apply said material + hook up included textures.
|gltf_scene
|path: the path to the gltf file
|-
|Texture
|Imports a .png or .jpeg as a Texture2D
|texture
|path: the path to the image file
|-
|AudioClip
|Imports a .mp3, .wav, or .ogg as an ArdenAudioClip
|audio_clip
|path: the path to the audio file
|-
|AssetBundle
|Imports a unity asset bundle.
|asset_bundle
|path: the path to the asset bundle file
|}

==== GLTFScene ====
A GLTF scene / model importer. Will import the GLTF object as a gameobject.

Supports material applying using ModMaterialResolver.

Built on the [https://docs.unity3d.com/Packages/com.unity.cloud.gltfast@6.0/manual/index.html GLTFFast] library.

Properties
{| class="wikitable"
|+
!Property
!Required
!Default
!Description
|-
|path
|YES
| -
|The path to the gltf / glb file
|-
|material
|NO
|"Ardenfall/SimpleDiffuse"
|Defines the shader to be imported.
Only a single shader per scene is supported at the moment.
See Common Shaders for a list of shaders to try out.
|}

=== Common Shaders ===

==== SimpleDiffuse ====
''"Ardenfall/Simple Diffuse"''

The most common shader used in Ardenfall. An opaque shader that supports:

- Texture, Color, Cullmode, Cutoff

- Specularity, Fake Specularity

- Emission Texture, Emission Color, Emission Fading, Time of Day Emission

- Pivot Rotation Animation

- Vertex Wind Animation

- Fresnel

- Triplaner Texture

'''SimpleDiffuse Transparent'''

''"Ardenfall/Simple Diffuse Transparent"''

A version of the Simple Diffuse shader that is transparent.

'''EnchantableItem'''

''"Ardenfall/Enchantable Item Diffuse"''

The shader used for items that have enchanted glows. (Weapons)

==== CharacterSkin ====
''"Ardenfall/Avatar/Character Skin"''

The shader used for characters (humanoid skin, monsters bodies).

'''CharacterClothing'''

''"Ardenfall/Avatar/Character Clothing"''

The shader used for character clothing/armor.

=== Example: A Custom Weapon ===
TODO

Category:Pages with syntax highlighting errors

2026-05-22T18:14:32Z

Joshcamas: Created blank page

MediaWiki:Hidden-category-category

2026-05-22T18:13:30Z

Joshcamas:

Hidden categories

Category:Pages with syntax highlighting errors

MediaWiki:Hidden-category-category

2026-05-22T18:13:14Z

Joshcamas: Created page with "Hidden categories Category:Pages with syntax highlighting errors"

Hidden categories
Category:Pages with syntax highlighting errors

Custom Asset Importing

2026-05-22T18:09:07Z

Joshcamas:

Game Debugger

2026-05-22T04:38:21Z

Joshcamas:

The game debugger is a UI available in the game.

== Getting Started ==
To enable debug tools, edit the buildsettings.txt file alongside your installation. Set "enableDebugTools":true.

To open the debugger, load up a game (the debugger is not available in the main menu), and press F1.

== Utilities Tab ==
This tab is for lots of miscellaneous debug features.

=== Dead Body Revival ===
If you look at a dead body, a special menu will appear at the top of the utility debugger. This will let you revive

=== Player Editor ===
Enable/Disable God Mode: Make the player unable to die. (You will lose health, but not die)

Heal Player: Fully heal yourself

Enable/Disable Fly: Fly into the heavens. You can also press F to toggle this

Enable/Disable Speed Boost: Move very quickly

Add all Traits to Player: Give yourself all traits. Used to test dialog!

=== Time Editor ===
Morning/Day/Evening/Night: Set the time to a preset

Freeze Time: Makes time stop moving forward
Hour, Minute: Add hours and minutes to the current time.

=== Weather Editor ===
Random (Instant): Will randomly change the weather instantly
Random (Transition): Will randomly change the weather, but will slowly transition. Pressing this while already transitioning can cause bugs
Enable Region Weathers: Select a specific weather to switch to

=== Spawn NPC ===
Spawn a specific npc where the mouse is pointing

=== Spawn Item ===
Spawns a specific item. Pressing Spawn Pickup will spawn the item on the ground, and Add to Inventory will add it to your inventory with a specific count.
'''Tip:''' If you are looking at an NPC, there is an option to add it to their inventory.

=== Player Preset ===
Switch to a handful of player presets. Switch To will only switch the race / gender, and Switch To + Inventory will also give the player the preset inventory and equipment

=== Teleport To Location ===
Teleport to a map location or a certain cell.

=== NPC Cheats ===
Kill X Characters: Kill all of the loaded NPC’s

Destroy X Characters: Destroy (leave no bodies) all of the loaded NPC’s

Destroy X Enemies: Destroy (leave no bodies) all of the loaded Enemy NPC’s

Random Spawning: Will toggle random monster spawning

=== AI Cheats ===
AI: Toggles npc AI

AI Navigation: Toggles npcs being able to move around

Force Stealth UI Display: Toggles making the Stealth UI to always enabled, regardless of sneak

AI Logging: Toggles verbose logging of NPC AI

NPC Viz: Toggles showing NPC info Gizmos at a distance

NPC State Viz: Toggles showing NPC AI state Gizmos

Viz Brightness: Toggles showing the brightness calculation Gizmos for the AI

Viz Random Spawning NPCs: Toggles showing the position Gizmos of all of the random spawners

=== Steam Cheats ===
Add 1 to Stat [test]: tests a specific steam stat

Trigger [ESCAPED_STARTING_DUNGEON] achievement tests a specific steam achievement

Wipe Achievements: Erases the achievements of the player

=== Item Cheats ===
Add a lot of items to your inventory

=== Misc Cheats ===
Refresh Avatars: Forces all avatars to regenerate their meshes

Audio Gizmos: Toggles gizmos for audio sources

Player Collisions: Doesn’t work

Recalculate ALL Character’s Items: Recalculate all spawned characters item stats

Recalculate ALL Character’s Stats: Recalculate all spawned characters stats

Disable Dialog Conditions: Will force dialog topics and multiple choices to always be enabled

Freeze Timescale: Freezes game time. Stops animations, movement, and so on.

Cinematic Mode: Makes shooting arrows and fireballs shoot from the hands, not the camera

Ambient Lighting: Toggles ambient lighting

Player Creation Menu: Toggles the player creation menu from opening

Clear Tutorial Messages: Clear what tutorial messages have been seen by the player

Level Up: Force the player to level up

Log Lookup Table: Only usable in build. Will log the entire lookup table

Mockup Overlays: Lets you mockup HUD elements

World Streaming Toggle world loading. This can be used to stop world loading freezing in editor in particular.

Dialog Debug Text: Don’t know

Test Popup: tests popup UI

= Quest Debugger =
Lets you debug quests. There are two sections: Enabled and Disabled quests.

Current State: The current state

Current Phase: The current phase

Phases: The list of phases. You can also see the objectives and their state.

Objects: The list of objects. If it is a character object, you can teleport to that character.

Variables: The list of variables, and their value

Entry Points: A list of entry points. More info here.

= Character Debugger =
The Character Debugger lets you debug and modify a certain character.

Dropdown: Select a spawned character by name

Select Targeted: Select the character you are looking at

Select Player: Select the player

Select Nearest: Select the nearest NPC

Enable Gizmos: Will force Gizmos to be enabled even when this window is closed

Heal: Fully heals this character

=== Stats ===
Lists all of the characters stats. Attributes, Skills, and other stats.

=== Stat Editor ===
Modify Level: Lets you set the level of the character

Update Range Stats: Force the ranged stats (health, mana, etc) to be recalculated

Modify Attributes: Set all attributes to a certain value

Modify Skills: Set all skills to a certain value

Full Editor: Here you can edit the attributes and skills. Press “Load From Character” to update the editor with the current character’s stats, then you can edit and then press “Save to Character”

=== Factions ===
Displays the factions the character is in.

=== Inventory ===
Displays all of the items the character has in their inventory

=== Avatar Meshes ===
Displays info on the visible and invisible avatar meshes

=== Hand State Handler ===
Displays state of the current hand state handler

=== Visibility ===
Displays state of what characters are attacking them, and what characters the npc can see

=== Blackboard ===
The list of saved blackboard variables to this character

=== AI ===
Player Visibility (Aware): What visibility the player would be at if the character was aware

Player Visibility: What visibility the player is at right now

Player Light Visibility: The light visibility of the player

Player Sound Strength: The strength of the last sound the player made

Player Last Sound: How long ago the last sound the player made

Blackboard: The AI blackboard values

Targeter: Information related to the AI’s targeting system

Awareness: Values related to detection of player

Current State: The current AI state

Package List: The list of packages for the current state, and which current package.

=== Navigator ===
Show info related to the navigator

=== Test Path to Player ===
Debug whether the character could path to the player

=== Dialog Graphs ===
Displays the list of dialog graphs attached to this character

=== Utilities ===
Add .25 Reputation: Adds a bit of rep towards the player

Remove .25 Reputation: Removes a bit of rep towards the player

Teleport Player to Character: Teleport yourself to the character’s position

Teleport Character to Player: Teleport the character to your own position

Teleport Camera to Character: Teleport the free camera to the character’s position

Teleport Character to Camera: Teleport the character to the free camera’s position

Disable AI: Disable AI for this character

Enable AI: Enable AI for this character

Kill: Kill the character

Clear ‘Has Interacted With’: Clear the value that stops dialog from appearing multiple times

Force NPC to path to Player: Doesn’t work

Fill Health: Heal character

Clear Health: Set health to 1

Select Character: Select character in editor

Select Avatar: Select avatar in editor

== Mod Debugger ==
The Mod Debugger allows you to reload mods while playing (very useful), as well as view information about mods.

Main Page

2026-05-22T04:33:14Z

Joshcamas:

Game Debugger

2026-05-22T04:32:43Z

Joshcamas: Created page with "The game debugger is a UI available in the game. == Getting Started == To enable debug tools, edit the buildsettings.txt file alongside your installation. Set "enableDebugTools":true. To open the debugger, load up a game (the debugger is not available in the main menu), and press F1. == Utilities Tab == This tab is for lots of miscellaneous debug features. === Dead Body Revival === If you look at a dead body, a special menu will appear at the top of the utility debu..."

Main Page

2026-05-22T04:06:55Z

Joshcamas:

Welcome to Ardenfall's '''Modding Wiki.'''

The goal for this wiki is to document modding tools, ardenfall's API, and also data mined components from the game itself.

It is officially maintained by Spellcast Studios, but is also opened to the public for editing, so there is no promise of complete correctness. (Although we'll do our best to ensure high quality pages!)

It ''can'' be treated as a standard game wiki (documenting quests and existing content), but the focus will still primarily centered on modding.

=== Modding Overview ===
[[Getting Started]]

[[Mod Scripting]]

[[Custom Asset Importing|Asset Importing]]

=== Official Tools ===
[[Debug Tools]]

=== Userbase Tools ===
- Your tool here

=== Scripting API ===
[[Codebase Overview]]

[[Messaging System]]

Main Page

2026-05-22T02:43:23Z

Joshcamas:

Welcome to Ardenfall's '''Modding Wiki.'''

The goal for this wiki is to document modding tools, ardenfall's API, and also data mined components from the game itself.

It is officially maintained by Spellcast Studios, but is also opened to the public for editing, so there is no promise of complete correctness. (Although we'll do our best to ensure high quality pages!)

It ''can'' be treated as a standard game wiki (documenting quests and existing content), but the focus will still primarily centered on modding.

=== Modding Overview ===
[[Getting Started]]

[[Mod Scripting]]

[[Custom Asset Importing|Asset Importing]]

=== Tools ===
[[Debug Tools]]

=== Scripting API ===
[[Codebase Overview]]

[[Messaging System]]

Codebase Overview

2026-05-22T02:42:55Z

Joshcamas: Created page with "=== Core Systems === TODO === World Systems === TODO === Items === TODO === Characters === TODO === Combat === TODO === NPC AI === TODO frameless"

=== Core Systems ===
TODO

=== World Systems ===
TODO

=== Items ===
TODO

=== Characters ===
TODO

=== Combat ===
TODO

=== NPC AI ===
TODO
[[File:Ardenfall AI Overview.png|left|frameless]]

File:Ardenfall AI Overview.png

2026-05-22T02:39:39Z

Joshcamas:

A graph explaining the AI system

Messaging System

2026-05-22T01:58:28Z

Joshcamas:

One of the most useful ways to hook into the game is by use of the MessagingSystem.

Ardenfall has a host of messages that are sent when stuff happens. "CharacterDeathMessage", "CharacterKillMessage", "EffectAddMessage"... there are over 100 messages that you can subscribe (or send).

You can also define your own messages, for yourself or other mods.

Example of a mod that begins listening to CharacterDeathMessage on initialize, and stops listening on uninitialize.

'''Important:''' Be sure to clean up your listeners!<syntaxhighlight lang="c#">
using Ardenfall;
using UnityEngine;
using System;

namespace ExampleMod
{
public class ExampleMod : ModRoot
{
public override void Initialize(string id)
{
base.Initialize(id);

//Begin listening to death messages
MessagingSystem.AddListener(typeof(CharacterDeathMessage), (Action<CharacterBase, DamageContext>)OnDeath);
}

public override void Uninitialize()
{
base.Uninitialize();

//Stoplistening to death messages
MessagingSystem.RemoveListener(typeof(CharacterDeathMessage), (Action<CharacterBase, DamageContext>)OnDeath);
}

//Triggered when any character dies
private void OnDeath(CharacterBase character, DamageContext context)
{
if(character is PlayerCharacter)
Debug.Log($"Player has died!");
else
Debug.Log($"Character {character.GetVisualName()} has died!");
}
}
}
</syntaxhighlight>

=== Useful Messages ===
CharacterDeathMessage(CharacterBase target, DamageContext context)

Triggered when a character dies.

CharacterDamageMessage(CharacterBase target, DamageContext context)

Triggered when character is damaged.

CharacterKillMessage(CharacterBase killer, DamageContext context)

Triggered when a character kills another. You can access context.victim to read who died.

EffectAddMessage(StatusEffectInstance effect)

Triggered whenever an Effect is added to an IEffectable. Can access effect.Target to read who the target is.

EffectRemoveMessage(StatusEffectInstance effect)

Triggered whenever an Effect is removed from an IEffectable. Can access effect.Target to read who the target is.

InventoryChangeMessage(Inventory inventory, ItemData item, int count, bool isAdded)

Triggered whenever an item stack in an Inventory is modified (items added or removed). Can access inventory.OwnerChar (can be null) to see what character owns it, if any. Inventories are also used with containers.

EquipChangeMessage(CharacterBase character, BaseItem item, bool isEquipped)

Triggered whenever a character unequips or equips an item

=== Tooling ===
Planned: Add tool to easily view all messages available

Under Consideration: Add tool to detect + display messages being triggered

Main Page

2026-05-22T01:58:06Z

Joshcamas:

Welcome to Ardenfall's '''Modding Wiki.'''

The goal for this wiki is to document modding tools, ardenfall's API, and also data mined components from the game itself.

It is officially maintained by Spellcast Studios, but is also opened to the public for editing, so there is no promise of complete correctness. (Although we'll do our best to ensure high quality pages!)

It ''can'' be treated as a standard game wiki (documenting quests and existing content), but the focus will still primarily centered on modding.

=== Modding Overview ===
[[Getting Started]]

[[Mod Scripting]]

[[Custom Asset Importing|Asset Importing]]

=== Tools ===
[[Debug Tools]]

=== Scripting API ===
[[Messaging System]]

Messaging System

2026-05-22T01:57:13Z

Joshcamas:

One of the most useful ways to hook into the game is by use of the MessagingSystem.

Ardenfall has a host of messages that are sent when stuff happens. "CharacterDeathMessage", "CharacterKillMessage", "EffectAddMessage"... there are over 100 messages that you can subscribe (or send).

You can also define your own messages, for yourself or other mods.

Example of a mod that begins listening to CharacterDeathMessage on initialize, and stops listening on uninitialize.

'''Important:''' Be sure to clean up your listeners!<syntaxhighlight lang="c#">
using Ardenfall;
using UnityEngine;
using System;
using ImGuiNET;

namespace ExampleMod
{
public class ExampleMod : ModRoot
{
public override void Initialize(string id)
{
base.Initialize(id);

//Begin listening to death messages
MessagingSystem.AddListener(typeof(CharacterDeathMessage), (Action<CharacterBase, DamageContext>)OnDeath);
}

public override void Uninitialize()
{
base.Uninitialize();

//Stoplistening to death messages
MessagingSystem.RemoveListener(typeof(CharacterDeathMessage), (Action<CharacterBase, DamageContext>)OnDeath);
}

//Triggered when any character dies
private void OnDeath(CharacterBase character, DamageContext context)
{
if(character is PlayerCharacter)
Debug.Log($"Player has died!");
else
Debug.Log($"Character {character.GetVisualName()} has died!");
}
}
}
</syntaxhighlight>

=== Useful Messages ===
CharacterDeathMessage(CharacterBase target, DamageContext context)

Triggered when a character dies.

CharacterDamageMessage(CharacterBase target, DamageContext context)

Triggered when character is damaged.

CharacterKillMessage(CharacterBase killer, DamageContext context)

Triggered when a character kills another. You can access context.victim to read who died.

EffectAddMessage(StatusEffectInstance effect)

Triggered whenever an Effect is added to an IEffectable. Can access effect.Target to read who the target is.

EffectRemoveMessage(StatusEffectInstance effect)

Triggered whenever an Effect is removed from an IEffectable. Can access effect.Target to read who the target is.

InventoryChangeMessage(Inventory inventory, ItemData item, int count, bool isAdded)

Triggered whenever an item stack in an Inventory is modified (items added or removed). Can access inventory.OwnerChar (can be null) to see what character owns it, if any. Inventories are also used with containers.

EquipChangeMessage(CharacterBase character, BaseItem item, bool isEquipped)

Triggered whenever a character unequips or equips an item

=== Tooling ===
Planned: Add tool to easily view all messages available

Under Consideration: Add tool to detect + display messages being triggered

Messaging System

2026-05-22T01:57:00Z

Joshcamas:

One of the most useful ways to hook into the game is by use of the MessagingSystem.

Ardenfall has a host of messages that are sent when stuff happens. "CharacterDeathMessage", "CharacterKillMessage", "EffectAddMessage"... there are over 100 messages that you can subscribe (or send).

You can also define your own messages, for yourself or other mods.

Example of a mod that begins listening to '''CharacterDeathMessage''' on initialize, and stops listening on uninitialize.

'''Important:''' Be sure to clean up your listeners!<syntaxhighlight lang="c#">
using Ardenfall;
using UnityEngine;
using System;
using ImGuiNET;

namespace ExampleMod
{
public class ExampleMod : ModRoot
{
public override void Initialize(string id)
{
base.Initialize(id);

//Begin listening to death messages
MessagingSystem.AddListener(typeof(CharacterDeathMessage), (Action<CharacterBase, DamageContext>)OnDeath);
}

public override void Uninitialize()
{
base.Uninitialize();

//Stoplistening to death messages
MessagingSystem.RemoveListener(typeof(CharacterDeathMessage), (Action<CharacterBase, DamageContext>)OnDeath);
}

//Triggered when any character dies
private void OnDeath(CharacterBase character, DamageContext context)
{
if(character is PlayerCharacter)
Debug.Log($"Player has died!");
else
Debug.Log($"Character {character.GetVisualName()} has died!");
}
}
}
</syntaxhighlight>

=== Useful Messages ===
CharacterDeathMessage(CharacterBase target, DamageContext context)

Triggered when a character dies.

CharacterDamageMessage(CharacterBase target, DamageContext context)

Triggered when character is damaged.

CharacterKillMessage(CharacterBase killer, DamageContext context)

Triggered when a character kills another. You can access context.victim to read who died.

EffectAddMessage(StatusEffectInstance effect)

Triggered whenever an Effect is added to an IEffectable. Can access effect.Target to read who the target is.

EffectRemoveMessage(StatusEffectInstance effect)

Triggered whenever an Effect is removed from an IEffectable. Can access effect.Target to read who the target is.

InventoryChangeMessage(Inventory inventory, ItemData item, int count, bool isAdded)

Triggered whenever an item stack in an Inventory is modified (items added or removed). Can access inventory.OwnerChar (can be null) to see what character owns it, if any. Inventories are also used with containers.

EquipChangeMessage(CharacterBase character, BaseItem item, bool isEquipped)

Triggered whenever a character unequips or equips an item

=== Tooling ===
Planned: Add tool to easily view all messages available

Under Consideration: Add tool to detect + display messages being triggered

Custom Asset Importing

2026-05-22T01:12:26Z

Joshcamas:

Getting Started

2026-05-22T01:10:59Z

Joshcamas:

[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.
Ardenfall_Data
StreamingAssets
Mods
YourModDirectory
mod_metadata.txt
mod_manifest.txt
Assets
Textures
yourtexture.png
Scripts
yourscript.cs

=== 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".<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 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 ===
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.

Mod Scripting

2026-05-22T01:08:02Z

Joshcamas:

=== Mod Root ===
Essentially every mod needs a Mod Root class definition. This is your hook into the mod activation and deactivation events, as well as additional hooks.

Your mod root class can be anywhere in the mod's Scripts folder within a .cs file.

There are two main methods you probably want to override:

Initialize(string id): Called when the mod is initialized. This happens on boot (if the mod is active), or whenever the mod is activated.

Uninitialize(string id): Called when the mod is uninitialized. This happens whenever the mod is deactivated.

''Barebones Example:''<syntaxhighlight lang="c#" line="1">
using Ardenfall;
using UnityEngine;
using System;

namespace ExampleMod
{
public class ExampleMod : ModRoot
{
public override void Initialize(string id)
{
base.Initialize(id);
Debug.Log("Loaded Example Mod! WOW!");
}

public override void Uninitialize()
{
base.Uninitialize();
Debug.Log("Unloaded Example Mod! WOW!");
}
}
}
</syntaxhighlight>

=== Mod Saving ===
By default, mods do not save custom data. But you can do it!

Override the following methods:

void CreateState(): Run when a new game is made, or when the mod is loaded for a save for the first time. Use this to initialize a default state.

void LoadState(string state): Load your state from previously saved data.

string SaveState(): Save your state to a string.

If you want to serialize data, you can use JsonUtility, or whatever other serializer you get your hands on, as long as its a string.

Example of a mod that saves state.<syntaxhighlight lang="c#" line="1">using Ardenfall;
using UnityEngine;
using System;

namespace ExampleSaveMod
{
public class ExampleSaveMod : ModRoot
{
private float randomNumber;

public override void Initialize(string id)
{
base.Initialize(id);
Debug.Log("Loaded Example Mod! WOW!");
}

public override void Uninitialize()
{
base.Uninitialize();
Debug.Log("Unloaded Example Mod! WOW!");
}

public override void CreateState()
{
randomNumber = UnityEngine.Random.value;
}

//Save state. You can save it as json or any format, it just needs to be a string.
public override string SaveState()
{
var state = new ExampleModSaveState()
{
randomNumber = randomNumber
};

return JsonUtility.ToJson(state);
}

//Load the state as a string.
public override void LoadState(string jsonState)
{
var state = JsonUtility.FromJson<ExampleModSaveState>(jsonState);
randomNumber = state.randomNumber;
Debug.Log(randomNumber);
}
}

[System.Serializable]
public class ExampleModSaveState
{
public float randomNumber;
}
}</syntaxhighlight>

=== Debugging Mods ===
TODO (IMGUI Debugging)

TODO (Graph Debugging)

=== Lookup Table Registration ===
To register or modify assets, you can hook into the lookup table initialization step.

The Lookup Table is a big list of assets that is commonly used in the engine, tied to an id. Beyond modding, it's used by the save system - any asset that is referenced in the save file (such as an item in the inventory) must be registered to the lookup table. The lookup table does not contain EVERY asset, however.

If you ever run into needing a certain asset in the lookup table, throw me (joshcamas) a message on discord.

Non scripting methods to create/modify assets is planned in the future.

''Example of creating a new asset and registering it to the lookup table''

TODO

Lookup Table Tools

TODO

=== Records Registration ===
You may also want to create Records with your mods. Records are objects in the world that can be accessed / manipulated at any time. The most common Record is the CharacterRecord, but there are others.

TODO

'''NOTE:''' If a mod spawns or modifies a record, and then the user disables the mod, this record will still exist in old save files. No immediate solutions for this, since players should expect odd things to happen when disabling mods and then loading an old save.

=== Mod Version Patching ===
TODO: Add built in Mod Version Patching Support

=== Mod Settings ===
TODO: Add Mod settings support.

=== A note on Hot Reloading / Refreshing ===
Ardenfall's modding systems supports hot reloading. That is to say, reloading the mod without restarting the game.

The mod user can always turn your mod on and off in the main menu, and you should ensure your mods correctly clean up during this state, otherwise it will cause problems for your users. However, users should expect weird things to occur on old save files that used to have the mod, of course.

As a mod developer, you can also turn your mod on and off / refresh it while actually playing the game. You don't officially need support for this (no one will know) but making your mod work in this circumstance as much as possible is great from a developmental standpoint - you can super quickly work on your mods without needing to restart the application, or even maybe not reloading the save file sometimes.

Mod Scripting

2026-05-21T19:52:58Z

Joshcamas:

=== Mod Root ===
Essentially every mod needs a Mod Root class definition. This is your hook into the mod activation and deactivation events, as well as additional hooks.

Your mod root class can be anywhere in the mod folder within a .cs file, but I'd suggest putting it in YourModDirectory/Scripts/mod.cs.

There are two main methods you probably want to override:

Initialize(string id): Called when the mod is initialized. This happens on boot (if the mod is active), or whenever the mod is activated.

Uninitialize(string id): Called when the mod is uninitialized. This happens whenever the mod is deactivated.

''Barebones Example:''<syntaxhighlight lang="c#" line="1">
using Ardenfall;
using UnityEngine;
using System;

namespace ExampleMod
{
public class ExampleMod : ModRoot
{
public override void Initialize(string id)
{
base.Initialize(id);
Debug.Log("Loaded Example Mod! WOW!");
}

public override void Uninitialize()
{
base.Uninitialize();
Debug.Log("Unloaded Example Mod! WOW!");
}
}
}
</syntaxhighlight>

=== Mod Saving ===
By default, mods do not save custom data. But you can do it!

Override the following methods:

void CreateState(): Run when a new game is made, or when the mod is loaded for a save for the first time. Use this to initialize a default state.

void LoadState(string state): Load your state from previously saved data.

string SaveState(): Save your state to a string.

If you want to serialize data, you can use JsonUtility, or whatever other serializer you get your hands on, as long as its a string.

Example of a mod that saves state.<syntaxhighlight lang="c#" line="1">using Ardenfall;
using UnityEngine;
using System;

namespace ExampleSaveMod
{
public class ExampleSaveMod : ModRoot
{
private float randomNumber;

public override void Initialize(string id)
{
base.Initialize(id);
Debug.Log("Loaded Example Mod! WOW!");
}

public override void Uninitialize()
{
base.Uninitialize();
Debug.Log("Unloaded Example Mod! WOW!");
}

public override void CreateState()
{
randomNumber = UnityEngine.Random.value;
}

//Save state. You can save it as json or any format, it just needs to be a string.
public override string SaveState()
{
var state = new ExampleModSaveState()
{
randomNumber = randomNumber
};

return JsonUtility.ToJson(state);
}

//Load the state as a string.
public override void LoadState(string jsonState)
{
var state = JsonUtility.FromJson<ExampleModSaveState>(jsonState);
randomNumber = state.randomNumber;
Debug.Log(randomNumber);
}
}

[System.Serializable]
public class ExampleModSaveState
{
public float randomNumber;
}
}</syntaxhighlight>

=== Debugging Mods ===
TODO (IMGUI Debugging)

TODO (Graph Debugging)

=== Lookup Table Registration ===
To register or modify assets, you can hook into the lookup table initialization step.

The Lookup Table is a big list of assets that is commonly used in the engine, tied to an id. Beyond modding, it's used by the save system - any asset that is referenced in the save file (such as an item in the inventory) must be registered to the lookup table. The lookup table does not contain EVERY asset, however.

If you ever run into needing a certain asset in the lookup table, throw me (joshcamas) a message on discord.

Non scripting methods to create/modify assets is planned in the future.

''Example of creating a new asset and registering it to the lookup table''

TODO

Lookup Table Tools

TODO

=== Records Registration ===
You may also want to create Records with your mods. Records are objects in the world that can be accessed / manipulated at any time. The most common Record is the CharacterRecord, but there are others.

TODO

'''NOTE:''' If a mod spawns or modifies a record, and then the user disables the mod, this record will still exist in old save files. No immediate solutions for this, since players should expect odd things to happen when disabling mods and then loading an old save.

=== Mod Version Patching ===
TODO: Add built in Mod Version Patching Support

=== Mod Settings ===
TODO: Add Mod settings support.

=== A note on Hot Reloading / Refreshing ===
Ardenfall's modding systems supports hot reloading. That is to say, reloading the mod without restarting the game.

The mod user can always turn your mod on and off in the main menu, and you should ensure your mods correctly clean up during this state, otherwise it will cause problems for your users. However, users should expect weird things to occur on old save files that used to have the mod, of course.

As a mod developer, you can also turn your mod on and off / refresh it while actually playing the game. You don't officially need support for this (no one will know) but making your mod work in this circumstance as much as possible is great from a developmental standpoint - you can super quickly work on your mods without needing to restart the application, or even maybe not reloading the save file sometimes.

Main Page

2026-05-20T20:38:15Z

Joshcamas:

Welcome to Ardenfall's '''Modding Wiki.'''

The goal for this wiki is to document modding tools, ardenfall's API, and also data mined components from the game itself.

It is officially maintained by Spellcast Studios, but is also opened to the public for editing, so there is no promise of complete correctness. (Although we'll do our best to ensure high quality pages!)

It ''can'' be treated as a standard game wiki (documenting quests and existing content), but the focus will still primarily centered on modding.

=== Modding ===
[[Getting Started]]

[[Mod Scripting]]

[[Messaging System]]

[[Custom Asset Importing]]

[[Debug Tools]]

Messaging System

2026-05-20T20:37:49Z

Joshcamas: Created page with "One of the most useful ways to hook into the game is by use of the MessagingSystem. Ardenfall has a host of messages that are sent when stuff happens. "CharacterDeathMessage", "CharacterKillMessage", "EffectAddMessage"... there are over 100 messages that you can subscribe (or send). You can also define your own messages, for yourself or other mods. TODO: Examples TODO: Common Messages TODO: Add tool to easily view messages"

Main Page

2026-05-20T20:28:44Z

Joshcamas:

Debug Tools

2026-05-20T20:28:30Z

Joshcamas: Created page with "=== F1 Debugger === The main debug tool available is the F1 debugger. TODO"

=== F1 Debugger ===
The main debug tool available is the F1 debugger.

TODO

Main Page

2026-05-20T20:27:56Z

Joshcamas:

Custom Asset Importing

2026-05-20T20:27:40Z

Joshcamas: Created page with "At some point you may want to import a new model, texture, sound, etc. This can be done one of two ways - manually via scripting, or by using the built in mod asset importer feature. I suggest the latter, unless you want to do something funky. === Asset Manifest === Every mod can have an asset manifest file defined. This lists out all assets you want to import. TODO === Supported Importers === SimpleModel: Imports a GLTF file as a gameobject. You can define a..."

Main Page

2026-05-20T20:22:45Z

Joshcamas:

Mod Scripting

2026-05-20T20:22:28Z

Joshcamas:

=== Mod Root ===
Essentially every mod needs a Mod Root class definition. This is your hook into the mod activation and deactivation events, as well as additional hooks.

Your mod root class can be anywhere in the mod folder within a .cs file, but I'd suggest putting it in YourModDirectory/Scripts/mod.cs.

There are two main methods you probably want to override:

Initialize(string id): Called when the mod is initialized. This happens on boot (if the mod is active), or whenever the mod is activated.

Uninitialize(string id): Called when the mod is uninitialized. This happens whenever the mod is deactivated.

''Barebones Example:''<syntaxhighlight lang="c#" line="1">
using Ardenfall;
using UnityEngine;
using System;

namespace ExampleMod
{
public class ExampleMod : ModRoot
{
public override void Initialize(string id)
{
base.Initialize(id);
Debug.Log("Loaded Example Mod! WOW!");
}

public override void Uninitialize()
{
base.Uninitialize();
Debug.Log("Unloaded Example Mod! WOW!");
}
}
}
</syntaxhighlight>

=== Mod Saving ===
By default, mods do not save custom data. But you can do it!

Use the interface ISaveMod on your ModRoot script, and implement the following methods:

void CreateState(): Run when a new game is made, or when the mod is loaded for a save for the first time. Use this to initialize a default state.

void LoadState(string state): Load your state from previously saved data.

string SaveState(): Save your state to a string.

If you want to serialize data, you can use JsonUtility, or whatever other serializer you get your hands on, as long as its a string.

Example of a mod that saves state.<syntaxhighlight lang="c#" line="1">using Ardenfall;
using UnityEngine;
using System;

namespace ExampleSaveMod
{
public class ExampleSaveMod : ModRoot, ISaveMod,
{
private float randomNumber;

public override void Initialize(string id)
{
base.Initialize(id);
Debug.Log("Loaded Example Mod! WOW!");
}

public override void Uninitialize()
{
base.Uninitialize();
Debug.Log("Unloaded Example Mod! WOW!");
}

void ISaveMod.CreateState()
{
randomNumber = UnityEngine.Random.value;
}

//Save state. You can save it as json or any format, it just needs to be a string.
string ISaveMod.SaveState()
{
var state = new ExampleModSaveState()
{
randomNumber = randomNumber
};

return JsonUtility.ToJson(state);
}

//Load the state as a string.
void ISaveMod.LoadState(string jsonState)
{
var state = JsonUtility.FromJson<ExampleModSaveState>(jsonState);
randomNumber = state.randomNumber;
Debug.Log(randomNumber);
}
}

[System.Serializable]
public class ExampleModSaveState
{
public float randomNumber;
}
}</syntaxhighlight>

=== Debugging Mods ===
TODO (IMGUI Debugging)

TODO (Graph Debugging)

=== Lookup Table Registration ===
To register or modify assets, you can hook into the lookup table initialization step.

The Lookup Table is a big list of assets that is commonly used in the engine, tied to an id. Beyond modding, it's used by the save system - any asset that is referenced in the save file (such as an item in the inventory) must be registered to the lookup table. The lookup table does not contain EVERY asset, however.

If you ever run into needing a certain asset in the lookup table, throw me (joshcamas) a message on discord.

Be careful when modifying assets in particular - users expect to be able to disable mods easily, and if you wreck an asset and disabling mods doesn't undo it, players may be unhappy.

Non scripting methods to create/modify assets is planned in the future.

''Example of creating a new asset and registering it to the lookup table''

TODO

Lookup Table Tools

TODO

=== Records Registration ===
You may also want to create Records with your mods. Records are objects in the world that can be accessed / manipulated at any time. The most common Record is the CharacterRecord, but there are others.

TODO

=== A note on Hot Reloading / Refreshing ===
Ardenfall's modding systems supports hot reloading. That is to say, reloading the mod without restarting the game.

The mod user can always turn your mod on and off in the main menu, and you should ensure your mods correctly clean up during this state, otherwise it will cause problems for your users.

As a mod developer, you can also turn your mod on and off / refresh it while actually playing the game. You don't officially need support for this (no one will know) but making your mod work in this circumstance as much as possible is great from a developmental standpoint - you can super quickly work on your mods without worries.

Mod Scripting

2026-05-20T19:38:31Z

Joshcamas: Created page with "TODO"

TODO

Creating Dialog

2026-05-20T19:38:10Z

Joshcamas: Created page with "TODO"

TODO

Creating Quests

2026-05-20T19:37:55Z

Joshcamas: Created page with "TODO"

TODO

Main Page

2026-05-20T19:34:34Z

Joshcamas:

Main Page

2026-05-20T19:33:40Z

Joshcamas:

Welcome to Ardenfall's '''Modding Wiki.'''

The goal for this wiki is to document modding tools, ardenfall's API, and also data mined components from the game itself.

It ''can'' be treated as a standard game wiki (documenting quests and existing content), but the focus will still primarily centered on modding.

=== Modding ===
[[Getting Started]]

Getting Started

2026-05-20T17:52:01Z

Joshcamas:

[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.
Ardenfall_Data
StreamingAssets
Mods
YourModDirectory
mod_metadata.txt
Assets
yourtexture.png
Scripts
yourscript.cs

=== 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".<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.

Main Page

2026-05-20T17:51:51Z

Joshcamas:

Ardenfall's main page.

Getting Started

2026-05-20T17:50:21Z

Joshcamas:

[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.

Main Page

2026-05-20T17:50:15Z

Joshcamas:

Ardenfall's main page

Getting Started

2026-05-20T06:08:17Z

Joshcamas: Created page with "TODO"

TODO