diff --git a/DESIGNERS_SETUP.md b/DESIGNERS_SETUP.md new file mode 100644 index 0000000..7bee8c2 --- /dev/null +++ b/DESIGNERS_SETUP.md @@ -0,0 +1,80 @@ +# Инструкция по подготовке проекта для дизайнеров + +В этом руководстве описаны шаги, необходимые для того, чтобы настроить рабочее окружение, скачать проект и начать работу без конфликтов с кодом. + +--- + +## Шаг 1. Установка Git и Git LFS + +Для работы с проектом вам понадобится система контроля версий Git с поддержкой больших файлов (LFS). + +1. **Скачайте и установите Git:** + - Перейдите на сайт [git-scm.com](https://git-scm.com/) и скачайте версию для вашей ОС (Windows/macOS). + - При установке оставляйте все настройки по умолчанию. +2. **Скачайте удобный Git-клиент (GUI):** + - Работать через консоль не нужно. Рекомендуем скачать один из удобных визуальных клиентов: + - **Fork** (рекомендуется, очень быстрый): [git-fork.com](https://git-fork.com/) + - **GitHub Desktop** (самый простой): [desktop.github.com](https://desktop.github.com/) + - **SourceTree**: [sourcetreeapp.com](https://www.sourcetreeapp.com/) +3. **Инициализация Git LFS:** + - После установки Git откройте терминал (или Git Bash) и выполните один раз команду: + ```bash + git lfs install + ``` + +--- + +## Шаг 2. Установка Unity Hub и Unity Editor + +Проект разработан на конкретной версии Unity, и открывать его нужно строго в ней. + +1. **Скачайте Unity Hub:** + - Перейдите на [unity.com/download](https://unity.com/download) и установите Unity Hub. + - Войдите под своей учетной записью Unity. +2. **Установите нужную версию редактора Unity:** + - Версия проекта: **`6000.3.16f1`** (Unity 6). + - Если этой версии у вас нет, Unity Hub сам предложит её установить при первой попытке открыть проект. Также вы можете найти её в архиве версий Unity или во вкладке **Installs -> Install Editor** в Unity Hub. + +--- + +## Шаг 3. Клонирование репозитория и первый запуск + +1. Скопируйте ссылку на репозиторий в Gitea. +2. В вашем Git-клиенте выберите **Clone** (Клонировать) и укажите ссылку. +3. Дождитесь завершения скачивания. Из-за наличия графических LFS-файлов это может занять некоторое время. +4. Откройте **Unity Hub**, нажмите кнопку **Add** -> **Add project from disk** и выберите папку со сканным проектом. +5. Запустите проект. При первом открытии Unity сама импортирует все зависимости и создаст необходимые кэш-файлы (это может занять 5-15 минут). + +--- + +## Шаг 4. Настройка слияния файлов (UnityYAMLMerge) + +Чтобы Git автоматически решал конфликты в сценах и префабах, настройте инструмент умного слияния: + +1. В папке с проектом откройте скрытую папку `.git` (если вы её не видите, включите «Показ скрытых элементов» в проводнике). +2. Откройте файл `config` в текстовом редакторе (например, Блокноте). +3. Вставьте в самый конец файла следующий блок, указав правильный путь к установленной Unity на вашем компьютере: + +```ini +[merge "unityyamlmerge"] + name = Unity SmartMerge + driver = 'C:/Program Files/Unity/Hub/Editor/6000.3.16f1/Editor/Data/Tools/UnityYAMLMerge.exe' merge -p "$BASE" "$LOCAL" "$REMOTE" "$MERGED" + trustExitCode = true +``` + +--- + +## Шаг 5. Работа с ветками и блокировками файлов (LFS Locks) + +### Как начать работу: +1. В Git-клиенте переключитесь на свою ветку (например, `designer/graphics-1` или `designer/anim`). +2. Сделайте `Pull` (Получить изменения), чтобы убедиться, что у вас последняя версия. + +### Если нужно изменить общую сцену или префаб (например, `Player.prefab`): +1. **Заблокируйте файл:** в Git-клиенте нажмите правой кнопкой мыши на файл префаба/сцены и выберите **LFS -> Lock** (или в консоли: `git lfs lock путь_к_файлу`). +2. Откройте Unity и спокойно вносите изменения. +3. Закоммитьте изменения и отправьте (`Push`) их в свою ветку. +4. **Разблокируйте файл:** нажмите правой кнопкой мыши на файл и выберите **LFS -> Unlock** (`git lfs unlock путь_к_файлу`). + +> [!WARNING] +> Никогда не редактируйте чужие или общие сцены/префабы без предварительной блокировки! Это приведет к конфликтам слияния, которые будет очень трудно исправить.