Просмотр исходного текста страницы Контроль версий

[[Category:Editor Reference]]
{{Incomplete}}

== Введение ==
Система контроля версий (''англ.'' Version Control) это возможность, встроенная в редактор Creation Kit и используемая разработчиками из Bethesda для возможности совместной одновременной работы над одним и тем же ESM файлом(и). Контроль версий полезен для моддеров, потому что он позволяет вливать содержимое из ESP файлов в ESM файл. В публичной версии Creation Kit, возможность контроля версий по-умолчанию отключена. Её можно включить, следуя инструкциям на этой странице.

'''Так же можно посмотреть видео-учебник от Wheeze по системе контроля версий:''' http://youtu.be/6eInvAyMXoI

== Локальная настройка ==
Данные инструкции нацелены на тех, кто хочет использовать контроль версий для простого объединения данных ESP файлов в ESM файл.

Создайте следующие директории, будем считать, что ''Skyrim'' это директория установки вашего Skyrim:
<source lang="html4strict">
Skyrim\Data\CheckInBackup
Skyrim\Merging\Data
Skyrim\Merging\VersionBackup
</source>


Далее необходимо расшарить (сделать доступными в вашей локальной сети) папки ''CheckInBackup'' и ''Merging'' (это может быть фейковая сеть с единственным вашим ПК). Скопируйте ''Skyrim.esm'' (и возможно ''Update.esm'') и один или более ваших ESM-файлов в ''Skyrim\Merging\Data''. Это будут "сетевые версии". Добавьте следующее в ''SkyrimEditor.ini'' (некоторые параметры могут уже существовать, так что следите за этим):	

<source lang="ini">
[General]
bUseVersionControl=1
SNetwork Path=\\Maegfaer-PC\Merging\
SNewVersionBackupPath=\\Maegfaer-PC\Merging\VersionBackup\
SNetworkMasterPath=\\Maegfaer-PC\Merging\Data\
SLocalSavePath=Saves\
SLocalMasterPath=Data\
SLocalBackupPath=Data\CheckInBackup
</source>

Замените ''Maegfaer-PC'' именем вашего компьютера.
 
Теперь перейдите в ''SkyrimEditorPrefs.ini'' (другой файл) и добавьте вниз следующее:

<source lang="ini">
[WhoCanMerge]
Maegfaer=1
</source>

Замените ''Maegfaer'' именем пользователя учетной записи в Windows. 

Теперь запустите CK, загрузите ''Skyrim.esm'' (и возможно ''Update.esm'') и ESM-файл(ы) вашего мода выбрав из меню ''File -> Data'' или нажав по кнопке с желтой иконкой "папки" на панели инструментов - и выбрав их в списке доступных файлов модов. При загрузке файлов, CK скорее всего покажет предупреждающий диалог с текстом:

 "DEFAULT: TESBitArrayFile::OpenAndMapBitArrayFile could not find '[modfile].fud'

Это вполне нормально - можете отключить предупреждения.

Как только файлы мода загружены, снова нажмите по кнопке с "папкой", выберите ''Skyrim.esm'' и нажмите по кнопке '''Details'''. При вопросе о создании пустого списка (''англ.'' empty list) ответьте "'''Yes'''". когда будет показан пустой список, нажмите сочетание клавиш '''Ctrl + Shift + B''' и затем нажмите '''OK'''. Закройте и сделайте те же самые действия для ESM-файла(ов) вашего мода. Теперь в вашей директории ''Skyrim\Merging\Data'' появятся файлы системы контроля версий, используемые для объединения ESP-файлов в любой из ваших ESM-файлов. 

Если вдруг не появляется окно "'''Empty List?'''", то скорее всего что-то не так с именем пользователя, что в указали в файле конфигурации. Здесь должен появиться новый файл:

 ''Skyrim\Merging\ConstructionSetNetwork.ini''

который содержит (например)

<source lang="ini">
[Users]
1=Maegfaer
Maegfaer=1
</source>

Убедитесь, что имя пользователя указанное здесь, совпадает с тем, что вы указали в ''SkyrimEditorPrefs.ini''. Оно может различаться, если вы когда-либо переименовывали свою учетную запись в Windows. Значение, созданное в ''ConstructionSetNetwork.ini'' будет то - которое будет использовать CK - скопируйте его в ''SkyrimEditorPrefs.ini''.

Теперь можно использовать контроль версий.

== Использование контроля версий ==
==== Быстро и просто ====
Загрузите CK отметьте ваш ESM-файл, с которым нужно слить данные и ESP содержащий присоединяемые данные как активный (''англ.'' Active). Как только CK закончил загрузку, нажмите кнопку Version Control с левого края панели инструментов. Во-первых, сделайте ''Check out'' для всех форм которые хотите слить, затем выберите их снова и нажмите ''Check In''. Появится новое окно. Выберите ESM-файл в который хотите влить данные. Выберите ''No'' при вопросе об использовании ''Check In Data file'' (CID), он сольет содержимого вашего ESP файла в выбранный ESM и позволит решить возникающие конфликты с formID.

==== Masters ====
При использовании контроля версий, максимум можно иметь только 3 .esm файла за раз. Во время разработки, этими файлами у Bethesda были ''Skyrim.esm'', ''Update.esm'', и либо ''Dragonborn.esm'', либо ''Dawnguard.esm''. Это вроде меры, принятой для стабильной работы системы, поскольку если Creation Kit превысит допустимый размер используемой памяти, то он вылетит. Есть решение этого ограничения, но оно не рекомендуется.

==== Check Out/In ====
Помните, что система контроля версий сделана для большой группы разработчиков, которые одновременно работают над созданием игрового мира. Понятие '''Check Out''' для ''formID'' означает "зарезервировать" её, она будет "заперта" в сетевой версии мастер-файла (ESM-файл в папке ''Merging\Data'') так, что ни кто не сможет одновременно редактировать один и тот же контент, от чего обычно бывают конфликты. Каждый разработчик всегда имеет копию ESM в его локальной системе (ваша обычная папка ''Data'' в каталоге игры). Так почему же нужно использовать '''Check Out''' (резервировать форму) до процедуры '''Check In''' (вливания новых данных) - это часть механизма предохранения, чтобы разработчики не могли одновременно менять одни и те же формы. Эти шаги не имеют большого значения, если вы используете только локальный вариант системы контроля версий. Это лишь описание того, как работает данная система.

==== Соединение нескольких плагинов ====
Файлы с расширением ''.fvd'', ''.fud'' и т.п. хранимые в доступной по сети папке (расшаренной папке), должны по новой генерироваться после каждого вливания данных в .esm файл, при использовании шагов, описанных выше. В ином случае, Creation Kit может не позволить вам зарезервировать через '''Check Out''' некоторые формы, которые были изменены в плагине, касающиеся записей, которые уже были влиты в esm. Чтобы убедиться в том, что вы не перезаписываете данные, которые вы уже влили или что вы не пытаетесь внедрить записи, которые могут потенциально привести к вылету Creation Kit, настоятельно рекомендуется сначала проверить каждый плагин на ошибки, внедренные записи (''англ.'' Injected Records), [http://www.creationkit.com/index.php?title=TES5Edit_Cleaning_Guide_-_TES5Edit#Dirty_Edits dirty edits], и ITM записи в программе '''TES5Edit'''.

==== CID файлы ====
При использовании ''Checking In'' для форм, Creation Kit при необходимости изменяет formID этих форм, для предотвращения дублирования formID в ESM-файле. Он так же меняет индекс для formID для совпадения с индексом в ESM-файле. Любые ссылки (экземпляры) форм, использующиеся в других формах будут скорректированы, чтобы соответствовали новому назначенному formID. При вливании данных, все переназначенные formID будут перечислены в *.CID файле в директории, указанной в свойстве ''SNewVersionBackupPath'' файла ''SkyrimEditor.ini''.

CID файлы могут быть полезными при вливании ''Плагина A'' и ''B'' в ESM, в то время, как ''Плагин B'' зависит от ''Плагина A''. Предположим, что ''Плагин A'' первым вливается в ESM. Формы ''Плагина A'' получают новые formID, что поломает любые ссылки в ''Плагине B'' с формами, находящимися в ''Плагине A''. При вливании ''Плагина B'' в ESM, будет создан CID файл, к которому будет обращаться система контроля версий в процессе вливания данных ''Плагина A''. Таким способом, поломанные ссылки на формы в ''Плагине B'' будут изменены на переназначенные формы, находящиеся в ''Плагине A''.

==== Хитрость по резервированию форм в Skyrim.esm ====
Резервирование форм, находящихся в ''Skyrim.esm'' через '''Check Out'' по-умолчанию не работает. Это может быть проблематично, если у вас есть собственный ESM файл и вы хотите влить ESP файлы в ваш ESM. Вы не можете отмечать какую-либо из форм файла Skyrim.esm, которую изменяет ESP файл, и поэтому не можете вливать эти изменения.

Для решения этой проблемы нужно временно отключить флажок '''Use Localized Strings''' в заголовке файла ''Skyrim.esm''. Это можно сделать, открыв ''Skyrim.esm'' в hex-редакторе, и изменив девятый байт со значения ''81'' на ''01''. Только сначала сделайте резервную копию ''Skyrim.esm'' хотя бы для того, если что-то пойдет не так!

ПО-умолчанию, начало файла выглядит вроде этого:

<source lang="ini">54 45 53 34      2C 00 00 00     81 00 00 00</source>

Нужно поменять на:

<source lang="ini">54 45 53 34      2C 00 00 00     01 00 00 00</source>

Сохранить изменения и загрузить Skyrim.esm в CK. Вы получите весьма много сообщений об ошибках со строками и тому подобное, проигнорируйте их и нажмите '''Yes to All'''. Теперь можно делать '''Check Out''' для форм, находящихся в ''Skyrim.esm''. Вливайте любые сделанные изменения над формами из Skyrim.esm в вашем ESP файле в ваш собственный ESM, затем выйдите из Creation Kit и верните исходный флажок в файле.

== Интеграция Perforce ==
Perforce - это сторонний софт для управления версиями, доступный бесплатно для небольших групп. При установке с параметрами, указанными здесь, Perforce работает рука-об-руку с системой Version Control для сохранения резервных копий предыдущих изменений в скриптах, и позволяет каждому индивидуально работать над проектом, получать последний версии всех скриптов проекта с сервера Perforce. Так же, Perforce управляет файлами DialogueView, если такие предоставляются. В дополнение к хранению копий различных версий файлов, Creation Kit будет обновлять id форм во всех хранимых скриптах и dialogue views которые в ином случае менялись бы при влитии изменений в .esm.

С внедренным Perforce, для команд, работающих по сети появляется возможность работать с мастер-сервером, используя лишь Creation Kit и Perforce с обычного сервера для контроля версий.

=== Установка ===
Первым делом, настройте Version Control, как было указано выше в учебнике.
 
В файле ''SkyrimEditor.ini'' в вашей директории Skyrim, убедитесь, что в секции параметров [Papyrus], у вас есть набор следующих параметров, как указаны ниже:

<source lang="ini">
sScriptSourceFolder = "Data\Scripts\Source"
sScriptCompiledFolder = "Data\Scripts\"
sCompilerFolder = "Papyrus Compiler\"
bPerforceEnabled = 1
</source>

В ''SkyrimEditorPrefs.ini'' убедитесь что у вас введены, указанные ниже настройки. Примечания указаны в скобках, их копировать не нужно.
<source lang="ini">
[Perforce]
sWorkspace=Papyrus (Имя рабочего пространства в Perforce - следуя этому чебнику, назовите его Papyrus)
sUsername=Rich (Ваше имя пользователя в Perforce - я использовал то же, что название учетной записи в Windows)
[Papyrus]
sPerforceWorkspace=AWESOME-O (Имя вашего компьютера)
sPerforceUsername=Rich (Имя пользователя в Windows)
sDLCPrefix=DLC (Префикс, который вы хотите добавлять к любым обработанным скриптовым фрагментам)
</source>

www.gameindustry.about.com/b/2012/07/29/version-control-management-and-games.htm

Я опишу примерные шаги для нашей текущей задачи, но для более подробных инструкций, пожалуйста, ознакомьтесь с данным учебником.

[http://www.perforce.com/downloads Отсюда можно скачать]

Установите '''Perforce Server''' используя предлагаемые параметры по-умолчанию, включая - и это важно - путь по-умолчанию. Установите ваше имя пользователя таким же как и ваш пользователь в Windows. У вас должны быть права администратора.

В ''Perforce Depot'' установите имя ''TESVData'' (название депо). Это важный момент, потому что это имя и поддиректории, которые мы в конечном счете настроили в рабочем пространстве являются путями, зашитыми в коде Creation Kit. Вы можете выбрать другое место для хранения версий файлов - некоторое вы можете изменить позже в настройках депо через утилиту '''P4Admin'''.

Далее, установите клиент '''Perforce Visual Client''', также используя параметры по-умолчанию. Уберите галочку с ''Plug-in for Windows Explorer''.

Откройте ваш '''Perforce Server''', убедитесь, что он настроен так, как в учебнике, затем откройте P4V (графический клиент). Нужно создать новое рабочее пространство (''англ.'' workspace) с именем ''Papyrus'' (не уверен что это жестко зашито в коде, но вполне может быть. Можете попробовать проверить и другое имя для workspace).

Корень рабочего пространства (''англ.'' workspace root) должен находиться в новой директории в любом месте вашего компьютера. У себя я разместил директорию выше папки со Skyrim, поскольку тут появляется папка Source для хранения сгенерированных LOD-файлов. Пока что не добавляйте файлы, если будет предложено.

В Проводнике Windows, откройте новую созданную директорию и добавьте следующие папки:

 \current\Source\scripts
 \current\Source\DialogueViews
 \scripts

Скопируйте все содержимое вашей папки ''Skyrim\Data\Scripts\Source'' в поддиректорию ''\current\Source\scripts''. Это должны быть сотни .psc файлов и поддиректорий для каждого DLC. Если вы используете собственный префикс для своего проекта, вам нужно указать его в Creation Kit в разделе Preferences. Не переименовывайте скриптовые фрагменты вручную, даже через Creation Kit.

Обновите ваш Perforce Client (функция Refresh) и вы должны увидеть новые поддиректории и файлы. ПКМ по папке ''scripts'' и выберите '''Add'''. Он должен поместить ваши файлы в список изменений (''англ.'' changelist). Затем, снова ПКМ и нажмите '''Submit''' чтобы зафиксировать эти изменения в депо. Вам нужно добавить комментарий, тут можно писать все что угодно.

Далее, нужно установить плагин '''Microsoft Office''' для Perforce. Убедитесь в получении последней версии из поддерживаемых - для Office выше версии 2007. Этот пакет содержит ''P4COM.dll'', необходимый для Creation Kit файл, позволяющий ему "общаться" с Perforce так же, как и некоторые другие библиотеки/dll. Устанавливая его с параметрами по-умолчанию зарегистрирует все соответствующие файлы и устранит разрыв между вашим Creation Kit и Perforce Server.

[https://www.perforce.com/product/components/perforce-plugin-microsoft-office Скачать можно здесь].

После этого перезагрузите компьютер.

Теперь у вас должна быть возможность загрузить Creation Kit и перейти в '''Preferences'''. В самом конце будет вкладка для интеграции Perforce, где вы можете выбрать ваше новое рабочее пространство. Убедитесь, что ваше имя пользователя (англ. username) корректное, выберите его, и нажмите '''Apply'''.

Чтобы убедиться в правильной полнофункциональной установке, при открытии меню '''Version Control''', что с левого края, блок с '''Papyrus Scripts''' больше не будет серым. Вместо этого, у вас должен быть белый экран с кнопкой '''Select All''', по которой можно нажимать, а так же '''Check In'''/'''Undo Check Out''' кнопки серые (недоступны).

Однако, описанного выше не совсем достаточно для проверки корректной установки. Если есть Perforce и библиотека ''P4COM.dll'' зарегистрирована, то описанное выше будет выглядеть так. Для проверки может ли Creation Kit читать ваше депо ''TESVData'', перейдите в меню ''Gameplay > Papyrus Script Manager'' в Creation Kit и нажмите Open. Для загрузки может потребоваться несколько секунд. Для большинства скриптов в менеджере, должно быть написано "Yes" в обеих колонках "Compiled" и "Has Source". Менеджер всегда должен так выглядеть (если вы корректно извлекли файлы из ''scripts.rar'' в верную директорию) но если ''P4COM.dll'' не зарегистрирован или или что-то ещё пошло не так, то Creation Kit не сможет найти исходники скриптов (''англ.'' Source).

== Решение проблем ==
==== Ошибки ====
<source lang="html4strict">
MASTERFILE: File index # is invalid. Clamping to ##. Does a master file depend on more than one master?</source>
Написанное выше является серьезной ошибкой, когда есть активный .esp файл с более чем тремя мастер-файлами .esm (включая ''Skyrim.esm''). Если это проигнорировать, то он испортит оба, как .esm файл, в который вы хотите влить изменения, а так же и .esp файл, изменения из которого вы хотите влить. Есть возможность обойти эту оишбку, позволяя использовать один или более дополнительных мастер-файлов до тех пор, пока все мастер-файлы из пункта 02 или ниже не имеют пересекающихся форм. Лучшим вариантом будет вручную перенумеровать формы в вашем четвертом мастер-файле на более высокий промежуток значений formid, например на ''XX600000+'' или ''XX7000000+'' в программе '''TES5Edit''' до разработки.

Следующая ошибка сообщает, что интеграция Perforce не настроена. И указывает что Creation Kit будет возвращаться к коду по-умолчанию для присоединения новых formid скриптовым фрагментам, удаляя оригинальные версии без создания резервных копий. Её можно смело игнорировать, но не забывайте делать резервные копии вручную.:
<source lang="html4strict">
Unable to initialize PerForce, check your logs for more information.</source>

Ошибка ниже указывает, чтоу вас должна быть директория scripts в корне вашего рабочего пространства. Это не та же директория, что для исходников скриптов - её назначение не очень ясно, но возможно это площадка для обновлений formid.
<source lang="html4strict">Perforce workspace does not contain a script folder, Papyrus scripts will not be checked in or out.</source>

== {{Notes}} ==
* Для вливания форм ''Navmesh (NAVM)'', ''NavMeshInfoMap (NAVI)'' в ''Skyrim.esm'' должен так же быть влит.

== {{See Also}} ==
*[[Data file]]
*[[Creating Custom Master Files]]