Godot Template

Гайд по созданию и настройке нового проекта в Godot.

Предварительная настройка Godot

1. Чтобы в Godot настроить интеграцию с Rider, необходимо зайти в Editor -> Editor Settings -> Dotnet -> Editor. В списке External Editor выбрать JetBrains Rider и очистить значение Custom Exec Path Args.
2. [Опционально] Чтобы иметь возможность при экспорте изменять свойства exe файла, необходимо указать путь до rcedit в Editor -> Editor Settings -> Export -> Windows -> rcedit.

Создание проектов в Godot и Rider

Создаем новый проект. Необходимо в Project Path руками указать путь, чтобы сохранить регистр.

В редакторе создаем в любом месте C# скрипт и открываем его, чтобы создался проект в Rider и Solution для C#.

Настройка экспорта

1. Открываем Project -> Export
2. Добавляем нужные экспорты: Windows, Android и т.д.
3. Указываем Export path (пример для Windows): ./bin/win-64/GodotTemplate.exe
4. Если не был настроен rcedit, то отключаем Modify Resources

Если внизу есть ошибки из-за отсутствующих export template, то нажимаем Manage Export Templates.

1. Нажимаем Go Online
2. Нажимаем Download And Install

Открываем в Rider файл проекта (*.csproj).

В этот файл внутрь блока Project добавляем блок Target с настройками пре-билда.
Пример, как должно получиться:

<Project Sdk="Godot.NET.Sdk/4.4.1">
  ...
  <Target Name="PreBuild" BeforeTargets="PreBuildEvent">
    <ItemGroup>
      <DirectoriesToCreate Include="$(ProjectDir)bin\win-64" />
      <DirectoriesToCreate Include="$(ProjectDir)bin\android" />
      <FilesToCreate Include="$(ProjectDir)bin\.gdignore" />
    </ItemGroup>
    <MakeDir Directories="@(DirectoriesToCreate)" />
    <WriteLinesToFile File="@(FilesToCreate)" Lines="" Overwrite="true" />
  </Target>
  ...
</Project>

Копирование файлов

Создать папки Scripts, Scenes, Assets

Заменить файлы из GodotTemplate:
.editorconfig
.gitignore

Перенести icon.svg в Assets/Textures/icon.svg
Перенести исходники из папки Lib проекта GodotTemplate в новый проект.

Если был перенос исходников, то необходимо во всех исходниках переименовать GodotTemplate в название проекта.

Настройка проекта в Godot

Project -> Project Settings -> Application -> Run -> Main Scene = Scenes/Root/Root.tscn
Project -> Project Settings -> Application -> Config -> Icon = res://Assets/Textures/icon.svg

Настройка зависимости Lib в Rider

Сделаем так, чтобы основной проект мог ссылаться на классы из Lib, но не наоборот.
Если Lib попытается использовать класс из основного проекта, то получим ошибку компиляции и в Rider и в Godot.
При билде в Godot также происходит полный ребилд проекта Lib.

Создаем новый проект "Lib".

В настройках указываем имя "Lib", больше ничего не меняем.

Открываем файл проекта (*.csproj).
В этом файле первую строку заменяем на <Project Sdk="Godot.NET.Sdk/4.4.1">

Переключаем в Rider Explorer в режим File System (сверху). В папке Lib удаляем папки bin и obj.