Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Сборка и развёртывание

В этом разделе описаны шаги по сборке проекта CollectorBots для различных платформ, а также конфигурация mdBook для генерации документации.

Требования

Программное обеспечение

  • Unity 2021.3+ (рекомендуется LTS версия). Проверено на Unity 2021.3.15f1.
  • Git (для клонирования репозитория, опционально).
  • Visual Studio 2019/2022 или JetBrains Rider (для редактирования C# кода, не обязательно для сборки).
  • mdBook (только для сборки документации, опционально).

Аппаратные требования

  • ОЗУ: минимум 8 ГБ (рекомендуется 16 ГБ).
  • Процессор: любой современный многоядерный CPU.
  • Видеокарта: с поддержкой DirectX 11 или OpenGL 4.5.
  • Дисковое пространство: ~2 ГБ для проекта + место под сборки.

Инструкции по сборке

1. Подготовка проекта

Убедитесь, что проект открывается в Unity Editor без ошибок:

  1. Клонируйте репозиторий (или откройте существующую папку i:/Code_Source/UnityProjects/CollectorBots).
  2. Запустите Unity Hub, добавьте проект, выберите версию Unity 2021.3+.
  3. Откройте проект. Дождитесь завершения импорта ассетов (может занять несколько минут).

2. Настройка Build Settings

  1. В Unity Editor перейдите в File → Build Settings (или нажмите Ctrl+Shift+B).
  2. Убедитесь, что в списке Scenes In Build присутствует сцена Assets/Scenes/SampleScene.unity. Если её нет, перетащите её из окна Project в список.
  3. Выберите целевую платформу (по умолчанию PC, Mac & Linux Standalone). Для Windows выберите Target Platform = Windows, Architecture = x86_64.
  4. Нажмите Player Settings для дополнительных настроек.

3. Player Settings

В открывшемся окне Project Settings → Player настройте следующие параметры:

  • Company Name: введите название компании (например, "CollectorBots Team").
  • Product Name: "CollectorBots".
  • Version: укажите версию (например, 1.0.0).
  • Default Icon: установите иконку приложения (опционально).
  • Resolution and Presentation:
    • Fullscreen Mode: Windowed (или Fullscreen Window).
    • Resolution: 1920x1080 (рекомендуется).
  • Other Settings:
    • Color Space: Linear (для лучшего качества графики).
    • Auto Graphics API: включено.
    • Graphics APIs: Direct3D11 (Windows), OpenGL (Linux), Metal (macOS).
    • Scripting Backend: Mono (или IL2CPP для лучшей производительности).
    • Api Compatibility Level: .NET Standard 2.0 (или .NET 4.x).
  • Publishing Settings (для Windows):
    • Create Visual Studio Solution File: можно включить, если планируется дальнейшая отладка.

4. Сборка

  1. Вернитесь в окно Build Settings.
  2. Нажмите Build.
  3. Выберите папку для сохранения сборки (например, Builds/Windows).
  4. Дождитесь завершения процесса. В консоли Unity будут отображаться этапы компиляции и сборки.

После успешной сборки в указанной папке появятся:

  • CollectorBots.exe — исполняемый файл.
  • CollectorBots_Data/ — папка с ресурсами.
  • MonoBleedingEdge/ (или UnityPlayer.dll) — вспомогательные библиотеки.

5. Запуск собранной версии

Дважды кликните на CollectorBots.exe. Игра должна запуститься в отдельном окне.

Целевые платформы

PC/Windows (основная)

  • Целевая архитектура: x86_64 (64‑битная).
  • Минимальная версия ОС: Windows 10.
  • Рекомендуемые настройки: DirectX 11, разрешение 1920×1080.

MacOS

  • Целевая архитектура: Apple Silicon (ARM64) или Intel (x64).
  • Минимальная версия: macOS 10.15 Catalina.
  • Сборка: в Build Settings выберите платформу Mac OS X и настройте Architecture соответственно.

Linux

  • Целевая архитектура: x86_64.
  • Минимальные требования: дистрибутив с поддержкой OpenGL 4.5.
  • Сборка: выберите платформу Linux и настройте Architecture = x86_64.

Мобильные платформы (Android/iOS)

На данный момент проект не адаптирован для мобильных устройств. Для портирования потребуется:

  • Переработать UI под touch‑ввод.
  • Оптимизировать графику для слабых GPU.
  • Настроить управление камерой (жесты вместо мыши).

Конфигурация book.toml для mdBook

Документация проекта создана с помощью mdBook. Конфигурационный файл book.toml находится в корне проекта.

Содержимое book.toml

[book]
title = "Collector Bots"
authors = ["Dmitry Rysev"]
language = "en"

[output.html]
default-theme = "light"
preferred-dark-theme = "navy"

Сборка документации

  1. Установите mdBook (если ещё не установлен). Инструкции: https://rust-lang.github.io/mdBook/guide/installation.html.
  2. Откройте терминал в корне проекта (i:/Code_Source/UnityProjects/CollectorBots).
  3. Выполните команду: 
    mdbook build
    Это создаст папку book/ с HTML‑версией документации.
  4. Для локального просмотра запустите сервер: 
    mdbook serve --open
    Документация откроется в браузере по адресу http://localhost:3000.

Структура документации

  • Исходные файлы: находятся в папке src/ (все созданные в этом задании .md файлы).
  • Оглавление: определяется файлом src/SUMMARY.md.
  • Генерация: mdBook преобразует Markdown в HTML, сохраняя навигацию и подсветку кода.

Развёртывание

Распространение игры

  1. Архивация: упакуйте всю папку сборки (включая CollectorBots.exe и CollectorBots_Data) в ZIP‑архив.
  2. Дистрибуция: разместите архив на платформе распространения (Steam, itch.io, собственный сайт).
  3. Установка: пользователь должен распаковать архив в любую папку и запустить исполняемый файл.

Обновления

Для выпуска обновлений рекомендуется использовать систему патчей (например, через Unity Cloud Build или Incremental Builds). Однако в текущей версии механизм обновлений не реализован.

Системные требования для конечного пользователя

Укажите в описании игры следующие минимальные требования:

  • ОС: Windows 10 64‑bit / macOS 10.15 / Ubuntu 20.04.
  • Процессор: Intel Core i5‑2500 или AMD equivalent.
  • ОЗУ: 4 ГБ.
  • Видеокарта: NVIDIA GeForce GTX 660 или AMD Radeon HD 7870 (2 ГБ VRAM).
  • DirectX: версия 11.
  • Место на диске: 500 МБ.

Отладка собранной версии

Development Build

При сборке включите опцию Development Build в окне Build Settings. Это позволит:

  • Подключать Profiler к работающей игре.
  • Видеть Console логи (открывается клавишей Shift + Ctrl + C в Windows).
  • Использовать Debug‑версию скриптов с возможностью установки breakpoints.

Логи

Логи игры записываются в файл, расположение которого зависит от платформы:

  • Windows: %APPDATA%/../LocalLow/<CompanyName>/<ProductName>/output_log.txt
  • macOS: ~/Library/Logs/<CompanyName>/<ProductName>/Player.log
  • Linux: ~/.config/unity3d/<CompanyName>/<ProductName>/Player.log

Эти логи полезны для диагностики проблем у пользователей.

Заключение

Сборка проекта CollectorBots стандартна для Unity‑проектов. Следуя описанным шагам, вы получите работающий исполняемый файл для выбранной платформы. Документация, собранная через mdBook, может быть размещена на GitHub Pages или любом другом хостинге для удобства команды разработчиков.