0.3. Подготовка проекта (Unity)

Статус: Выполнено (2026-05-28)

---

Пошаговый чеклист. Проходить по порядку.

---

Шаг 1 — Git и GitHub

• Создать репозиторий на GitHub
• Добавить .gitignore для Unity (шаблон)
• Сделать первый коммит с базовой структурой проекта
• Создать ветку dev от master и переключиться на неё
• Запушить обе ветки в remote

git checkout -b dev
git push -u origin master
git push -u origin dev

---

Шаг 2 — Структура папок в Assets/

• Создать Assets/_Project/ со всеми подпапками
• Создать Assets/Tests/EditMode/ и Assets/Tests/PlayMode/

Assets/
├── _Project/
│   ├── Scripts/
│   │   ├── Core/         ← Guildmaster.Core.asmdef
│   │   ├── Units/        ← Guildmaster.Units.asmdef
│   │   ├── Combat/       ← Guildmaster.Combat.asmdef
│   │   ├── Guild/        ← Guildmaster.Guild.asmdef
│   │   └── UI/           ← Guildmaster.UI.asmdef
│   ├── ScriptableObjects/
│   ├── Prefabs/
│   ├── Scenes/
│   ├── Art/
│   │   ├── Sprites/
│   │   └── Animations/
│   ├── UI/
│   └── Audio/
└── Tests/
    ├── EditMode/         ← Guildmaster.Tests.EditMode.asmdef
    └── PlayMode/         ← Guildmaster.Tests.PlayMode.asmdef

---

Шаг 3 — Assembly Definitions

• Создать .asmdef файлы для каждого модуля в Scripts/
• Создать .asmdef для Tests/EditMode/ и Tests/PlayMode/
• Актуализировать карту сборок в 1. Сборки (Assembly Definitions)

Зависимости:

Core ← Units ← Combat
               Guild ← UI

---

Шаг 4 — Unity пакеты

• Input System — com.unity.inputsystem
• Test Framework — com.unity.test-framework
• mcp-unity — для интеграции с Cursor AI

После установки mcp-unity: Window → MCP Unity → Server Window → запустить сервер.

---

Шаг 5 — Cursor AI

• Создать .cursor/mcp.json с серверами: unity, github, git, context7, filesystem
• Создать CLAUDE.md — точка входа для агентов
• Создать .cursor/rules/project-context.mdc — стандарты кода, рабочий процесс
• Создать .cursor/rules/git-conventions.mdc — правила коммитов и веток

---

Шаг 6 — Документация (Obsidian Vault)

• Создать папку docs/wiki/ как Obsidian Vault
• Создать docs/wiki/.obsidian/app.json с базовыми настройками
• Создать docs/wiki/README.md — корневой README для GitHub
• Создать docs/wiki/index.md — главная страница Vault
• Добавить в .gitignore: docs/wiki/.obsidian/workspace.json, workspace-mobile.json, cache

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

docs/wiki/
├── README.md                                        ← корневой README (виден на GitHub)
├── index.md                                         ← главная страница Vault (Obsidian)
│
├── gdd/
│   ├── 0.0. README.md                               ← индекс раздела
│   ├── 0.2. Открытые вопросы.md                    ← нерешённые вопросы дизайна
│   ├── 0.3. Черновик.md                             ← сырые идеи
│   ├── 0.4. Локализация.md                          ← глоссарий RU/EN
│   ├── 1. Концепция.md
│   ├── 2. Лор.md
│   ├── 3. Боевая система.md
│   ├── 4. Гильдмастер.md
│   ├── 5. Реликвии.md
│   ├── 6. Мультиплеер.md
│   └── 7. Ивенты и мини-игры.md
│
└── tech/
    ├── 0.0. README.md                               ← индекс раздела
    ├── 0.1. Открытые вопросы.md                    ← нерешённые технические вопросы
    ├── 0.2. Черновик.md                             ← сырые технические заметки
    ├── 0.3. Подготовка проекта (Unity).md           ← этот файл
    ├── 1. Сборки.md                                 ← карта Assembly Definitions
    ├── 2. Сохранения.md
    └── 3. Рандомизация.md

Соглашение по нумерации

Префикс	Тип документа
0.0.	README / индекс раздела
0.1.–0.N.	Служебные документы (вопросы, черновики, глоссарий)
1.–N.	Основные документы раздела

---

Шаг 7 — CI/CD

• Создать .github/workflows/ci.yml на основе GameCI
• Добавить секреты в GitHub: UNITY_LICENSE, UNITY_EMAIL, UNITY_PASSWORD
• Настроить branch protection на master и dev (требует прохождения CI)
• Создать scripts/run-tests.ps1 для локального запуска тестов
• Сделать тестовый push и убедиться, что pipeline проходит

Активация Unity License

Лицензия находится локально: C:\ProgramData\Unity\Unity_lic.ulf

Если файла нет: Unity Hub → Preferences → Licenses → Add → Get a free personal license.

Добавить секреты: GitHub → Settings → Secrets and Variables → Actions

Секрет	Значение
UNITY_LICENSE	Содержимое .ulf файла (весь XML)
UNITY_EMAIL	Email Unity аккаунта
UNITY_PASSWORD	Пароль Unity аккаунта

✅ Секреты добавлены, CI запускается успешно (проверено 2026-05-28).

Branch protection требует публичного репозитория или GitHub Pro.

---

Шаг 8 — Финальный коммит

• Финальный коммит сделан

chore: initial project setup with CI, MCP, and Cursor rules

---

Шаг 9 — GitHub Pages (Docs Site)

• Добавить doxygen/doxygen-awesome-css как git submodule
• Создать quartz-config/quartz.config.ts и quartz.layout.ts
• Создать doxygen/Doxyfile
• Создать .github/workflows/docs.yml
• Запушить изменения и дождаться первого деплоя
• Активировать GitHub Pages: Settings → Pages → Branch: gh-pages → /root

Подробнее: 4. Docs Site (GitHub Pages)

---