SFMC

Scripts For Minecraft Server

一个面向 Minecraft 基岩版服务器的模块化开发框架与管理平台。让开发者可以使用现代化工程流程构建、部署和维护 Minecraft 服务端功能。

SFMC 希望通过模块化架构补充基岩版的原生开发体验。

核心特性

• 基于 Minecraft ScriptAPI 提供 原生脚本 SDK
• 提供可独立拆卸的 模块化管理服务
• 提供面向 BDS 的多功能 CLI 工具，支持：
  • 自动更新
  • 模块管理
  • 资源包管理
  • 服务端工具链管理
• 为模块提供统一的 SQLite 数据库 SDK 与路由服务
• 提供完整工作流，降低模块开发与维护成本
• 支持 LLBOT / QQ 开放平台 桥接，实现服务器与线上群组互联

模块仓库 →

English Version →

快速开始

使用 npm 安装

# 检查 Node.js 版本（需要 v22.13+）
node -v

# 安装 SFMC CLI
npm install -g @sfmc-bds/sfmc

# Beta 版本
npm install -g @sfmc-bds/sfmc@beta

# 创建服务器目录
mkdir my-server && cd my-server

# 初始化 SFMC
sfmc

开发者可以直接克隆本 monorepo，详细内容请查看 入门指南。

文档

• 在线文档 https://dogelakedev.github.io/ScriptsForMinecraftServer/

• 使用指南 docs/zh/guide

• 开发指南 docs/zh/dev

  • 贡献指南

• API 文档 docs/zh/api

• SDK 类型参考 docs/zh/reference

许可证

SFMC 整体平台采用 AGPL-3.0 许可证。

各软件包许可证对应关系请参考 LICENSES.md。

• 自由使用：你可以运行、复制、分发和修改程序，同时保留这些自由。
• Copyleft（AGPL 部分）：如果你分发修改后的平台或服务版本，必须以相同许可证提供完整对应源代码。
• 模块仓库：独立仓库中的业务模块可以自行选择许可证。通过 ISC 授权 SDK 开发模块不会自动使模块受到 AGPL 限制。

---

English Version →