Настройка среды разработки

Материал из Space Station 14 Вики
Версия от 02:07, 29 июля 2024; VulfiMoon (обсуждение | вклад) (Настройка ide, не до конца)
(разн.) ← Предыдущая версия | Текущая версия (разн.) | Следующая версия → (разн.)

Сначала вам понадобится программное обеспечение:

Git или один из множества сторонних интерфейсов, которые упрощают его использование. Убедитесь, что вы установили его в PATH, как показано здесь. Python 3.7 или выше. Убедитесь, что вы установили его в PATH на Windows. Также убедитесь, что при установке на Windows включен параметр «py launcher». Вы должны скачать Python с сайта python.org. Версии, установленные из Windows Store, иногда вызывают проблемы со сборкой. .NET 8.0 SDK. Visual Studio также устанавливает это, если вы используете Windows. Пользователи Mac на базе ARM (M1): вам нужно установить x64 .NET, а не ARM .NET. Движок в настоящее время не работает нативно на Mac ARM, поэтому рекомендуется использовать x64 через эмуляцию Rosetta 2. Желательно использовать IDE, чтобы сделать разработку менее болезненной (все варианты бесплатны, если не указано иное): Для Windows — Visual Studio 2022 Community. Для минимальной установки (она огромна) вам понадобится рабочая нагрузка .NET Desktop Development, компилятор C#, поддержка C#, менеджер пакетов NuGet, MSBuild и .NET 8 SDK или что-то в этом роде. Для macOS — Visual Studio for Mac. Для всех платформ (НЕ БЕСПЛАТНО + требуется VPN) Rider — один из лучших доступных IDE, и многие разработчики SS14 предпочитают его Visual Studio. Студенты колледжей и университетов могут получить бесплатную лицензию для обучения, даже если они не являются студентами компьютерных наук. Для всех платформ — Visual Studio Code с расширением C#. Обычно это менее удобная IDE по сравнению с полноценными IDE, такими как обычный Visual Studio, но некоторые опытные программисты предпочитают минимализм. Эксклюзивно для VSCode/VSCodium: вы можете установить наше сообщественное расширение Robust YAML для лучшего опыта работы с Robust Toolbox YAML поверх расширения поддержки языка YAML. Для всех платформ — VSCodium с расширением C#. Открытый исходный код и без лишних функций и отслеживания, как в VSCode.

Клонирование

Даже если вы уже знакомы с Git, прокрутите вниз, чтобы прочитать раздел о настройке подмодулей. Серьезно.

Если вы знакомы с Git, просто форкните и клонируйте репозиторий, настройте удалённые репозитории, а затем следуйте руководству по настройке подмодулей ниже.

Если вы не знакомы с Git или просто не знаете, как продолжить, следуйте руководству «Git для разработчика SS14(статья)», которое подробно объясняет, как вносить свой вклад в игру и как настроить ваш первоначальный репозиторий. Оно также затрагивает настройку подмодулей, но это включено здесь из-за важности этой темы.

Настройка субмодуля

У нас есть автоматический обновитель подмодулей, так что вам не нужно беспокоиться о постоянном выполнении команды git submodule update --init --recursive.

Запустите RUN_THIS.py внутри репозитория, который вы скачали, с помощью Python. Предпочтительно также из терминала. Это должно занять несколько секунд, так что если выполнение останавливается мгновенно, проверьте, используете ли вы Python 3.7+; в противном случае читайте дальше.

Если при запуске RUN_THIS.py окно сразу открывается и закрывается: не беспокойтесь. Это не означает, что скрипт не сработал. Скрипт автоматически закрывается после завершения, так что если вы хотите убедиться, что всё прошло правильно, проверьте подмодуль /RobustToolbox/ и убедитесь, что все файлы на месте. Если нет, попробуйте проверить раздел устранения неполадок внизу этой страницы.

Примечание: Если у вас возникли проблемы с отсутствующими файлами при начальной настройке, рекомендуется вручную выполнить git submodule update --init --recursive один раз на случай, если что-то пошло не так с Python.

Если вы хотите напрямую изменять движок или обновлять подмодуль вручную (автоматическое обновление может быть неудобным), создайте файл под названием DISABLE_SUBMODULE_AUTOUPDATE внутри директории BuildChecker//.

И на этом этапе ваш репозиторий настроен правильно!

Настройка IDE

Visual Studio

  1. Скачайте Visual Studio Community (если у вас нет платной версии) отсюда.
  2. Запустите установщик и выберите .NET Desktop Development, затем установите.
  3. Если установщик спросит вас о среде разработки, выберите Visual C#.
  4. Откройте Visual Studio.
  5. Выберите Открыть проект или решение и перейдите к клонированному репозиторию, затем откройте SpaceStation14.sln.

JetBrains Rider

  1. Установите Rider, мы рекомендуем использовать JetBrains Toolbox, чтобы он мог автоматически обновляться в будущем.
  2. Пройдите через установку.
  3. Нажмите «Открыть» и выберите SpaceStation14.sln.
  4. Если вы планируете заниматься разработкой движка, вам нужно добавить Robust Toolbox в Directory Mappings, чтобы система управления версиями Rider могла отслеживать изменения в Robust. Откройте настройки Rider и перейдите в раздел Version Control > Directory Mappings и нажмите кнопку плюс (+). В поле Directory укажите папку RobustToolbox в проекте и выберите Git как VCS.

VSCodium

  1. Скачайте VSCodium отсюда или напрямую с Github здесь (на последнем релизе нажмите на выпадающий список «Assets», затем прокрутите вниз до ZIP или .exe для вашей операционной системы).
  2. Запустите установщик или извлеките zip-файл в любое выбранное вами место и запустите .exe после извлечения.
  3. После установки перейдите на вкладку Extensions (в средней части панели в верхнем левом углу, выглядит как 4 плитки) и найдите «C#». Установите расширение от «Muhammad-Sammy» с более чем 70K загрузок и зеленым/белым логотипом. ID расширения: muhammad-sammy.csharp.
  4. Выберите File > Open Folder, затем перейдите к клонированному репозиторию и откройте эту полную папку.
  5. Когда будет предложено открыть решение, выберите SpaceStation14.sln. Альтернативно, установите настройку dotnet.defaultSolution в SpaceStation14.sln в настройках вашего рабочего пространства.
  6. Теперь вы можете запускать и отлаживать свою игру. Выберите значок над «Extensions» из предыдущего шага для Run and Debug и в выпадающем списке рядом с зеленой кнопкой воспроизведения выберите «Server/Client». Это запустит как клиент, так и сервер, открывая игру для отладки. Соответствующая информация будет отображаться в отладке внизу. Выберите процессы в стеке вызовов слева, чтобы изменить то, что вы отлаживаете.

Запустите SS14

Теперь вы можете приступать к компиляции клиента и сервера! Используйте вашу любимую IDE, чтобы открыть файл решения SpaceStation14.sln, и нажмите кнопку сборки.

Чтобы скомпилировать без IDE, выполните команду dotnet build в директории репозитория Space Station 14. Затем выполните следующие команды, чтобы запустить клиент и сервер: dotnet run --project Content.Server dotnet run --project Content.Client Обе эти команды используют конфигурацию отладки по умолчанию. Чтобы включить оптимизацию релизной версии, добавьте --configuration Release к вызову dotnet.

Примечание: Если у вас возникают проблемы с тем, что dotnet не находит libssl (например, при использовании libressl), попробуйте установить переменную окружения CLR_OPENSSL_VERSION_OVERRIDE на соответствующую версию. Например, установите её на 48, если в вашем /usr/lib есть libssl.so.48. Если это не сработает, вы также можете попробовать выполнить ln -s /usr/lib/libssl.so /usr/local/lib/libssl.so.1.0.0.

Настройка параметров сборки

Клиент и сервер SS14 — это независимые проекты, но оба можно запускать одной кнопкой в вашей IDE. Это нужно настроить. Примечание: рекомендуется запускать Content.Client и Content.Server при разработке в вашей IDE, а не Robust.Client или Robust.Server. Причина в том, что запуск Content.* сделает вашу IDE осведомленной о зависимостях и обеспечит правильную пересборку. Если запускать Robust.Clien напрямую, вам придется каждый раз убеждаться, что решение полностью собрано, что неудобно и легко забыть. Если вы не уверены, что такое Robust или Content, ознакомьтесь с этой страницей о структуре проекта(статья).

Visual Studio 2022

В Visual Studio 2022 можно настроить кнопку сборки для одновременного запуска сервера и клиента, щелкнув правой кнопкой мыши на решении и выбрав Configure StartUp Projects…. Когда появится меню, выберите Multiple startup projects: и установите действие для Content.Client и Content.Server на Start. После применения изменений, нажатие на большую кнопку Start с зеленой стрелкой запустит как клиент, так и сервер одновременно.

Примечание: если у вас возникают проблемы с правильной сборкой программы, возможно, вам нужно установить параметр «всегда собирать перед запуском». Перейдите в Options > Projects and Solutions > Build and Run и измените On Run, when projects are out of date на Always build.

В Visual Studio вы также можете использовать клавиши F7 для сборки проекта и F5 для его запуска.

Visual Studio Code

Расширение C# предоставляет тип запуска «coreclr», который можно использовать для запуска исполняемых файлов Content.Server и Content.Client в их соответствующих директориях bin/. Можно использовать составную конфигурацию запуска для одновременного запуска сервера и клиента.

Командная строка

Соберите проект с помощью dotnet build и запустите клиент и сервер в разных командных строках с помощью:

dotnet run --project Content.Server dotnet run --project Content.Client Определенно есть способ запустить две команды одновременно, но вам, вероятно, нужно будет поискать это в Google.

Источник — https://station14.ru/index.php?title=Настройка_среды_разработки&oldid=47754