Ardenfall Wiki - Recent changes [en]

Game Debugger

Joshcamas — Mon, 17 Aug 2026 20:31:30 GMT

← Older revision		Revision as of 16:31, 17 August 2026
Line 6:		Line 6:
	To open the debugger, load up a game (the debugger is not available in the main menu), and press F1.		To open the debugger, load up a game (the debugger is not available in the main menu), and press F1.

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

Line 118:		Line 118:
	Test Popup: tests popup UI		Test Popup: tests popup UI

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

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

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

Line 241:		Line 241:
	Select Avatar: Select avatar in editor		Select Avatar: Select avatar in editor

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

			'''Reload Mods'''

			Used to reload all activated mods. You still need to go to the main menu to activate/deactivate mods for now.

			'''Graph Viewer'''

			Mods that override IGraphView can register their created graphs to be viewable here.

			'''Lookup Table'''

			Search and find lookup table objects here.

			'''Positions'''

			Good to debug positions

			'''Look Points'''

			Same thing but with your current look position

			'''Debug Mods'''

			Mods that are set up to hook into the debugger appear here. More info [[Mod Scripting#Debugging Mods\|here]].

Custom Asset Importing

Joshcamas — Mon, 17 Aug 2026 20:30:38 GMT

← Older revision		Revision as of 16:30, 17 August 2026
Line 6:		Line 6:
	Every mod can have an asset manifest file defined. This lists out all assets you want to import.		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.		Create a file called mod_manifest.txt in your mod directory.

	''Example Asset Manifest''<syntaxhighlight lang="json">		''Example Asset Manifest''<syntaxhighlight lang="json">

Debug Tools

Joshcamas — Mon, 17 Aug 2026 20:30:12 GMT

Joshcamas deleted page Debug Tools content was: "=== F1 Debugger === The main debug tool available is the F1 debugger. TODO", and the only contributor was "Joshcamas" (talk)

Mod Scripting

Joshcamas — Mon, 17 Aug 2026 20:23:37 GMT

← Older revision		Revision as of 16:23, 17 August 2026
Line 8:		Line 8:
	Initialize(string id): Called when the mod is initialized. This happens on boot (if the mod is active), or whenever the mod is activated.		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.		Uninitialize(): Called when the mod is uninitialized. This happens whenever the mod is deactivated.

	''Barebones Example:''<syntaxhighlight lang="c#" line="1">		''Barebones Example:''<syntaxhighlight lang="c#" line="1">

Modding Support Status

Joshcamas — Thu, 30 Jul 2026 23:22:22 GMT

← Older revision		Revision as of 19:22, 30 July 2026
(One intermediate revision by the same user not shown)
Line 86:		Line 86:
	# Need a way to invalidate lookup table values, whenever a mod refreshes. This can be done via a cache index.		# Need a way to invalidate lookup table values, whenever a mod refreshes. This can be done via a cache index.
	# Need better tooling to find IDs of assets		# Need better tooling to find IDs of assets
	\|~~PLANNED~~		\|COMPLETE
	\|-		\|-
	\|Warn if mods aren't loaded correctly		\|Warn if mods aren't loaded correctly
	\|When loading a save, and the save has a mod enabled that is no longer enabled, it should show a warning.		\|When loading a save, and the save has a mod enabled that is no longer enabled, it should show a warning.
	\|PLANNED		\|PLANNED
			\|-
			\|Tool: Position Debugger
			\|Little tool that tells you where a position is in the world. Useful to figure out where you want to spawn items.
			\|COMPLETE
	\|-		\|-
	\|Mod Settings: JSON		\|Mod Settings: JSON
	\|Add support for mods to have a json file for settings, to allow the mod users to tweak the mod.		\|Add support for mods to have a json file for settings, to allow the mod users to tweak the mod.
	~~\|PLANNED~~
	\|-
	~~\|Tool: Position Debugger~~
	~~\|Little tool that tells you where a position is in the world. Useful to figure out where you want to spawn items.~~
	\|PLANNED		\|PLANNED
	\|-		\|-

Main Page

Joshcamas — Thu, 30 Jul 2026 01:36:02 GMT

← Older revision		Revision as of 21:36, 29 July 2026
Line 28:		Line 28:

	[[Asset Lookup Table]]		[[Asset Lookup Table]]

			[[Creating UI]]

	=== Tutorials ===		=== Tutorials ===

Creating UI

Joshcamas — Thu, 30 Jul 2026 01:35:40 GMT

Created page with "Creating new UI elements is for now, quite simple. More complex UI features will be coming later. == Event Message == Event Message is text that appears on the top left of the screen. Can appear at any time in gameplay and in most menus. Messages will stack, and only a handful will appear at a time. === ShowMessage === Displays the message<syntaxhighlight lang="c#">//Shows a simple text message. Will play a sound, and will stack. EventMessageInfoUI.ShowMessage(string m..."

New page

Creating new UI elements is for now, quite simple. More complex UI features will be coming later.

== Event Message ==
Event Message is text that appears on the top left of the screen. Can appear at any time in gameplay and in most menus. Messages will stack, and only a handful will appear at a time.

=== ShowMessage ===
Displays the message<syntaxhighlight lang="c#">//Shows a simple text message. Will play a sound, and will stack.
EventMessageInfoUI.ShowMessage(string message);

//Shows a message with the more complex EventMessageUIMessageItem
EventMessageInfoUI.ShowMessage(EventMessageUIMessageItem message);</syntaxhighlight>

=== Event Message UI Message Item ===
<syntaxhighlight lang="c#">
EventMessageUIMessageItem:
string text // The text message
bool allowStacking = true // Whether duplicate messages will stack
bool playSound = true // Whether the message will display a sound when it appears
bool skipIfVisible // Whether to not display the message entirely if a duplicate one is visible
int stackCount = 1 // How many 'stacks' this message counts as (This is uncommonly used)
</syntaxhighlight>

== Alert Message UI ==
An alert message is a popup that pauses the game, and can appear at any time in gameplay or in any menu.

=== 'Ok' Alert ===
Displays an alert with a title (optional), text, and an ok button. You can hook into the button event. Supports AlertMessageSettings.<syntaxhighlight lang="c#">
AlertMessageUI.OpenAlertMessage(string title, string message, Action onOk = null, string customOkLabel = null, AlertMessageSettings settings = new AlertMessageSettings())
</syntaxhighlight>

=== Cancelable Alert ===
Displays an alert with a title (optional), text, and a ok + cancel button. You can hook into both button events. Supports AlertMessageSettings.<syntaxhighlight lang="c#">
AlertMessageUI.OpenCancelableAlertMessage(string title, string message, Action onOk, Action onCancel = null, string customOkLabel = null, string customCancelLabel = null, AlertMessageSettings settings = new AlertMessageSettings())
</syntaxhighlight>

=== No Buttons Alert ===
An alert with a title (optional), and text. No buttons. Supports AlertMessageSettings. Meant to be paired with Alert objects.<syntaxhighlight lang="c#">
AlertMessageUI.OpenNoButtonsAlertMessage(string title, string message, AlertMessageSettings settings = new AlertMessageSettings())
</syntaxhighlight>

=== Alert Message Settings ===
A few settings to modify an alert.

<u>onTopOfFader:</u> Makes the alert message appear on top of the fading screen. Useful to display narration popups.

<u>objects:</u> Allows you to register Alert Objects<syntaxhighlight lang="c#">
AlertMessageSettings:
bool onTopOfFader
List<AlertMessageObject> objects

</syntaxhighlight>

=== Other Methods ===
<syntaxhighlight lang="c#">
//Closes the current alert if there is one
void AlertMessageUI.CloseCurrentAlert();

//Returns whether an alert message is open
bool AlertMessageUI.IsOpen();

</syntaxhighlight>

=== Alert Objects ===
Add additional buttons, toggles, sliders, text input, dropdowns, and more.<syntaxhighlight lang="c#">
AlertMessageSliderObject:
string title
float min
float max
float value
bool isInt

AlertMessageToggleObject
string title
bool value

AlertMessageTextInputObject
string title
string value
int characterLimit
Func<string, bool> Validate

AlertMessageDropdownObject
string title
int value
List<TMP_Dropdown.OptionData> options

AlertMessageButtonObject
string title
string label
Action onClick

AlertMessageImageObject
string title
Sprite texture

</syntaxhighlight>

Modding Support Status

Joshcamas — Tue, 21 Jul 2026 21:03:19 GMT

@@ Line 118: / Line 118: @@
 |Support injecting dialog into characters without involving a Quest
 |PLANNED
 |-
 |Tool: Item Editor

Custom Asset Importing

Joshcamas — Mon, 20 Jul 2026 04:40:07 GMT

@@ Line 56: / Line 56: @@
 |path: the path to the asset bundle file
 |-
-|Item
+|ScriptableObject
 |Creates a new item based on properties.
-|item
+|scriptable_object
-|(See documentation)
+|path: the path to the scriptable object definition file
 |}
@@ Line 92: / Line 92: @@
 If you leave it blank, will not import any materials.
 |}
 {| class="wikitable"
 |}
 === Common Shaders ===

Creating Custom Items

Joshcamas — Mon, 20 Jul 2026 04:22:40 GMT

@@ Line 4: / Line 4: @@
 === Simple Item Example ===
-TODO
+This is how to create a 'misc' item, which is an item that can be picked up, sold, etc, but not equipped or anything fancy.
-=== Weapon Example ===
+<u>Import Model</u>
 TODO
 === Armor Example ===
 TODO

Modding Support Status

Joshcamas — Mon, 20 Jul 2026 03:41:25 GMT

← Older revision		Revision as of 23:41, 19 July 2026
Line 63:		Line 63:
	\|Very basic graph viewer		\|Very basic graph viewer
	\|A very basic (and ugly) viewer for your dialog / quest graphs. Is not an editor, as it can only view.		\|A very basic (and ugly) viewer for your dialog / quest graphs. Is not an editor, as it can only view.
			\|COMPLETE
			\|-
			\|Item Importer 2.0
			\|Currently all items are importing with a very simple importer, with each entry hand picked. This is not ideal. Seems like a much better way to go about it would be to have each item be its own JSON file, and then create a generic scriptable object importer that can overwrite values.
	\|COMPLETE		\|COMPLETE
	\|-		\|-
Line 71:		Line 75:
	\|Armor Item Importing		\|Armor Item Importing
	\|Importing of armor. Will require some way to create ClothingAssets as well, potentially another importer? (This would mean we need a multi pass importer system, shiver)		\|Importing of armor. Will require some way to create ClothingAssets as well, potentially another importer? (This would mean we need a multi pass importer system, shiver)
	~~\|PLANNED~~
	\|-
	~~\|Item Importer 2.0~~
	\|Currently all items are importing with a very simple importer, with each entry hand picked. This is not ideal. Seems like a much better way to go about it would be to have each item be its own JSON file, and then create a generic scriptable object importer that can overwrite values.
	\|PLANNED		\|PLANNED
	\|-		\|-

Main Page

Joshcamas — Mon, 20 Jul 2026 01:13:10 GMT

← Older revision		Revision as of 21:13, 19 July 2026
Line 6:		Line 6:

	If you are interested in contributing, join the discord and ask!		If you are interested in contributing, join the discord and ask!

			See [[Modding Support Status]] to check on what's supported currently.

	=== Modding Overview ===		=== Modding Overview ===

Modding Support Status

Joshcamas — Mon, 20 Jul 2026 01:12:30 GMT

Created page with "Since the game isn't even out, naturally modding is in a VERY early state. Practically everything could change, so please don't get too attached to your mods at this stage. Modding support will be broken into a few stages. The first stage, Pre-EA, is focused on just getting the bare minimum fully working and with high ease of use ASSUMING you know how to code. After EA we will continue to flesh out modding features, with a focus on adding visual tools to make creating..."

New page

Since the game isn't even out, naturally modding is in a VERY early state. Practically everything could change, so please don't get too attached to your mods at this stage.

Modding support will be broken into a few stages. The first stage, Pre-EA, is focused on just getting the bare minimum fully working and with high ease of use ASSUMING you know how to code.

After EA we will continue to flesh out modding features, with a focus on adding visual tools to make creating mods easier and faster, with less digging through code.

Here is a overview of features and their statuses. This is by no means a comprehensive list, and anything 'Under Consideration' is just that: not guaranteed to be added.
{| class="wikitable"
|+
!Feature
!Description
!Status
|-
|Core Mod Loading
|Mod manifest, enabling, disabling
|COMPLETE
|-
|Mod Saving: Custom Data
|Serialized and deserialize strings to a save file
|COMPLETE
|-
|Scriptable Lookup Table Modification
|Add and modify assets in the lookup table
|COMPLETE
|-
|Mod Generator
|Simple tool to get started with a new mod
|COMPLETE
|-
|Core Mod Asset Importer
|Core asset importer feature to be used across many importers
|COMPLETE
|-
|Static Model Importing
|Importing of static GLTF models
|COMPLETE
|-
|Texture, Audio Importing
|Importing of textures and audio files
|COMPLETE
|-
|Misc Item Importing
|Importing of simple misc item
|COMPLETE
|-
|Child Item Importing
|Importing of child items
|COMPLETE
|-
|Melee Item Importing
|Importing of melee items
|COMPLETE
|-
|Code-Based Quest Support
|Very clunky quest creation via code
|COMPLETE, Not documented
|-
|Code-Based Dialog Support for Quests
|Very clunky dialog creation via code.
|COMPLETE, Not documented
|-
|Very basic graph viewer
|A very basic (and ugly) viewer for your dialog / quest graphs. Is not an editor, as it can only view.
|COMPLETE
|-
|Blender Rig
|Ship the blender rig to make it easy to create new armors and clothing.
|PLANNED
|-
|Armor Item Importing
|Importing of armor. Will require some way to create ClothingAssets as well, potentially another importer? (This would mean we need a multi pass importer system, *shiver*)
|PLANNED
|-
|Item Importer 2.0
|Currently all items are importing with a very simple importer, with each entry hand picked. This is not ideal. Seems like a much better way to go about it would be to have each item be its own JSON file, and then create a generic scriptable object importer that can overwrite values.
|PLANNED
|-
|Simple Modding UI
|Currently the main way for mods to display UI is through dialog or the Alert system. Both are quite limited.
The Moddable UI System would allow for new simple UI’s to be introduced, with the ability to create more complex interfaces, such as buttons, data lists, scrollbars, etc. They could support being opened via keybind, through interacting with an object, or some other way.
|PLANNED
|-
|Lookup Table Tooling
|
# Need a way to invalidate lookup table values, whenever a mod refreshes. This can be done via a cache index.
# Need better tooling to find IDs of assets
|PLANNED
|-
|Warn if mods aren't loaded correctly
|When loading a save, and the save has a mod enabled that is no longer enabled, it should show a warning.
|PLANNED
|-
|Mod Settings: JSON
|Add support for mods to have a json file for settings, to allow the mod users to tweak the mod.
|PLANNED
|-
|Tool: Position Debugger
|Little tool that tells you where a position is in the world. Useful to figure out where you want to spawn items.
|PLANNED
|-
|Remove enum for item slot
|Currently item slots for characters is an enum. This is not mod friendly.
It should be ported to a scriptable object.
|PLANNED
|-
|Mod Dependencies
|Ensure mods can rely on others.
Mod dependencies can declare whether they must be loaded before, or any time.
|PLANNED
|-
|On Quest Start / Stop Hooks
|Obviously any logic in a modded quest doesn’t need to be (and really shouldn’t) be part of the graph, but instead be in your code.
Add hooks to on quest start / stop.
|PLANNED
|-
|Code-Based Dialog Support without Quests
|Support injecting dialog into characters without involving a Quest
|PLANNED
|-
|Tool: Item Editor
|A visual editor to edit / create items.
|UNDER CONSIDERATION
|-
|Tool: Item List Editor
|A visual editor to edit / create item lists.
|UNDER CONSIDERATION
|-
|Tool: Full Node Editor
|A true editor for graphs.
|UNDER CONSIDERATION
|-
|Tool: SpellData / Spell Creation
|Currently spells can be created via code. (Not documented).
This tool would allow for spells to be created visually.
|UNDER CONSIDERATION
|-
|Tool: NPC Editor
|Currently you can edit NPC’s via code.
This tool would allow you to edit/view NPC data visually.
|UNDER CONSIDERATION
|-
|Patch Mods
|Mods are designed to be added “on top” of ardenfall’s codebase. This allows for hot reloading, easy disable/enable, and less issues when updates occur. Patch Mods would be a separate type of mod, that would actually overwrite the actual source code of Ardenfall, similar to Harmony. (In fact, we'd use Harmony to do this). This would take more effort to get working, and could break whenever a game update happens, but would allow for "Skyrim Script Extender" sort of modding platforms that the community could build if they desired.
|UNDER CONSIDERATION
|-
|Simple Dialog API
|Create a way to make a dialog graph SUPER simply, without all the fancy connected stuff.
Example:
<code>CreateTopic(“What’s up?”).AddSpeak(“Nothing Much!”).Run(myMethod).CloseDialog();</code>
|UNDER CONSIDERATION
|-
|Mod Settings: Main Menu UI
|Make mod settings modifiable in the main menu, not just through a json file.
|UNDER CONSIDERATION
|-
|Custom Hair, Beard, Brow support
|Make it easy to set up new hair, beard, brows in the creation menu.
|UNDER CONSIDERATION
|-
|Custom Skills / Attributes / Traits Support
|Make it easy to set up new skills, attributes, and traits in the creation menu.
|UNDER CONSIDERATION
|-
|Custom Race Support
|Make it easy to set up a new character race in the creation menu.
|UNDER CONSIDERATION
|}

Custom Asset Importing

Joshcamas — Mon, 20 Jul 2026 00:50:00 GMT

@@ Line 55: / Line 55: @@
 |asset_bundle
 |path: the path to the asset bundle file
 |}
@@ Line 86: / Line 91: @@
 If you leave it blank, will not import any materials.
 |}

User:Artyom

Joshcamas — Sun, 19 Jul 2026 19:26:13 GMT

User account Artyom was created by Joshcamas