Mirage.Godot

Mirage.Godot

Jaringan c# tingkat tinggi untuk Godot berdasarkan solusi jaringan Unity open source populer Mirror dan Mirage

Demo Video contoh proyek: https://youtu.be/Ty55PZWtsJI

Fitur

• Dukungan Transportasi Berganda. Gunakan transportasi UDP bawaan atau tambahkan transportasi Anda sendiri untuk bekerja dengan layanan lain
• Panggilan RPC melalui atribut
• SyncVar untuk menyinkronkan bidang tanpa kode tambahan apa pun
• Serialisasi otomatis
• Memunculkan Objek lain di jaringan
• Kepemilikan objek. Memungkinkan klien memiliki kendali atas objek dan secara otomatis menyinkronkan perubahan ke klien lain

dokumen

Dokumentasi untuk Mirage versi unity dapat ditemukan di https://miragenet.github.io/Mirage/. Sebagian besar konsep yang sama akan diterapkan pada versi Godot.

Memasang

1. Repo klon git clone [email protected]:James-Frowen/Mirage.Godot.git
2. Salin src/Mirage.Godot/Scripts ke proyek godot Anda
   • Pastikan untuk membuat solusi c# di godot, halaman ini membahas dasar-dasar penggunaan c# di dalam godot
3. Di .csproj utama proyek Anda, tambahkan referensi ke:
   • Mirage.Logging.csproj
   • Mirage.SocketLayer.csproj
4. Bangun CodeGen: dotnet build Mirage.CodeGen.csproj -c Release
   • gunakan [-o|--output <OUTPUT_DIRECTORY>] untuk membuat jalur lebih mudah ditemukan
5. Tambahkan Target Pembangunan ke csproj utama Anda

< 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 >

Catatan

Mirage.CodeGen.csproj saat ini menggunakan referensi ke Mirage.Godot.csproj untuk menemukan tipe Mirage, tetapi saat dijalankan akan menggunakan tipe di dalam csproj target.

Perintah pengaturan

Perintah untuk menjalankan langkah-langkah di atas (ganti path/to/project dengan proyek Anda)

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

lalu tambahkan target PostBuild secara manual dengan jalur ke CodeGen/CodeGen.exe

catatan: Anda mungkin ingin mengecualikan folder src/Mirage.Godot/Scripts/Example1 saat membuat atau folder tersebut akan berakhir di Mirage.Godot dll

Pembuatan Kode

Mirage.Godot menggunakan Mono.Cecil untuk memodifikasi kode sumber c# setelah dikompilasi, hal ini memungkinkan fitur memiliki kinerja tinggi dan mudah digunakan.

Untuk Menyiapkan, tambahkan kode ini ke csproj default untuk proyek godot

< 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 >

dan ubah jalur Path/To/Mirage.CodeGen.exe ke tempat Anda membuat file Mirage.CodeGen.exe .

Catatan, kedua target tersebut diperlukan:

• TargetPath berfungsi paling baik di editor untuk memastikan perubahan gen kode diterapkan sebelum dijalankan
• PublishDir diperlukan karena TargetPath bukan jalur yang disalin saat mengekspor build

Perkembangan

Contohnya menggunakan symlink untuk memasukkan skrip Mirage.Godot di proyek ke-2.

Untuk mengkloning repo ini dengan symlink tersebut, jalankan sebagai administrator:

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

Jika mengunduh tanpa symlink (seperti dari file zip) maka Anda perlu menyalin secara manual (bukan memindahkan) file dari src/Mirage.Godot/Scripts ke src/Mirage.Godot.Example1/Mirage.Godot

kodegen

ketika mengembangkan gen kode secara lokal Anda mungkin ingin menambahkan langkah ini ke awal target PostBuild sehingga akan membangun kembali proyek codegen sebelum menjalankannya

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