Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
thejinchao committed May 9, 2023
1 parent 1eed352 commit 5f5fe8f
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@ If you do not have a golang runtime environment, you can connect the client to t
## Geting started

### 1. Installing the plugin
1. Clone this git repository.
2. Create a `Plugins/TurboLink` folder under your project folder, then copy this repo into it.
3. Download pre-built thirdparty binaries libraries from [here](https://github.com/thejinchao/turbolink-libraries/releases), and extract it to `Plugin/TurboLink/Source/ThirdParty`.
1. Download a release version from [here](https://github.com/thejinchao/turbolink/releases).
2. You can also clone this repo locally through git, but you also need to download pre-built third party binaries libraries from [here](https://github.com/thejinchao/turbolink-libraries/releases), and extract it to `Source/ThirdParty`.
3. Create a `Plugins/TurboLink` folder under your project folder, then copy this repo into it.

### 2. Config service endpoint
Open the project setting window (TurboLink Grpc/Services Config) to set the server endpoint to different gRPC services.
Expand Down Expand Up @@ -72,7 +72,7 @@ In the proto file above, Use the following steps to generate code files:
2. Copy generated directories `Private` and `Public` from `output_path` to `YourProject/Plugins/TurboLink/Source/TurboLinkGrpc`
3. Re-generate your project solution and build it.

This batch file generates code through a protoc plugin named `protoc-gen-turbolink`, the code of this plugin can be found [here](https://github.com/thejinchao/protoc-gen-turbolink). Do not put the project in the path containing spaces to avoid errors in execution.
This batch file generates code through a protoc plugin named `protoc-gen-turbolink`, the code of this plugin can be found [here](https://github.com/thejinchao/protoc-gen-turbolink). Do not put the project in the path containing spaces to avoid errors in execution.
If your project contains multiple proto files, and there are dependencies between files, then you should have a root directory to save these files, and then use this directory as the current working path to run `generate_code.cmd`

### 2. Connect to gRPC service
Expand Down
6 changes: 3 additions & 3 deletions README_chs.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@ TurboLink 是一个Unreal Engine插件, 能够在[Unreal Engine](https://www.unr
## 入门

### 1. 安装插件
1. 下载本git工程代码
2. 在你的UE工程中创建`Plugin/TurboLink`这个目录,然后把这个插件代码拷贝到里面
3. 下载插件所需要的第三方代码库,可以从[这里](https://github.com/thejinchao/turbolink-libraries/releases) 下载一份已经编译好的库文件,然后解压到`Plugin/TurboLink/Source/ThirdParty`目录里
1. [这里](https://github.com/thejinchao/turbolink/releases) 下载一份插件的release版本
2. 你也可以用git从这个仓库克隆一份代码到本地,但需要从[这里](https://github.com/thejinchao/turbolink-libraries/releases) 下载一份已经编译好的第三方代码库,然后解压到`Source/ThirdParty`目录里
3. 在UE工程中创建`Plugin/TurboLink`这个目录,然后把这个插件代码拷贝到里面

### 2. 配置服务器地址
打开编辑器的工程设置界面(TurboLink Grpc/Services Config),在这里可以设置不同的gRPC服务器地址
Expand Down

0 comments on commit 5f5fe8f

Please sign in to comment.