# FoldCC Brisk Game Server SDK

Brisk Unity SDK 的 UPM 发布目录。

当前仓库地址：

- `http://private.lightyears.ltd:18650/foldcc/CC-Framework.BriskGameServer`

当前包名：

- `com.foldcc.cc-framework.brisk-game-server`

## 如何引入到项目

推荐通过 Unity Package Manager 的 Git URL 方式引入。

### 方式一：Package Manager

1. 打开 `Window > Package Manager`
2. 点击左上角 `+`
3. 选择 `Add package from git URL...`
4. 输入：

```text
http://private.lightyears.ltd:18650/foldcc/CC-Framework.BriskGameServer.git?path=/PackageSource/com.foldcc.cc-framework.brisk-game-server#v0.4.1
```

### 方式二：修改 `Packages/manifest.json`

```json
{
  "dependencies": {
    "com.foldcc.cc-framework.brisk-game-server": "http://private.lightyears.ltd:18650/foldcc/CC-Framework.BriskGameServer.git?path=/PackageSource/com.foldcc.cc-framework.brisk-game-server#v0.4.1"
  }
}
```

如果需要跟随主分支最新代码，可将末尾的 `#v0.4.1` 改成 `#main`；正式环境建议固定到发布 tag。

## 开发态源码位置

开发工程中的活代码位于：

- `Assets/BriskSdk/Runtime`
- `Assets/BriskSdk/Samples/QuickStart`
- `Assets/Scenes/BriskQuickStartScene.unity`

同步 package 内容时执行：

```powershell
./Tools/Sync-BriskPackage.ps1
```

## 已包含模块

- Bootstrap 与初始化
- Auth 与会话恢复
- 玩家信息
- 动态配置
- 公告
- 排行榜
- 云存档上传下载
- 玩家空间
- 默认阻断式错误 UI

## Archive checksum

云存档上传时，SDK 默认自动处理 checksum。

- `UploadAsync(slotNo, bytes)` 用于二进制
- `UploadTextAsync(slotNo, text)` 用于 UTF-8 文本
- `UploadJsonAsync(slotNo, payload)` 用于 JSON 对象
- `DownloadAsync(slotNo)` 返回原始 bytes 和元信息
- `DownloadTextAsync(slotNo)` 返回 UTF-8 文本
- `DownloadJsonAsync(slotNo)` 返回 JSON 结果
- SDK 会自动计算 SHA256
- 当前 Brisk archive API 要求纯小写 SHA256 十六进制字符串
- 不要传 `sha256:` 前缀
- 若手动传入带前缀的 checksum，SDK 会自动归一化

## Space content

玩家空间当前采用 metadata + binary content 模型。

- `GetByPlayerIdAsync(...)` 和 `GetByLoginIdentityAsync(...)` 返回元数据
- `DownloadContentByPlayerIdAsync(...)` 和 `DownloadContentByLoginIdentityAsync(...)` 返回原始 bytes
- `UpdateMyAsync(string)` 直接上传文本
- `UpdateMyAsync(byte[])` 直接上传二进制
- `UpdateMyAsync(object)` 自动序列化为 JSON
- `LikeByPlayerIdAsync(...)` / `UnlikeByPlayerIdAsync(...)` 返回累计点赞数、今日点赞数、当前周期是否创建新点赞、重置时间
- `GetLikesByPlayerIdAsync(playerId, limit, true)` 和 `GetLikesByLoginIdentityAsync(..., true)` 可只读取当前周期点赞记录
- `GetMyVisitsAsync()` 默认读取最近 `50` 条访问记录，也可手动传入 `limit`

## 目录结构

- `Runtime`
- `Samples~`
- `Documentation~`

## 快速开始

查看：

- `Documentation~/QuickStart.md`
- `Samples~/QuickStart`