#Build & Distribution

This document introduces the maplebirchFramework build toolchain, build commands, and packaging workflow.

#Build Toolchain

#Build Commands

#Rspack Configuration

#Entry and Output

Entry: ./src/main.ts
Output: dist/inject_early.js

Output is configured as a window-type library exporting as maplebirch:

output: {
  filename: 'inject_early.js',
  library: {
    name: 'maplebirch',
    type: 'window',
    export: 'default'
  }
}

This means the bundled code mounts the MaplebirchCore instance to window.maplebirch.

#TypeScript Compilation

Uses Rspack's built-in SWC loader to compile TypeScript:

• Target: > 0.5%, not dead, not ie 11
• Supports .twee files as raw text resources (?raw query parameter)

#Development Server

The dev server runs on port 5678 and provides:

• Static file serving (game/ directory)
• /modList.json endpoint: Auto-scans .zip files under game/mods/ and lists them
• /{name}-{version}.mod.zip endpoint: Dynamically creates mod zip files

#Type Declaration Generation

tsup is configured to generate type-only declaration files:

Entry: src/main.ts
Output: dist/maplebirch.d.ts
Mode: dts only

The generated maplebirch.d.ts contains type definitions for all public framework APIs, for use by Mod developers who depend on the framework.

#Packaging Workflow

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

The final .mod.zip file contains:

• dist/inject_early.js — Compiled framework code
• dist/maplebirch.d.ts — TypeScript type declarations
• boot.json — Generated from scml field in package.json
• Other required files

#boot.json Generation

boot.json is automatically generated from the scml section in package.json:

{
  "scml": {
    "nickName": {
      "en": "Maplebirch Frameworks",
      "cn": "秋枫白桦框架"
    },
    "alias": ["Simple Frameworks"],
    "scriptFileList": ["defineSugarCube.js"],
    "dependenceInfo": [
      { "modName": "ModLoader", "version": ">=2.0.0" },
      ...
    ]
  }
}

#Project Structure