[MD]
[](https://github.com/SerenityJS/serenity)
[](https://discord.gg/jUcC3q59zg)
[](https://github.com/SerenityJS/serenity/blob/develop/LICENSE)
[](https://www.npmjs.com/package/@serenityjs/core)
[](https://github.com/Mojang/bedrock-protocol-docs)
---
来源:[Github Serenity](https://github.com/SerenityJS/serenity/blob/main/README.md)
**TRANSLATE BY GongSunFangYun**
## 关于项目
Serenity 是一款基于 Rust 和 TypeScript 构建的 Minecraft 基岩版服务器软件,提供完整的 API 和工具集,让开发者能够专注于创造独特的游戏体验,无需处理底层网络和协议细节。
项目目前处于积极开发阶段,即将发布第一个稳定版本。
### 插件系统
Serenity 提供强大的插件系统,支持使用 TypeScript 或 JavaScript 扩展服务器功能。插件可以访问与核心相同的 API,便于开发者创建个性化游戏内容。
我们维护着公共插件仓库,方便社区分享和发现插件:
- 插件仓库:https://plugins.serenityjs.net
- 示例插件:https://github.com/SerenityJS/sample-plugin
## 快速开始
### 环境要求
- Node.js 最新推荐版本
- 推荐使用 Visual Studio Code 作为开发环境
### 安装方式
**预编译版本**:
- 稳定版:从 [发布页面](https://github.com/SerenityJS/serenity/releases) 下载
- 测试版:从 [GitHub Actions](https://github.com/SerenityJS/serenity/actions/workflows/release.yml) 下载(需要 GitHub 账户)
**CLI 安装**:
```bash
# 选择以下任一命令
npm create serenity
yarn create serenity
pnpm create serenity
```
#### 常见问题
**问题**:服务器正常运行,但在 Minecraft 服务器列表中无法看到或加入服务器
**解决方案**:需要将 Minecraft 客户端添加到 UWP 环回豁免列表
- 仅适用于 Windows 系统
- 以管理员身份运行命令提示符
- 执行相应的命令
- 完成后会收到确认通知
### 本地安装 Serenity
本地安装 Serenity 允许开发者修改应用程序核心代码。
**准备工作**:
1. 克隆或下载 Serenity 仓库到本地
2. 在 IDE 中打开项目文件夹
3. 安装 [Yarn](https://yarnpkg.com/)(参考[官方安装指南](https://yarnpkg.com/getting-started/install))
Serenity 基于 [Yarn Workspaces](https://yarnpkg.com/features/workspaces) 构建,支持快速开发。
#### 本地设置
- 首先,您需要使用 Yarn 初始化文件夹。复制并运行命令“yarn install”,按照屏幕上可能出现的任何步骤进行操作。
- 接下来,您现在可以构建项目了,因为项目是用 TypeScript 编码的,所以在运行之前首先需要将其编译为 JavaScript。为此,请运行命令“yarn build”,该命令会将项目编译为 JavaScript。
- 最后,您可以启动 Serenity 服务器了。首先,您需要通过“cd devapp”将终端指向 devapp 目录。接下来运行命令“yarn dev”,您应该会在控制台中看到服务器启动。
[/MD]
最后编辑:

