You've already forked CC-Framework.BriskGameServer
Release v0.2.0 archive and space API update
This commit is contained in:
30
README.md
30
README.md
@@ -20,6 +20,28 @@ Brisk Unity SDK 原始开发工程。
|
||||
- 玩家空间
|
||||
- 严重错误默认 IMGUI 提示
|
||||
|
||||
内容型接口当前默认推荐用法:
|
||||
|
||||
- 云存档:
|
||||
- `Brisk.Archive.UploadAsync(slotNo, bytes)` 直接传二进制
|
||||
- `Brisk.Archive.UploadTextAsync(slotNo, text)` 直接传文本
|
||||
- `Brisk.Archive.UploadJsonAsync(slotNo, payload)` 直接传对象
|
||||
- `Brisk.Archive.DownloadAsync(slotNo)` 获取原始 bytes + 元信息
|
||||
- `Brisk.Archive.DownloadTextAsync(slotNo)` 直接取文本
|
||||
- `Brisk.Archive.DownloadJsonAsync(slotNo)` 直接取 JSON 对象
|
||||
- 玩家空间:
|
||||
- `Brisk.Space.UpdateMyAsync(string)` 可直接更新文本内容
|
||||
- `Brisk.Space.UpdateMyAsync(byte[])` 可直接更新二进制内容
|
||||
- `Brisk.Space.UpdateMyAsync(object)` 会自动转成 JSON 上传
|
||||
- `Brisk.Space.DownloadContentByPlayerIdAsync(playerId)` 获取原始 bytes
|
||||
|
||||
云存档上传补充约定:
|
||||
|
||||
- SDK 默认会自动计算上传文件的 `checksum`
|
||||
- 当前服务端要求的是纯 SHA256 十六进制字符串
|
||||
- 不应传 `sha256:xxxx` 这类带算法前缀的值
|
||||
- 如果手动传入 `checksum`,SDK 也会自动去掉 `sha256:` 前缀再发送
|
||||
|
||||
静态入口保持为:
|
||||
|
||||
- `Brisk.xxx`
|
||||
@@ -62,6 +84,8 @@ Brisk Unity SDK 原始开发工程。
|
||||
- 玩家空间读取、点赞、更新、访客
|
||||
- 全局事件日志与最近一次结果输出
|
||||
|
||||
当前样例已经直接使用 `UploadTextAsync` / `DownloadTextAsync` 这类快捷接口;如果业务需要,也可以继续走原始 bytes 接口。
|
||||
|
||||
## 发布结构
|
||||
|
||||
对外 package 发布目录位于:
|
||||
@@ -99,7 +123,7 @@ Brisk Unity SDK 原始开发工程。
|
||||
|
||||
- 开发分支:`feature/...`、`fix/...`
|
||||
- 发包分支:`release/upm-vX.Y.Z`
|
||||
- 发包 tag:`upm/vX.Y.Z`
|
||||
- 发包 tag:`vX.Y.Z`
|
||||
|
||||
推荐发布步骤:
|
||||
|
||||
@@ -108,13 +132,13 @@ Brisk Unity SDK 原始开发工程。
|
||||
3. 检查 `PackageSource/com.foldcc.cc-framework.BriskGameServer`
|
||||
4. 更新 `package.json` 版本号与 `CHANGELOG.md`
|
||||
5. 创建发布分支 `release/upm-vX.Y.Z`
|
||||
6. 打 tag `upm/vX.Y.Z`
|
||||
6. 打 tag `vX.Y.Z`
|
||||
7. 推送发布分支与 tag
|
||||
|
||||
外部项目 Git Package 接入示例:
|
||||
|
||||
```text
|
||||
http://private.lightyears.ltd:18650/foldcc/CC-Framework.BriskGameServer.git?path=/PackageSource/com.foldcc.cc-framework.BriskGameServer#upm/v0.1.0
|
||||
http://private.lightyears.ltd:18650/foldcc/CC-Framework.BriskGameServer.git?path=/PackageSource/com.foldcc.cc-framework.BriskGameServer#v0.2.0
|
||||
```
|
||||
|
||||
## 文档位置
|
||||
|
||||
Reference in New Issue
Block a user