• English

      • Built-in Mods and Submodules

      Estimated reading time: 3 minutes

      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

      ModStatusDescription
      ModLoaderGuiUsableMod manager UI; manage load order, enable/disable Mods, view load logs
      ConflictCheckerStableConflict checker; additional constraints for Mod conflicts
      SweetAlert2ModStableAlert/prompt dialogs via SweetAlert2
      ModSubUiAngularJsStableReusable AngularJS-based UI components

      Twee Content Operations

      ModStatusDescription
      TweeReplacerStablePassage replacement with regex and file-based replacement strings
      I18nTweeReplacerStableNative i18n support for TweeReplacer
      TweeReplacerLinkerStableLinks TweeReplacer and I18nTweeReplacer, shares replace order
      ReplacePatchStableSimple string replacement for JS/CSS/Passage
      TweePrefixPostfixAddonDevelopingHooks before/after Passage/Widget execution
      Diff3WayMergeDevelopingPassage merge using Git Diff3Way algorithm

      Images and UI

      ModStatusDescription
      ImageLoaderHookStableIntercepts image requests, replaces images from Mod zip
      BeautySelectorAddonStableMultiple beauty image sets in one Mod, switchable at runtime
      ModuleCssReplacerDeprecatedCSS replacer (serious performance issues; do not use)

      i18n Internationalization

      ModStatusDescription
      I18nTweeListStablei18n support for tweeFileList
      I18nScriptListStablei18n support for scriptFileList

      DoL-Specific Hooks

      ModStatusDescription
      CheckGameVersionStableGame version check for dependency system (DoL)
      CheckDoLCompressorDictionariesStableChecks DoL data compression dictionary changes and warns users
      DoLHookWidgetModStablePatches DoL custom Widgets for TweePrefixPostfix
      DoLTimeWrapperAddon—DoL time wrapper hook
      DoLLinkButtonFilter—DoL link/button filter

      Game Content Plugins

      ModStatusDescription
      ModdedClothesAddonStableDoL quick clothing add tool
      ModdedFeatsAddonStableDoL quick achievement add tool
      ModdedHairAddonStableDoL quick hairstyle add tool

      External Mods and Tools

      ModTypeStatusDescription
      PhoneDebugToolsErudaExternalStableMobile debug tools, wrapper around Eruda
      i18nExternalStablei18n Chinese translation Mod
      CryptoI18nExampleDemov2.0.0 Mod encryption demo
      ExampleModModifyModExampleDemoShows how Mod B reads and modifies Mod A's data and behavior
      SimpleCryptWrapperToolsStableSimple Mod encryption wrapper
      DoLModWebpackExampleTsTemplateDemoMod template with Webpack + TypeScript
      DoLModWebpackExampleJsTemplateDemoMod template with Webpack + JavaScript
      Info

      For detailed usage of each Mod, see the corresponding Mod project's README.md.