SFMC - ScriptsForMinecraftServer

一套 Minecraft Bedrock Script API (SAPI) 行为包 + Node.js 仓顶服务的 monorepo。

🎉 在原生BDS即可获得类似插件服的高效、安全、扩展丰富的体验

• 提供基于Minecraft Script API的原生脚本SDK
• 外置可拆卸的模块化管理服务，拥有类似插件服的舒适体验；目前已开发22+实用模块
• 为BDS服务器提供的多功能、易用的cli工具，涵盖自动更新，模块管理，资源包管理，远程控制等功能
• 为模块提供Sqlite数据库管理SDK及其路由服务
• 自建工作流，使模组/模块开发更轻松
• 依赖于LLBOT的QQ桥接服务，轻松实现群服互通

模块仓库 →
English version →

---

🔍 架构图

flowchart LR
  REG["sfmc-modules"] -->|fetch| PKG["packages/"]
  PKG -->|build · deploy| BDS["BDS / SAPI"]
  BDS <-->|HTTP| DB["db-server"]
  Bot <-->|WS · HTTP| QQ["qq-bridge"] --> DB
  SFMC["sfmc CLI"] -. 管理 .-> BDS & DB & QQ

Loading

数据流摘要

• 模块：注册表 → modules/packages/ → esbuild 装配 → 写入 BDS 行为包
• 游戏内：SAPI 经 HTTP 访问 db-server（配置 / 数据 / 模块启停）

为什么用外置数据库？
SAPI 只发请求，读写 SQLite 在 Node 里完成。经济、领地这类操作可以走事务和幂等，比纯游戏内处理更稳，也更好备份。

详细说明见 文档中心（MkDocs：npm run docs -- serve）。

⚡️ 快速开始

npm 聚合包（推荐）

> node -v   # 需要 v22.13+
> npm install -g @sfmc-bds/sfmc # 或 beta 版：npm install -g @sfmc-bds/sfmc@beta
> mkdir my-server && cd my-server
> sfmc

当前阶段仅发 beta；请带 @beta 安装。见 npm 发布指南。

开发者也可克隆本仓 monorepo，见 安装指南。

📖 快速入门

分类	入口
在线文档站	https://dogelakedev.github.io/ScriptsForMinecraftServer/
使用指南	docs/guide/
开发指南	docs/dev/ · 贡献指南
接口指南	docs/api/
SDK 类型参考	docs/reference/（npm run docs -- api）
本地预览	pip install -r docs/requirements.txt → npm run docs -- serve

🗺️ 路线图

• ✅ Stage I:per-module sapi/manifest.json + db-server reader
• ✅ Stage J:shared/* 迁入 @sfmc-bds/sdk,22 模块迁出
• ✅ Stage K:模块按需安装 —— populate 由 tools/fetch-module.mjs / sfmc module install 完成
• 🚧 Stage L:模块 zip 自动解压、sfmc module install --enable-and-deploy 一条龙
• 🚧 Stage M:模块签名 / 公钥验证(取代纯 SHA-256 指纹)
• 🚧 Stage N+:服务网格(多 BDS 实例 / 跨节点)

🧾 许可证

AGPL-3.0

• 自由：您可以运行、复制、分发、修改程序，但必须保持这些自由。
• Copyleft：如果您分发修改后的版本，必须以相同许可证（AGPL v3）提供完整的源代码。
• 源代码：必须提供“对应源代码”（Corresponding Source），包括所有脚本、接口定义、共享库等，以便他人能重新构建和修改。
• 附加条款：您可以添加额外许可，但不能增加限制（第 7 条）。

---

⚠️ AI辅助内容声明 该资源部分使用人工智能（AI）工具协助进行研究、起草、格式化、优化和开发工作流程。

所有AI生成的内容在发布前均经过人工审查、编辑和验证。

AI用于提高生产力、可访问性和工作流程效率，而非取代人工监督、专业或判断。

English version →