CI/CD Build Pipeline

Estimated reading time: 2 minutes

The ModLoader ecosystem uses GitHub Actions for builds and releases. Artifacts can be downloaded directly without local builds.

RepositoryDescription
sugarcube-2_VrelnirModified SC2 engine with ModLoader bootstrap
sugarcube-2-ModLoaderModLoader core and Insert Tools
DoLModLoaderBuildDoL build with ModLoader and built-in Mods

Modified SC2 Engine

  • Actions: sugarcube-2_Vrelnir/actions
  • Artifacts: format.js (ModLoader bootstrap, Wikifier changes, img/svg interception)
  • Use: Override devTools/tweego/storyFormats/sugarcube-2/format.js in the game project, or use sc2ReplaceTool on compiled HTML

ModLoader and Tools

  • Actions: sugarcube-2-ModLoader/actions
  • Artifacts:
    • BeforeSC2.js — ModLoader core
    • insert2html.js — HTML injection tool
    • packModZip.js — Mod packaging tool
    • sc2ReplaceTool.js — SC2 replacement tool
    • Pre-built Mod zips (from submodules in modList.json)
  • Use: Inject ModLoader into game HTML, or package Mods

DoL Automated Build

Build Order

Building the full game from scratch:

ELK not loaded. Ensure /elk.bundled.js is loaded before the app.

DoLModLoaderBuild usually automates this and publishes to Releases.