castbox
/
upm_guru_dof_lib
25
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
upm_guru_dof_lib/README.md

3.2 KiB
Raw Blame History

GURU Dof Client Library

VERSION 0.0.1

插件介绍

本插件是基于 upm_guru_kcp 库，服务与 dof 项目的客户端类封装.

当客户端或服务端更新了 prot 文件之后，需要重新生成对应的cs文件。

具体请按以下步骤进行操作：


环境部署

安装 .NET 6.0 运行时（必须使用6.0版本）

安装 protobuf-net.Protogen 命令行程序

  • 命令行安装 protobuf-net.Protogen 工具

    dotnet tool install --global protobuf-net.Protogen --version 3.2.12

  • Windows protogen 的安装目录为 C:\Users\用户名\.dotnet\tools ，可直接在 cmd 命令行下运行 protogen

  • Macos 在 Macos 下 protogen 的安装目录为 /Users/用户名/.dotnet/tools，可能需要手动将

    PATH=PATH:/Users/用户名/.dotnet/tools

    加入到 ~/.bash_profile 中，因为 homebrew 加入的 PATH ~/.dotnet/tools 无效


文件构建

生成 cs 文件

  • Windows

    cd upm_guru_dof_lib\Runtime\ServerProto
protogen messages.proto --csharp_out=..\NetworkGen

  • MacOS

    cd upm_guru_dof_lib/Runtime/ServerProto
~/.dotnet/tools/protogen messages.proto --csharp_out=../NetworkGen

UPM 安装和接入

插件引入

  • 本插件需要使用公司内部的Gitlab加载对应的repo, 详见 Castbox内部git服务器Gitea使用指南
  • 根据文档部署好本机配置后, 请在Unity内部配置如下参数
    • 修改位于项目 Packages/manifest.json 文件，在dependencies中添加 
      {
  "dependencies": {
    "com.guru.unity.gurudoflib": "git@git.chengdu.pundit.company:castbox/upm_guru_dof_lib.git",
    ...
  }
}
    • 修改link.xml文件，添加 
      <assembly fullname="GuruDofLib.Runtime" preserve="all"/>

UPM 发布

在项目研发中, 根据业务需求, 将会需要更改接口的逻辑及结构. 并更新此库. 需要项目组自行维护和发布 dof_lib 的版本.

插件更新流程如下:

  1. 研发流中正常修改 proto 接口和对应的业务逻辑, 并提交推送至 main 分支
  2. 手动修改 ./Makefile 中的 Version 字段并提交. (该字段为插件的版本号, 请遵循三位版本号规范, 如: 1.0.0)
  3. 在此路径中, 执行命令行, 项目会自动提交并打入Tag标签 
    make publish
  4. 在游戏主项目中, 修改 Packages/manifest.json 文件, 将 com.guru.unity.gurudoflib 的版本号改为刚刚发布的版本号, 并等待编译结束. (没有的需要再repo地址后添加 #x.x.x 作为版本标记) 
    {
  "dependencies": {
    "com.guru.unity.gurudoflib": "git@git.chengdu.pundit.company:castbox/upm_guru_dof_lib.git#0.0.1",
    ...
  }
}