Mirage.Godot

Мираж.Годо

Высокоуровневая сеть C# для Godot на основе популярных сетевых решений Unity с открытым исходным кодом Mirror и Mirage.

Видео-демо примера проекта: https://youtu.be/Ty55PZWtsJI

Функции

• Поддержка нескольких транспортных средств. Используйте встроенный транспорт UDP или добавьте свой собственный для работы с другими сервисами.
• Вызовы RPC через атрибуты
• SyncVar для синхронизации полей без дополнительного кода
• Автоматическая сериализация
• Спавнить объекты в другой сети
• Владение объектом. Позволяет клиенту контролировать объект и автоматически синхронизировать изменения с другими клиентами.

Документы

Документацию для Unity-версии Mirage можно найти по адресу https://miragenet.github.io/Mirage/. Большинство тех же концепций применимо и к версии Годо.

Установить

1. Репозиторий клонов git clone [email protected]:James-Frowen/Mirage.Godot.git
2. Скопируйте src/Mirage.Godot/Scripts в свой проект Godot.
   • Обязательно создайте решение C# в Godot, на этой странице рассматриваются основы использования C# внутри Godot.
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 при сборке, иначе она окажется в dll Mirage.Godot.

Генерация кода

Mirage.Godot использует Mono.Cecil для изменения исходного кода C# после его компиляции, что обеспечивает высокую производительность и простоту использования функций.

Для установки добавьте этот код в csproj по умолчанию для проекта 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 >

и измените путь 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 " />