快速上手

欢迎使用 ScriptsForMinecraftServer (SFMC)。SFMC 是为官方原版 Bedrock Dedicated Server (BDS) 打造的 SAPI 行为包生态与 Node.js 伴生服务架构。

你可以根据使用场景选择上手路径：

服主与运维部署

安装 CLI、初始化 BDS 服务端、安装常用模块与配置 QQ 互通机器人。

模块开发者指南

使用脚手架创建模块、本地 Watch 热重载调试与数据持久化开发。

系统要求

在开始之前，请确保运行环境满足以下要求：

项目	最低要求	推荐配置
操作系统	Windows 10 / 11, Linux (Ubuntu 20.04+, Debian 11+)	Linux (云服务器运行) / Windows (本地调试)
Node.js	`≥ 22.13.0`（需支持内置 `node:sqlite`）	最新 LTS 版本
包管理器	`pnpm`	`pnpm`
磁盘空间	≥ 2 GB（用于存放 BDS 核心、行为包产物与备份）	SSD 固态硬盘

快速安装与初始化

通过 CLI 工具 sfmc 可以一键完成 BDS 初始化、服务守护与模块管理。

1. 全局安装 CLI

pnpm add -g @sfmc-bds/[email protected]

版本与目录说明

pnpm v11 起对新发布的包存在版本解析延迟，初次安装建议显式指定版本；可通过 pnpm view @sfmc-bds/sfmc version 查看最新版本。数据默认存储在当前运行目录，也可通过环境变量 SFMC_ROOT 指定工作目录。

2. 创建服务器目录并启动向导

创建服务器专用目录并执行 sfmc：

mkdir my-minecraft-server
cd my-minecraft-server
sfmc

首次运行会自动启动初始化向导：

下载并解压当前操作系统适配的官方原版 BDS。
自动生成配置文件结构并绑定 JSON Schema。
初始化本地 SQLite 数据守护服务（db-server）。

初始化完成后的目录结构：

my-minecraft-server/
├── BedrockDedicatedServer/  # BDS 核心服务端程序
├── configs/                 # 服务与功能配置文件（db_config, qq_config 等）
├── data/                    # SQLite 数据库与运行时数据
├── packs/                   # 自动构建输出的行为包产物目录
└── modules/                 # 已下载与启用的功能模块

常用服务管理命令

在 sfmc 交互控制台（REPL）中可直接执行管理命令：

1. 启停服务

# 启动全部服务（db-server + qq-bridge + BDS）
sfmc> /start -all

# 仅启动 BDS 或查看当前运行状态
sfmc> /start bds
sfmc> /status

# 安全停止所有服务
sfmc> /stop -all

控制台快捷键

在控制台中按下 TAB 键，可在 BDS 控制台、数据库中枢和 QQ 桥接的日志流之间切换。

2. 模块管理

可以通过模块生态安装常用功能（如挂机检测、经济系统、传送点管理等）：

# 搜索可用模块
sfmc> mod search

# 安装指定模块
sfmc> mod install afk

# 启用模块
sfmc> mod enable afk

# 重新组装并向游戏请求重载
sfmc> mod reload

#快速上手

服主与运维部署

模块开发者指南

#系统要求

#快速安装与初始化

#1. 全局安装 CLI

#2. 创建服务器目录并启动向导

#常用服务管理命令

#1. 启停服务

#2. 模块管理

#相关文档