91 lines
5.0 KiB
Markdown
91 lines
5.0 KiB
Markdown
# BD2 本地服务器
|
||
|
||
用于本地开发、协议研究和服务端实现练习。
|
||
|
||
首先安装 Brown Dust II 客户端。
|
||
|
||
## 开发构建
|
||
|
||
开发时在两个终端中分别运行：
|
||
|
||
```powershell
|
||
.\bd2w runServer
|
||
```
|
||
|
||
```powershell
|
||
.\bd2w runClient
|
||
```
|
||
|
||
客户端窗口在插件准备完成后打开。首次生成完整游戏源码或者在 SDK / 游戏更新后可能等待数分钟，后续启动复用共享缓存。
|
||
|
||
将 `go/config.example.json` 复制为 `go/config.json`，将 `game_directory` 改为本机 Brown Dust II 安装目录。仍可在 `run` 后使用 `--game-dir` 临时覆盖。
|
||
|
||
发布脚本统一使用 `-tags release` 编译。
|
||
|
||
## 发布包
|
||
|
||
```powershell
|
||
.\bd2w build
|
||
.\bd2w build -GameDir 'D:\Brown Dust II' -SkipTests
|
||
.\bd2w build -SchedulesOnly
|
||
```
|
||
|
||
默认执行测试与静态检查；`-SkipTests` 跳过这些检查；`-SchedulesOnly` 只导出活动日历编排信息。
|
||
|
||
## 其他命令
|
||
|
||
在仓库根目录运行：
|
||
|
||
```powershell
|
||
.\bd2w check-csharp
|
||
.\bd2w check-csharp LoginUI GameNames
|
||
.\bd2w sdk pack --game-dir '<客户端目录>'
|
||
.\bd2w sdk verify --game-dir '<客户端目录>'
|
||
.\bd2w sdk update-names --game-dir '<客户端目录>' --game-mapping '<映射文件>'
|
||
```
|
||
|
||
## 客户端插件项目
|
||
|
||
- `plugins/LocalIdentity/`：本地服务端客户端专用插件。
|
||
- `plugins/LoginUI/`：本地服 Discord/Google 登录界面插件。
|
||
- `plugins/CashShop`: 内购商品处理。
|
||
- `plugins/CaptureEnvironment/`：独立原版对照客户端的抓包插件，不要装进本地服务端客户端。
|
||
- `plugins/GameNames`/`plugins/GameSdk`: 插件开发工具链，让开发过程中使用反混淆名改善开发体验，只有 `GameNames` 需要随同安装。
|
||
|
||
## 可视化客户端工具
|
||
|
||
BD2 Client Studio 是使用 Wails 的独立桌面客户端设置工具。Windows 使用系统 WebView2 Runtime，macOS 使用系统 WKWebView。它提供以下操作：
|
||
|
||
- 选择并验证 Brown Dust II 安装目录。
|
||
- 填写服务器 origin 和端口，自动写入游戏目录下的 `BepInEx/config/bd2.client.json`。
|
||
- 应用带原文件备份的客户端入口补丁。
|
||
- 检查 BepInEx 后安装或更新 `BD2LocalIdentity.dll`、`BD2LoginUI.dll`、`BD2CashShop.dll` 及其共享运行时 `BD2.GameNames.dll`。
|
||
- 选择官方 CDN、服务器资源源或本地已下载资源。
|
||
|
||
服主同步官方资源、自建静态 CDN 或配置缓存反代的步骤见 [资源与 CDN 配置指南](RESOURCES.md)。
|
||
|
||
## 首次安装
|
||
|
||
### 启动服务端
|
||
|
||
双击 `bd2server.exe` 启动，单人本地服默认监听 `8080` 端口，可通过 `.\bd2server.exe serve --listen 127.0.0.1:xxxx` 修改监听端口。
|
||
|
||
服主部署、创建 OAuth 应用、取得 client ID/secret、配置回调地址等完整步骤见 [服主配置指南](AUTHENTICATION.md)。
|
||
|
||
`authentication.json`、`resources.json` 和 `game.json` 不随发布包分发，首次运行时在服务端可执行文件旁生成默认文件，已有文件不会覆盖。开发入口使用 `.build/config/` 中的三个配置。游戏规则修改后重启生效，详细见 [服务端游戏规则配置](GAME_CONFIGURATION.md)。
|
||
|
||
服务端日志默认输出 INFO 及以上级别，仅终端启用颜色：TRACE 灰、DEBUG 青、INFO 绿、WARN 黄、ERROR 红。可用 `serve --log-level debug --log-color auto` 调整，或设置 `BD2_LOG_LEVEL` 和 `BD2_LOG_COLOR` 环境变量，显式命令行参数优先。级别支持 `trace/debug/info/warn/error`，颜色支持 `auto/always/never`。`auto` 下文件和重定向保持纯文本，`NO_COLOR` 或 `TERM=dumb` 也会关闭颜色；如需在 Docker 日志流中显示颜色，可显式选择 `always`。
|
||
|
||
### 启动客户端
|
||
|
||
先手动安装 [BepInEx](https://github.com/BepInEx/BepInEx/releases)。然后打开我们的客户端工具 `bd2client.exe`。
|
||
|
||
进入客户端工具后首先要求你选择游戏根目录，也就是有 `BrownDust II.exe` 文件的目录，然后要填写服务端 url，如果是单人本地服则填写 `127.0.0.1:<服务端实际监听的端口>`，默认为 `8080`。如果为联机服则需要填写服主要求的 url。
|
||
|
||
|
||
## 许可与免责声明
|
||
|
||
本项目原创内容由 Flechazo 保留全部权利，具体条款见 [LICENSE](LICENSE)。通过项目权利人指定渠道合法取得副本的人，仅可用于个人学习、研究和本地非商业测试；未经项目权利人事先明确书面许可，禁止向第三方转发、镜像、上传、二次分发项目源码或构建产物，禁止售卖、收费提供、商业化运营或对公众开放基于本项目的服务。公开可见不代表允许转载或再分发。
|
||
|
||
本项目是非官方开发与研究项目，与 Brown Dust II 及其权利人无隶属或授权关系。游戏名称、商标、客户端、游戏资源和数据归各自权利人所有；本项目的许可不覆盖它们，也不变更第三方依赖的许可证。项目按现状提供，无正确性、安全性、可用性或不侵权保证。使用者须自行确认适用法律、相关协议和第三方权利要求，并自行承担使用、客户端修改及本地服务运行风险。
|