ДОСТУП К ПРОЕКТУ

Info

Перед началом работы над актуальным проектом нужно подключить папку проекта с внешнего хранилища.

Для этого на личном ПК в разделе Этот компьютер выполнить следующее действие (рис 1.1), или вызвать из выпадающего списка при правом клике мыши на свободном пространстве.


Рис. 1.1. Добавление сетевого расположения

В открывшемся окне следуем далее до страницы где нужно указать сетевой адрес (рис. 1.2). В данном поле вводим путь до необходимого ресурса (например, \10.150.144.9\Disk1\ProjectFiles\ME\Childbirth) и следуем далее.

Info

Путь предоставит кто-то из руководящего состава или будет указан в дополнительной документации по проекту.


Рис. 1.2. Поле для сетевого адреса

Результатом данной процедуры будет папка в разделе Этот компьютер, которая предоставляет доступ к проекту на сетевом хранилище.

2. ОРГАНИЗАЦИЯ ДИРЕКТОРИЙ ПРОЕКТА

В корневой директории проекта располагаются папки, которые относятся ко всему проекту (рис. 1.3).


Рис. 1.3. Базовые папки: 1 – папка с проектом Unity; 2 – папка ассетами; 3 – документация проекта; 4 – входящие референсы от заказчика

Все трехмерные модели далее размещаются в папке asset. Эта папка разбита на категории ассетов по производственным шаблонам (рис. 1.4).


Рис. 1.4. Папки директории asset: 1 – папка для анимированных персонажей; 2 – папка для элементов окружения; 3 – папка для статичных моделей

Все эти три папки устроены аналогичным образом. Поэтому рассмотрим устройство на примере папки prop. В этой папке находятся подпапки для каждого ассета (рис. 1.5) и шаблон папки для нового ассета (!propName).


Рис. 1.5. Пример подпапок статичных моделей

Папка конкретного ассета устроена следующим образом (рис. 1.6). Внутри каждой из этих папок находится папка pub, где мы и размещаем готовые файлы для публикации.


Рис 1.6. Папка конкретного ассета: 1 – папка для самой модели; 2 – папка для текстур

Info

Подробнее познакомиться с полной структурой проекта можно в Приложении А.

3. СОГЛАШЕНИЕ ПО НАИМЕНОВАНИЮ

3.1. Базовое наименование

Общие правила именования папок и файлов, входящих в структуру хранения:

при использовании полных слов или их частей используется английский язык;
используются символы латинского алфавита, строчные и прописные;
могут использоваться арабские цифры;
в качестве разделителя частей имени используется знак подчёркивания «_»;
для дополнительного разделения внутри частей имён используется CamelCase стиль;
не допускается использовать различные регистры для именования одно-го и того же объекта, даже если используемая ОС это допускает (например, Lava и LAVA и lava – ошибочно).
Правила именования файла:
имя ассета должно быть одним составным словом, состоящим не менее чем из двух частей;
используется CamelCase стиль разделения частей имени;
последняя часть составного имени должна отражать суть ассета или его имя, например, <…>Pen, <…>Rudy, <…>Box;
при необходимости добавить дополнительную информацию к имени ас-сета она добавляется в начало имени, используя CamelCase стиль, например, RedCapGrayBoy.

Info

Примеры именования ассетов: GreenHouse, VeryGoodBoy.

Правила именования процесса:

имя Процесса должно быть одним составным словом, состоящим из одного или нескольких составных частей;
используется CamelCase стиль именования;
имя Процесса должно быть как можно короче, можно использовать сокращения (например, Low, High, UV).

Info

Примеры именования процессов: GreenHouse_Low, VeryGoodBoy_UV.

3.2. Наименование финальных ассетов

Финальное наименование стоит вести согласно требованиям принятых для продукта сборки (например, Unity, Unreal, Houdini,…).

Important

Если не оговорено иное, предлагаю придерживаться соглашения принятого для Unreal.
UE5 Style Guide

ПРИЛОЖЕНИЕ А

Подробное описание структуры проекта

На следующем изображении продемонстрирована вся структура возможного проекта. Если какие-то директории не описаны, значит их структура идентична прочим описанным.


Рис. П.1. Структура файлов проекта: 1 – папка, принадлежащая конкретной компании; 2 – папка проекта; 3 – папка с проектом игрового движка; 4 – папка с документацией по проекту; 5 – папка со скриптами и экспериментами для обслуживания проекта; 6 – папка для разработки общих или первичных концептов для про-екта; 7 – папка с общими или первичными референсами для проекта; 8 – папка с различными ассетами для проекта; 9 – папка ассетов, базирующихся на определенном производственном шаблоне; 10 – папка одного из ассетов; 11 – папка с референсами для конкретного ассета; 12 – папка для разработки концептов конкретного ассета; 13 – папка для разработки модели кон-кретного ассета; 14 – папка для разработки текстур для конкретного ассета; 15 – папка для настройки визуальной составляющей ассета; 16 – папка для настройки скелета и системы ани-мации ассета; 17 - папка для разработки анимаций ассета; 18 – папка с рабочими файлами мо-дели ассета; 19 – папка с финальной геометрий, с финальным рабочим файлом для публикации; 20 – папка с временными файлами, образующимися в процессе работы; 21 – директории под конкретный файлы софта (Maya, Zbrush, Houdini, ...); 22 – папка с финальной геометрий для за-пекания (Low и High); 23 – директории с различными экспортами из приложений (fromMaya, …); 24 – папка с данными из внешних источников (Web, от сторонних организаций).

Рис. П.1. Структура файлов проекта:
1 – папка, принадлежащая конкретной компании; 2 – папка проекта; 3 – папка с проектом игрового движка; 4 – папка с документацией по проекту; 5 – папка со скриптами и экспериментами для обслуживания проекта; 6 – папка для разработки общих или первичных концептов для про-екта; 7 – папка с общими или первичными референсами для проекта; 8 – папка с различными ассетами для проекта; 9 – папка ассетов, базирующихся на определенном производственном шаблоне; 10 – папка одного из ассетов; 11 – папка с референсами для конкретного ассета; 12 – папка для разработки концептов конкретного ассета; 13 – папка для разработки модели кон-кретного ассета; 14 – папка для разработки текстур для конкретного ассета; 15 – папка для настройки визуальной составляющей ассета; 16 – папка для настройки скелета и системы ани-мации ассета; 17 - папка для разработки анимаций ассета; 18 – папка с рабочими файлами мо-дели ассета; 19 – папка с финальной геометрий, с финальным рабочим файлом для публикации; 20 – папка с временными файлами, образующимися в процессе работы; 21 – директории под конкретный файлы софта (Maya, Zbrush, Houdini, ...); 22 – папка с финальной геометрий для за-пекания (Low и High); 23 – директории с различными экспортами из приложений (fromMaya, …); 24 – папка с данными из внешних источников (Web, от сторонних организаций).

Подробнее рассмотрим как хранятся данные в проекте при совместной работе многими разработчиками над одним ассетом на примере папки model.


Рис. П.2. Структура папки model

Как ранее описывалось в основной части документации, готовые ассеты помещаем в папку pub.
Так как процесс текстурирования может выполнять совершенно другой человек, в папке forBake нужно разместить модели готовые для запекания, чтобы сторонний человек не копался в рабочих файлах.
Папка _wip предназначена для рабочих файлов. Она содержит папки для определенного софта (например, Zbrush, Maya, soft чисто для примера), в которых будут храниться файлы проекта, и папку _temp, которая нужна для промежуточных файлов, которые экспортируются из основных приложений или пришли извне.
Папка _temp содержит папку outside для внешних моделей и папку fromSoft (для примера, fromMaya, fromHoudini, fromZbrush).

Info

О необходимости хранения всех рабочих файлов сообщит кто-то из руководящего состава или будет указано в дополнительной документации по проекту.