#Built-in Mods and Submodules

ModLoader splits non-core functionality into separate Mods and ships common ones as built-ins. These Mods are defined in modList.json, live as Git submodules under mod/, and are embedded as local type into the game HTML via insert2html. This list is aligned with the sugarcube-2-ModLoader README.

#Core Infrastructure

#Twee Content Operations

#Images and UI

#i18n Internationalization

#DoL-Specific Hooks

#Game Content Plugins

#External Mods and Tools

#Common Addon Usage Examples

#TweeReplacer

Replace game Passage content. Declare the dependency in boot.json:

{
  "addonPlugin": [
    {
      "modName": "TweeReplacer",
      "addonName": "tweeReplacer",
      "modVersion": "1.0.0",
      "params": []
    }
  ]
}

#ReplacePatch

Simple string replacement for JS/CSS/Passage content:

{
  "addonPlugin": [
    {
      "modName": "ReplacePatch",
      "addonName": "replacePatch",
      "modVersion": "1.0.0",
      "params": []
    }
  ]
}

#ImageLoaderHook

Replace game images. Add images to imgFileList — images matching base game paths are replaced automatically:

{
  "imgFileList": ["MyMod_Image/character/avatar.png", "MyMod_Image/backgrounds/room.jpg"],
  "addonPlugin": [
    {
      "modName": "ImageLoaderHook",
      "addonName": "imgLoaderHook",
      "modVersion": "1.0.0",
      "params": []
    }
  ]
}

#Creating a Custom Addon

If none of the built-in addons fit, you can create a custom addon:

// Register during inject_early or earlyload
(async () => {
  const addonInstance = {
    registerMod(modName, modZip, params) {
      console.log(`Mod ${modName} registered with my addon`);
    },
  };

  window.modAddonPluginManager.registerAddonPlugin("MyCustomAddon", "customPlugin", addonInstance);
})();

Consumer mods declare the dependency in their boot.json:

{
  "addonPlugin": [
    {
      "modName": "MyCustomAddon",
      "addonName": "customPlugin",
      "modVersion": "1.0.0",
      "params": []
    }
  ]
}