upm_guru_dof_lib/README.md

64 lines
2.0 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

# GURU Dof kcp Client
### VERSION 0.0.1
## 插件介绍
基于upm_guru_kcp库服务与dof项目的客户端类封装.
在更新了prot文件之后需要重新生成对应的cs文件。请按以下步骤进行操作
## 安装 .NET 6.0 运行时必须使用6.0版本)
* 下载离线安装包
- Mac: https://dotnet.microsoft.com/zh-cn/download/dotnet/thank-you/sdk-6.0.413-macos-x64-installer
- Windows: https://dotnet.microsoft.com/zh-cn/download/dotnet/thank-you/sdk-6.0.413-windows-x64-installer
* Mac下建议使用 homebrew
brew tap isen-ng/dotnet-sdk-versions
brew install --cask dotnet-sdk6-0-400
## 安装 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
```
## 安装和接入
### 插件引入
- 本插件需要使用公司内部的Gitlab加载对应的repo, 详见 [Castbox内部git服务器Gitea使用指南](https://docs.google.com/document/d/1DiGPDD5Teu2QcYaBhqAcsqMbb3DJ5sdnTQMuvVzJSUk/edit#heading=h.w9tkkzwwyjxf)
- 根据文档部署好本机配置后, 请在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"/>
```