Mirage.Godot

海市蜃樓戈多

基於流行的開源 Unity 網路解決方案 Mirror 和 Mirage 的 Godot 高級 C# 網絡

範例專案的影片示範：https://youtu.be/Ty55PZWtsJI

特徵

• 多種傳輸支援。使用內建 UDP 傳輸或新增您自己的傳輸以與其他服務搭配使用
• 透過屬性進行 RPC 調用
• SyncVar 無需任何額外程式碼即可同步字段
• 自動序列化
• 在網路之外產生對象
• 物件所有權。允許客戶端控制物件並自動將變更同步到其他客戶端

文件

Mirage 統一版本的文件可以在 https://miragenet.github.io/Mirage/ 找到。大多數相同的概念將適用於 Godot 版本。

安裝

1. 克隆儲存庫git clone [email protected]:James-Frowen/Mirage.Godot.git
2. 將src/Mirage.Godot/Scripts複製到您的 godot 專案中
   • 確保在 godot 中建立 c# 解決方案，本頁介紹了在 godot 中使用 c# 的基礎知識
3. 在專案的主.csproj中加入以下內容的參考：
   • Mirage.Logging.csproj
   • Mirage.SocketLayer.csproj
4. 建置 CodeGen： dotnet build Mirage.CodeGen.csproj -c Release
   • 使用[-o|--output <OUTPUT_DIRECTORY>]使路徑更容易找到
5. 將建置目標新增至您的主 csproj

< Project Sdk = " Godot.NET.Sdk/4.1.1 " >
  ...

  < Target Name = " PostBuild " AfterTargets = " PostBuildEvent " >
    < Exec Command = " path/to/Mirage.CodeGen.exe $(TargetPath) -force " />
    < Error Condition = " $(ExitCode) == 1 " />
  </ Target >
  < Target Name = " PrePublish " BeforeTargets = " Publish " >
    < Exec Command = " path/to/Mirage.CodeGen.exe $(PublishDir)$(TargetFileName) $(TargetDir) -force " />
    < Error Condition = " $(ExitCode) == 1 " />
  </ Target >
</ Project >

筆記

Mirage.CodeGen.csproj目前使用對Mirage.Godot.csproj的參考來尋找 Mirage 類型，但在執行時間將使用目標 csproj 內的類型。

設定命令

執行上述步驟的命令（將path/to/project替換為您的專案）

git clone [email protected]:James-Frowen/Mirage.Godot.git
cd Mirage.Godot
cp src/Mirage.Godot/Scripts " path/to/project/Mirage.Godot "
dotnet build src/Mirage.Core/Mirage.CodeGen/Mirage.CodeGen.csproj -o ./CodeGen

然後手動新增PostBuild目標以及CodeGen/CodeGen.exe的路徑

注意：您可能希望在建置時排除src/Mirage.Godot/Scripts/Example1資料夾，否則它將最終出現在 Mirage.Godot dll 中

程式碼生成

Mirage.Godot 使用 Mono.Cecil 在編譯後修改 C# 原始碼，這使得功能具有高效能且易於使用。

若要安裝程序，請將此程式碼新增至 godot 專案的預設 csproj 中

< Target Name = " PostBuild " AfterTargets = " PostBuildEvent " >
  < Exec Command = " path/to/Mirage.CodeGen.exe $(TargetPath) -force " />
  < Error Condition = " $(ExitCode) == 1 " />
</ Target >
< Target Name = " PrePublish " BeforeTargets = " Publish " >
  < Exec Command = " path/to/Mirage.CodeGen.exe $(PublishDir)$(TargetFileName) $(TargetDir) -force " />
  < Error Condition = " $(ExitCode) == 1 " />
</ Target >

並將Path/To/Mirage.CodeGen.exe路徑修改為建置Mirage.CodeGen.exe檔案的位置。

請注意，兩個目標都是必要的：

• TargetPath在編輯器中效果最佳，可確保在運行之前套用程式碼產生更改
• 需要PublishDir ，因為TargetPath不是導出建置時複製的路徑

發展

此範例使用符號連結將 Mirage.Godot 腳本包含在第二個項目中。

若要使用這些符號連結複製此儲存庫，請以管理員身分執行：

git clone -c core.symlinks=true [email protected]:James-Frowen/Mirage.Godot.git

如果沒有符號連結下載（例如從 zip 檔案），則您需要手動將檔案從src/Mirage.Godot/Scripts複製（而不是移動）到src/Mirage.Godot.Example1/Mirage.Godot

程式碼產生器

在本機開發程式碼產生時，您可能需要將此步驟新增至 PostBuild 目標的開頭，以便在執行之前重建程式碼產生專案

    < Exec Command = " dotnet build $(ProjectDir)/../Mirage.Core/Mirage.CodeGen/Mirage.CodeGen.csproj -c Release " />