Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/stable-install-guidance.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
"@sfmc-bds/cli": patch
"@sfmc-bds/sfmc": patch
---

修正正式版包内安装说明,并明确 pnpm 新发布版本的默认等待期和精确版本安装方式。
6 changes: 4 additions & 2 deletions README.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ Ensure **Node.js ≥ 22.13.0** is installed (required for native `node:sqlite` s

```bash
# 1. Install SFMC CLI globally
pnpm add -g @sfmc-bds/sfmc@beta
pnpm add -g @sfmc-bds/sfmc@0.2.2

# 2. Create and enter your server workspace
mkdir my-bedrock-server && cd my-bedrock-server
Expand All @@ -96,9 +96,11 @@ sfmc
sfmc> start -all

# 5. Search and install gameplay modules from the official index
sfmc> mod install economy land teleport
sfmc> mod install afk
```

pnpm v11+ waits 24 hours by default before selecting a newly published version from an unversioned package name. To install on release day, check `pnpm view @sfmc-bds/sfmc version` and pin that exact version as above.

### Track B: Module Authors (Build in 5 Minutes)

You don't need to clone this monorepo! Scaffold your standalone module repository directly:
Expand Down
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ SFMC 希望通过模块化架构补充基岩版的原生开发体验。
node -v

# 安装 SFMC CLI 正式版
pnpm add -g @sfmc-bds/sfmc
pnpm add -g @sfmc-bds/sfmc@0.2.2

# 创建服务器目录
mkdir my-server && cd my-server
Expand All @@ -50,6 +50,8 @@ mkdir my-server && cd my-server
sfmc
```

pnpm v11 起默认会等待新版本发布满 24 小时。发布当天若省略版本号,可能装到上一正式版;可用 `pnpm view @sfmc-bds/sfmc version` 查看当前 `latest`,再指定该精确版本安装。

开发者可以直接克隆本 monorepo,详细内容请查看
[入门指南](./docs/zh/guide/index.mdx)。

Expand Down
4 changes: 3 additions & 1 deletion docs/en/guide/backup-upgrade.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Do not copy `.db` files while db-server is running.
<Tab label="Global pnpm">

```bash
pnpm add -g @sfmc-bds/sfmc
pnpm add -g @sfmc-bds/sfmc@0.2.2
```

</Tab>
Expand All @@ -48,6 +48,8 @@ pnpm install && pnpm run build
</Tab>
</Tabs>

pnpm v11+ waits 24 hours by default before selecting a newly published version from an unversioned package name. For a release-day upgrade, check `pnpm view @sfmc-bds/sfmc version` and install that exact version.

Confirm `SFMC_ROOT` and the CLI version before changing the instance. Upgrading the CLI does not replace installed modules or the deployed behavior pack. In a maintenance window, install the intended module versions, then build and deploy before starting BDS:

```bash
Expand Down
4 changes: 3 additions & 1 deletion docs/en/guide/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ flowchart LR
<Tab label="Global pnpm">

```bash
pnpm add -g @sfmc-bds/sfmc
pnpm add -g @sfmc-bds/sfmc@0.2.2
mkdir my-server && cd my-server
sfmc
```
Expand All @@ -53,6 +53,8 @@ sfmc
</Tab>
</Tabs>

pnpm v11+ waits 24 hours by default before selecting a newly published version from an unversioned package name. On release day, use `pnpm view @sfmc-bds/sfmc version` and install that exact version as shown above. Use `@beta` only to opt into prereleases.

:::tip Note
This installs the stable `latest` release. Add `@beta` only when you want a prerelease.
Data defaults to the current directory; set `SFMC_ROOT` to use another root.
Expand Down
2 changes: 1 addition & 1 deletion docs/zh/dev/style-sample.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ flowchart LR
<Tab label="pnpm(推荐)">

```bash
pnpm add -g @sfmc-bds/sfmc
pnpm add -g @sfmc-bds/sfmc@0.2.2
mkdir my-server && cd my-server
sfmc
```
Expand Down
4 changes: 3 additions & 1 deletion docs/zh/guide/backup-upgrade.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -101,12 +101,14 @@ SFMC 平台的各层组件相互解耦,可按需分别升级:

```bash
# 获取最新版官方 CLI
pnpm add -g @sfmc-bds/sfmc
pnpm add -g @sfmc-bds/sfmc@0.2.2

# 验证更新后版本
sfmc --version
```

pnpm v11 起默认要求新版本发布满 24 小时才参与无版本号解析。升级当天请先运行 `pnpm view @sfmc-bds/sfmc version`,然后安装该精确版本。

</Tab>
<Tab label="平台 Monorepo 源码开发者">

Expand Down
4 changes: 2 additions & 2 deletions docs/zh/guide/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,11 +50,11 @@ SFMC 提供了全局编排 CLI 工具,可实现从 BDS 自动下载配置到
### 步骤 1:全局安装 SFMC CLI

```bash
pnpm add -g @sfmc-bds/sfmc
pnpm add -g @sfmc-bds/sfmc@0.2.2
```

:::tip 提示
默认安装正式版。若要试用预发布版本,再显式添加 `@beta`。如需在特定文件夹持久化数据,可通过配置 `SFMC_ROOT` 环境变量指定自定义工作目录。
pnpm v11 起默认要求新版本发布满 24 小时才参与无版本号解析。发布当天安装请指定上面的精确版本;可先用 `pnpm view @sfmc-bds/sfmc version` 查询当前 `latest`。只有试用预发布版本时才使用 `@beta`。如需在特定文件夹持久化数据,可通过配置 `SFMC_ROOT` 环境变量指定自定义工作目录。
:::

### 步骤 2:创建服务器工作区并启动向导
Expand Down
12 changes: 6 additions & 6 deletions packages/cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,23 @@ SFMC 管理 CLI:REPL、服务启停、模块安装、行为包 build/deploy。
## 安装

```bash
pnpm add -g @sfmc-bds/cli
pnpm dlx @sfmc-bds/cli status
pnpm add -g @sfmc-bds/cli@0.2.2
pnpm dlx @sfmc-bds/cli@0.2.2 status
```

服主推荐:

```bash
pnpm add -g @sfmc-bds/sfmc
pnpm add -g @sfmc-bds/sfmc@0.2.2
```

仅 CLI(不含后端服务)可用 `pnpm add -g @sfmc-bds/cli`,完整平台请装聚合包。
仅 CLI(不含后端服务)可安装 `@sfmc-bds/cli`,完整平台请装聚合包。pnpm v11 起对新发布版本默认有 24 小时等待期;发布当天安装请指定精确版本。

## 依赖

- `@sfmc-bds/sdk` ^0.1.0
- `@sfmc-bds/sdk` 0.2.0
- Node.js >= 22.13

## 仓库

<https://github.com/DogeLakeDev/ScriptsForMinecraftServer/tree/main/sfmc>
<https://github.com/DogeLakeDev/ScriptsForMinecraftServer/tree/main/packages/cli>
9 changes: 4 additions & 5 deletions packages/meta/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,19 @@ SFMC 聚合包:
## 安装

```bash
pnpm add -g @sfmc-bds/sfmc@beta
pnpm add -g @sfmc-bds/sfmc@0.2.2
```

或在项目目录本地安装:

```bash
mkdir my-server && cd my-server
pnpm init
pnpm add @sfmc-bds/sfmc@beta
pnpm add @sfmc-bds/sfmc@0.2.2
pnpm exec sfmc
```

> 当前仅开放 **beta** 通道。稳定 `latest` 未开放前请始终带 `@beta`。
正式版已发布到 npm `latest`。[pnpm v11 起默认要求新版本发布满 24 小时](https://pnpm.io/settings/dependency-resolution#minimumreleaseage)才参与无版本号解析;如需在发布当天安装,请像上面一样指定精确版本。可用 `pnpm view @sfmc-bds/sfmc version` 查询当前 `latest`;试用预发布版本时才使用 `@beta`。

## 首次使用

Expand All @@ -45,7 +45,6 @@ sfmc > start -all
| `@sfmc-bds/db-server` | SQLite HTTP 后端 |
| `@sfmc-bds/qq-bridge` | QQ 互通桥接服务 |
| `@sfmc-bds/bds-tools` | BDS 更新与行为包装配 |
| `@sfmc-bds/cli` | CLI + `fetch-module`(`mod install`) |
| `@sfmc-bds/sdk` | 共享 SDK |

## 环境变量
Expand All @@ -58,4 +57,4 @@ sfmc > start -all

## 仓库

<https://github.com/DogeLakeDev/ScriptsForMinecraftServer/tree/main/sfmc-meta>
<https://github.com/DogeLakeDev/ScriptsForMinecraftServer/tree/main/packages/meta>
Loading