Mod工坊 API 示意

Data结构

public class WorkShopModMeta
{
    public string UUID; //唯一ID 全局不重复
    public int Type; //区分Mod类型 1:地图 2:脚本 3:模型...etc
    public string UserID // KeyForGet AvartaImg,Name?
    public string Title;
    public string Desc;
    public string CDN_FileKey_RawMod; //相应文件的Key. URL地址最终前端拼接.方便更换CDN
    public string CDN_FileKey_PreviewImg;
    public int Version; //Increass by server side
    public int ReviewStatus; // 0 NotStart(Default)  1 During 2 Reject 3 Approve
    public string RejectMsg; //审核不通过的理由
    public string SecretKey; //加密Key !! 抓Rank时候不能带回来
    public string Custom; //游戏内特定逻辑.比如标记当前地图适用的人数(单人,1-4人联机等) 用JSON?
}
public class WorkShopModExtData
{
    public string UUID; //Mod的唯一ID 表关联
    public int LikeNum;
    public int DownloadNum;
    public int HotScore;
    public Date LastUpdateTime; //最后一次更新时间
    //All Custom Data Increase By API Call, Game Specific
    public int[] Custom;
}

API

通用

发送文件到CDN

//Data Type区分文件类型是不是图片,CDN对图片有压缩
void Common_UploadFileToCDN(byte[] _data,int _dataType); 

Group请求Mod+Ext信息

void Common_BatchGetModInfo(string[] _modUUIDList);
void Result(List<WorkShopModMeta> _modMetaList,List<WorkShopModExtData> _modExtDataList);

Mod制作者

请求某个用户所有已发布的Mod信息

void Mod_GetAllUUIDList(string _userID);
void Result(string[] _allModUUIDList);

创建/更新 Mod

先通过 API上传文件到CDN?

//Data Type区分文件类型是不是图片,CDN对图片有压缩
void Common_UploadFileToCDN(byte[] _data,int _dataType); 

再发送给后端

void Mod_Create(string _userID,int _modType,string _title,
                string _desc,string _modFileKey,string _preivewImgKey,
                string _custom,string _secretKey);
void Mod_Update(string _userID,string _modUUID,string _title=null,
                string _desc=null,string _modFileKey=null,string _previewImgKey=null,
                string _custom=null,string _secretKey=null);

删除Mod

void Mod_Delete(string _userID, string _modUUID);

普通用户

取得RankList

void User_GetRankList(int _rankType);
return Result(string[] _allModUUIDList);

取得User社交信息

• 游戏进去时候请求一次,游戏期间客户端自行更新本地数据

public class UserModSocialInfo()
{
    public string[] likedModList; //所有喜欢过的Mod UUID
    ... //后续有扩展再添加
}
void User_GetSocialInfo(string _userID);
return Result(UserModSocialInfo _result);

对Mod点赞

void User_LikeMod(string _userID ,string _modUUID);

通知下载了某个Mod

void User_DownloadMod(string _userID, string _modUUID);

自定义

• 游戏内独有逻辑,游戏之间不通用
• 比如我们就用来统计 挑战开始人数,挑战完成人数 从而给Mod作者预估出地图通关完成率

void User_IncreaseCustomValue(string _userID,string _modUUID,
                             int _customValueIndex,int _increaseValue);

上线后的 审查 & 删除

• 前端提供一个举报按钮
  
  • 玩家点击后走 User_IncreaseCustomValue 接口. 定义一个ID作为 举报统计
• 后端有个列表 可以按这个ID进行排序
• 从后台复制地图UUID后,在游戏内的工坊入口 输入相应的UUID 查找到相应Mod

• 进去Play以后如果确定有问题,在后台进行下架处理

• Logic需要UUID对用户友好, 用ShotUUID ?

• 或者该Logic直接作为Regular Logic,用单独的Key+Api实现

加密问题

原理

• 在地图Mod(不是所有类型的Mod)上传时候附加一个SecretKey字段, 客户端会用该字段对Mod内的地图文件进行加密
• 在进入游戏当前地图前会发送请求

void Custom_GetModSecretKey(string _userID, string _modUUID);
return Result(string _key)

性能

• 所有免费玩家可以玩儿的地图都是不加密的 这部分是大头.
• 付费用户请求过一次后会吧Key记到内存中,当次游戏不Kill进程 同一张地图不会再次请求

多端登录问题

• 好游账号是否有多端登录检测?
• 如果没有我之前的做法是 在Login接口内,登录成功后 DB中会记录一个RandomKey,同时把这个Key传给客户端
• 客户端每次查询SecretKey时候需要带上这个RandomKey. 后端要做Key值比较

void Custom_GetModSecretKey(string _userID,string _loginKey, string _modUUID);
return Result(string _key)

• 如果Key不相同 返回一个ErrorID. 前端会提示多端登录,会重新进行Login流程.从而重新产生一个RandomKey
• 这种多端登录请求计入Log. 如果一个账号一段时间内大量出现 则表示这个账号被在社交平台共享了. 直接封掉.