07fc690e67faafc2765094d613dfa0e4afad5adc
BriskGameServer
Brisk Unity SDK 原始开发工程。
这个仓库本身是 Unity 工程,用于日常开发、测试、联调和后续迭代;对外发布的 UPM package 不直接使用整个仓库,而是从子目录产出。
当前状态
当前 SDK 已完成主流程能力:
- SDK 初始化与 bootstrap
- 本地会话恢复
- 按
login_user_id登录 - 按
code登录 - 玩家信息
- 动态配置
- 公告
- 排行榜
- 云存档
- 玩家空间
- 严重错误默认 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.xxxBrisk.Auth.xxxBrisk.Leaderboard.xxx
工程结构
开发态源码与样例位于:
Assets/BriskSdk/RuntimeAssets/BriskSdk/Samples/QuickStartAssets/Scenes/BriskQuickStartScene.unity
其中:
Runtime是 SDK 活代码Samples/QuickStart是示例脚本与样例程序集BriskQuickStartScene.unity是中文 IMGUI 测试场景
服务端参考文档位于:
服务参考_临时
测试场景
直接打开:
Assets/Scenes/BriskQuickStartScene.unity
运行后会看到一个中文 IMGUI 调试面板,可直接测试:
- 初始化与重新初始化
- 按用户 ID 登录
- 按 code 登录
- 玩家信息与配置
- 公告读取与已读
- 排行榜读取、提交分数、赛季查询
- 云存档上传下载
- 玩家空间读取、点赞、更新、访客
- 全局事件日志与最近一次结果输出
当前样例已经直接使用 UploadTextAsync / DownloadTextAsync 这类快捷接口;如果业务需要,也可以继续走原始 bytes 接口。
发布结构
对外 package 发布目录位于:
PackageSource/com.foldcc.cc-framework.BriskGameServer
该目录承载:
package.jsonREADME.mdCHANGELOG.mdDocumentation~RuntimeSamples~
外部项目应通过这个子目录接入,而不是直接依赖整个 Unity 工程。
同步 package
从开发态源码同步到发布目录时,执行:
./Tools/Sync-BriskPackage.ps1
脚本会自动把以下内容同步到 package 子目录:
Assets/BriskSdk/Runtime->PackageSource/com.foldcc.cc-framework.BriskGameServer/RuntimeAssets/BriskSdk/Samples/QuickStart->PackageSource/com.foldcc.cc-framework.BriskGameServer/Samples~/QuickStartAssets/Scenes/BriskQuickStartScene.unity-> package sample 目录
发布规范
建议分支与 tag 约定如下:
- 开发分支:
feature/...、fix/... - 发包分支:
release/upm-vX.Y.Z - 发包 tag:
vX.Y.Z
推荐发布步骤:
- 在开发分支完成功能与测试
- 运行
./Tools/Sync-BriskPackage.ps1 - 检查
PackageSource/com.foldcc.cc-framework.BriskGameServer - 更新
package.json版本号与CHANGELOG.md - 创建发布分支
release/upm-vX.Y.Z - 打 tag
vX.Y.Z - 推送发布分支与 tag
外部项目 Git Package 接入示例:
http://private.lightyears.ltd:18650/foldcc/CC-Framework.BriskGameServer.git?path=/PackageSource/com.foldcc.cc-framework.BriskGameServer#v0.2.0
文档位置
仓库根目录只保留这一份总 README。
对外接入文档请看:
PackageSource/com.foldcc.cc-framework.BriskGameServer/README.mdPackageSource/com.foldcc.cc-framework.BriskGameServer/Documentation~/QuickStart.md
Description
Languages
C#
99.4%
PowerShell
0.6%