#构建与分发

本文介绍 maplebirchFramework 的构建工具链、构建命令和打包流程。

#构建工具链

#构建命令

#Rspack 配置

#入口与输出

入口: ./src/main.ts
输出: dist/inject_early.js

输出配置为 window 类型的库，导出名为 maplebirch：

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

这意味着打包后的代码会将 MaplebirchCore 实例挂载到 window.maplebirch。

#TypeScript 编译

使用 Rspack 内置的 SWC loader 编译 TypeScript：

• 目标：> 0.5%, not dead, not ie 11
• 支持 .twee 文件作为原始文本资源（?raw 查询参数）

#开发服务器

开发服务器运行在端口 5678，提供以下功能：

• 静态文件服务（game/ 目录）
• /modList.json 端点：自动扫描 game/mods/ 下的 .zip 文件并列出
• /{name}-{version}.mod.zip 端点：动态创建 mod zip 文件

#类型声明生成

tsup 配置生成仅类型声明文件：

入口: src/main.ts
输出: dist/maplebirch.d.ts
模式: dts only

生成的 maplebirch.d.ts 包含框架所有公开 API 的类型定义，供依赖框架的 Mod 开发者使用。

#打包流程

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

最终生成的 .mod.zip 文件包含：

• dist/inject_early.js — 编译后的框架代码
• dist/maplebirch.d.ts — TypeScript 类型声明
• boot.json — 由 package.json 中的 scml 字段生成
• 其他必要文件

#boot.json 生成

boot.json 从 package.json 的 scml 配置段自动生成：

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

#项目结构