From 3fe8372cd63d7c665653a446d7e717c3dfe11b3b Mon Sep 17 00:00:00 2001
From: Lucas Schwiderski <lucas@sclu1034.dev>
Date: Thu, 23 Feb 2023 09:43:26 +0100
Subject: [PATCH] Update 'Bundle Patcher Architecture'

---
 Bundle-Patcher-Architecture.md | 51 ++++++++++++++++++++++++++++++++--
 1 file changed, 49 insertions(+), 2 deletions(-)

diff --git a/Bundle-Patcher-Architecture.md b/Bundle-Patcher-Architecture.md
index 7897ae0..a86fc15 100644
--- a/Bundle-Patcher-Architecture.md
+++ b/Bundle-Patcher-Architecture.md
@@ -1,4 +1,4 @@
-This is an (likely incomplete) documentation of how dtmm's process to deploy mods and patch game bundles works and what data it writes.
+This is a (likely incomplete) documentation of how dtmm's process to deploy mods and patch game bundles works and what data it writes.
 
 ## settings.ini
 
@@ -11,14 +11,61 @@ The game's `application_settings/settings-common.ini` is changed with
 
 This allows us to run our own entry point before the game's code, without touching the actual `scripts/main` file.
 
+## packages/dml
+
+An independent mod that's handled specially. Its purpose is to handle the initial mod loading, what used to be `ModManager` in VT2.
+`scripts/mod_main` expects this mod to return an API based on this template:
+
+```lua
+local obj = {}
+
+-- boot_gui Gui A special Gui object created by the game that can be used to display status on
+-- mod_data table The contents of `scripts/mods/mod_data.lua` as described below.
+-- libs table A key-value map of certain Lua libraries/globals that the game strips, but that might be useful during the loading process
+function obj:init(boot_gui, mod_data, libs)
+end
+
+-- dt number The delta time since the last call
+function obj:update(dt)
+	return is_done
+end
+
+return obj
+```
+
 ## packages/boot
 
 Several files are added to `packages/boot`:
 
 * `scripts/mod_main.lua`: The very first file of code that the game will run at startup. This sets up mod handling and then calls Fatshark's actual `scripts/main` entry point.
 * `scripts/mods/mod_data.lua`: This file mod metadata and the load order, all of which the mod manager will use to load the installed mods.
-* `scripts/mods/manager.lua`: An adapted version of `ModManager` from VT2 that handles loading and initialization of mods. The file path is the same as the game source already uses for the inactive `StateBootLoadMods`.
 * `packages/mods.package`: The `.package` file that points to the separate mod collection bundle
+* `packages/dml.package`: See above
+
+**Example for `scripts/mods/mod_data_lua`:**
+
+```lua
+return {
+  {
+    name = "Darktide Mod Framework",
+    id = "dmf",
+    run = function()
+      return dofile("scripts/mods/dmf/dmf_loader")
+    end,
+  },
+  {
+    name = "Test Mod",
+    id = "test-mod",
+    run = function()
+      return new_mod("test-mod", {
+        script = "scripts/mods/test-mod/init",
+        data = "scripts/mods/test-mod/data",
+        localization = "scripts/mods/test-mod/localization",
+      })
+    end,
+  },
+}
+```
 
 ## packages/mods