Ship Vendor Framework (SVF) / Система поставщиков кораблей

Фреймворк, позволяющий авторам модов легко добавлять корабли в продажу без конфликтов. Система продажи кораблей, разработанная Bethesda, интересна, но ей не хватает ключевого элемента — гибкости. В оригинальной Starfield после первой загрузки торговца кораблями список предлагаемых им судов фиксируется навсегда — вплоть до начала «Новой игры» (или «Новой игры+»). Мод сам по себе ничего не делает — это фреймворк, который требуется для многих модов. 

Примечание:
Для каких модов требуется данный фреймворк, смотрите на Нексусе в спойлере Mods using this mod

Для этого и создан данный мод. Я разработал систему, благодаря которой авторы модов могут легко добавлять корабли в ассортимент различных торговцев. Это не вызывает конфликтов с другими аналогичными модами и не требует настройки скриптов. Система также обновляет список кораблей у торговца, если обнаруживает изменения в его списках «всегда» или «уникальные». (Инвентарь торговца кораблями состоит из трёх списков: «всегда» / приоритетный, «случайный» и «уникальный»).

Кроме того, авторы модов могут добавлять ключевые слова (keywords) торговцам кораблями — опять же, без конфликтов с другими модами и без использования скриптов. Предусмотрены специальные группы для таргетинга: «все», «не из аванпостов» и «из аванпостов», также можно выбирать конкретных торговцев индивидуально. (Обратите внимание: по умолчанию список торговцев «из аванпостов» включает только основного торговца из оригинальной игры, но можно добавить и других).

Как и в случае с Ship Builder Categories, этот мод задуман как ресурс для сообщества, поэтому пожертвования для него всегда отключены, а участие в системе Donation Points на Nexus Mods не используется.

Для мододелов:
Авторы модов, хотите использовать данный фреймворк? Это легко, и вы можете сделать это всего за три шага:
1. Создайте свой корабль.
2. Добавьте свой корабль в уровневую базовую форму.
3. Поместите эту уровневую базовую форму в список форм и установите один из списков форм, включенных в этот мод (SVF_ShipVendorList_*), в качестве цели в поле «Добавить в список».
Более подробные инструкции включены в документ HOWTO.txt в архиве.

Совместимость:
Этот мод изменяет большинство уровневых списков космических кораблей, которые торговцы используют для добавления соответствующих уровней, а также CF_Post dialogue [QUST:00143472] и CF_Post_Toft_TL_ShipServices scene [SCEN:001F88DD], чтобы лейтенант Джиллиан Тофт могла стать продавцом кораблей после завершения квестовой линии «Багрового флота». Любые другие моды, изменяющие эти записи, могут конфликтовать без патчей.

Кроме того, этот мод изменяет 4 ванильных скрипта: «OutpostShipbuilderMenuActivator», «ShipBuilderMenuActivator», «ShipVendorInfoScript» и «ShipVendorScript». В результате мод, изменяющий любой из этих скриптов, по определению будет конфликтовать. Это также означает, что после обновления игры изменения скриптов, внесённые Bethesda, не будут присутствовать в этом моде до его обновления.

Моды, которые, как известно, конфликтуют:
* «DarkStar» автор WykkydGaming [Creations]: Патча нет. У авторов модов нет списков для добавления кораблей, опция «Rich Ship Vendors» не работает с торговцами из DarkStar, и не все корабли могут быть сразу доступны для покупки, если открыть меню покупки слишком быстро после обновления ассортимента или первоначального создания торговца. (Рекомендуется использовать *DarkStar Astrodynamics*).
* «DarkStar Astrodynamics» автор WykkydGaming [Creations / Nexus]: Используйте патч совместимости `SVF Compatibility Patch - DarkStar Astrodynamics`.
* «Rich Outpost Shipbuilder» автор LilithMotherOfAll [Nexus]: Патча нет. Удалите этот мод, если он у вас установлен. В *Ship Vendor Framework* этот функционал уже встроен по умолчанию.
* «Ship Vendor Fix» автор VollmetalDragon [Creations / Nexus]: Патча нет. Мод не требуется при использовании Ship Vendor Framework, так как вся его функциональность уже встроена.
* «Starvival» автор lKocMoHaBTl [Creations / Nexus]: Используйте патч совместимости `SVF Compatibility Patch - Starvival`.

Моды, для которых я создал патчи (включены в архив мода):
- "DarkStar Astrodynamics" от WykkydGaming [Creations/Nexus]
- "Dominion" от rhart317 [Creations]
- "Falkland Systems Ship Services" от Hjalmere [Creations]
- "Обновление игры «Free Lanes»" (Starfield v1.16.236 и выше) от Bethesda Game Studios [Bethesda.net]
- "Iconic Ships" от ShipTechnician [Creations]
- "L-K Ships" от Lighthorse и KeithVSmith1977 [Creations / Nexus]
- "Lower Landing Pad" от SenterPat [Nexus]
- "Outpost Shipbuilder Unlocked ESM" от goldenchrome [Nexus]
- "Outpost Vendor New Ships" от nefurun [Creations]
- "SGC Deadalus & Battlestar added to New Atlantis & Outpost Ship Vendor" от Rechi03 [Creations]
- "The Den Astrodynamics" от VoodooChild [Nexus]
- "Watchtower" [Creations]

Борьба с повреждением сохранений:
Прежде всего, эта проблема не является уникальной для Ship Vendor Framework — аналогичное поведение встречается и в оригинальном скрипте торговцев кораблями Bethesda. Отличие SVF заключается в том, что фреймворк пытается вовремя предупредить пользователя, а сообщение «Corruption Detected» содержит полезную информацию для диагностики. К сожалению, это лишь половина необходимых данных; вторую половину составляет ваш порядок загрузки (load order). Автору мода необходимы обе детали, чтобы помочь вам вычислить проблемный корабль или конфликтный мод. Если вы получили сообщение «Corruption Detected», не паникуйте! Текущая игровая сессия, к сожалению, испорчена, но вы ведь сохранялись в разные слоты, поскольку это игра от Bethesda и «It Just Works™», верно? В любом случае, последним неповрежденным сохранением скорее всего окажется:

* А) Сохранение перед входом в текущую локацию (если вы играли в рамках одной сессии уже достаточно долго);
* Б) Самое свежее сохранение, с которого вы загрузились (если вы только что запустили игру после установки новых модов).

Технические подробности:
Модифицированный скрипт торговцев в SVF запускает таймер-сторож непосредственно перед попыткой спавна корабля. В нормальных условиях функция спавна завершается менее чем за секунду (обычно около 300 миллисекунд), после чего таймер отменяется до своего срабатывания. Однако если спавнящийся корабль поврежден, функция никогда не завершает работу — это «вешает» скрипт навсегда и приводит к повреждению данных. В этот момент вступает в силу независимый таймер: при долгом зависании он срабатывает и выводит уведомление «Corruption Detected». Идентификаторы «Vendor ID» и «Ship ID» — это обычные шестнадцатеричные FormID, переведенные в десятичную систему счисления. Например, FormID Никау Хендерсона (Nikau Henderson) в шестнадцатеричном формате равен `0027A992`, что соответствует `2599314` в десятичном формате.

Известные проблемы:
* При обновлении этого мода через менеджер, процесс иногда завершается ошибкой без фактического обновления файлов по неизвестным причинам. В связи с этим при обновлении рекомендуется полностью удалить мод и скачать его заново.

Включение журналов:
ПРИМЕЧАНИЕ: Этот раздел применим только к пользователям ПК.

В файле StarfieldCustom.ini убедитесь, что есть следующий раздел с данными:

[Papyrus]
bEnableLogging=1
bEnableProfiling=1
bEnableTrace=1
bLoadDebugInformation=1

Это обеспечит ведение журналов игрой, возможно вам понадобятся эти логи.

Порядок загрузки:
Для достижения наилучших результатов поместите этот мод последним в порядке загрузки, а затем другие моды, у которых он является основным.

Для патчей порядок загрузки должен быть следующим:
- ShipVendorFramework.esm
- (Патчи возможностей SVF, если таковые имеются)
- (Общие патчи SVF, если таковые имеются)
- (Патчи совместимости SVF, если таковые имеются)

Требования:
Starfield 1.11.36 и выше

Установка:
Загрузите и установите архив с помощью менеджеров модов.


Обновление:1.12.0
• Корабли теперь удаляются с использованием метода из Ship Vendor Fix, который включает дополнительные шаги по перемещению корабля в ячейку с мусором и его уничтожению.
• Уровень логирования для `ShipVendorScript` изменен обратно на INFO.

Обновление:1.11.1
* Исправлена ошибка в GitHub Release Action, из-за которой в релизе использовался неверный тег (удалялась буква «v» в начале тега).
* Исправлен патч совместимости для мода Lower Landing Pad".
* Добавлена встроенная поддержка мода "Ship Vendor Fix" от VollmetalDragon — обратите внимание, что Ship Vendor Framework ОБЯЗАТЕЛЬНО должен загружаться после Ship Vendor Fix.

Обновление:1.11.0
Изменения и исправления Торговцев кораблями:
* Удалён патч совместимости для модификации «Корабль "Дедал" из Звёздных Врат и Звёздный Крейсер "Галактика"» (SGC Deadalus and Battlestar), так как он больше не требуется — данный мод теперь напрямую задействует Фреймворк Торговцев Кораблями (Ship Vendor Framework / SVF).
* Увеличено стандартное минимальное количество случайных кораблей в продаже у Жасмин Дюран до 6 (приведено в соответствие с оригинальной игрой).
* Увеличено стандартное максимальное количество случайных кораблей в продаже у Жасмин Дюран до 8 (приведено в соответствие с оригинальной игрой).
* Увеличено стандартное максимальное количество случайных кораблей в продаже у техника кораблей в штабе «Красных Дьяволов» до 2.
* Увеличено стандартное максимальное количество случайных кораблей в продаже у техника кораблей в Клинике до 2.
* Исправлена ошибка, из-за которой покупка определённых типов кораблей всегда приводила к принудительному обновлению ассортимента при следующей загрузке торговца, независимо от того, было ли это оправдано.
Функционал и новые возможности:
* Добавлена возможность динамического добавления ключевых слов (keywords) торговцам через механизмы SVF (это позволяет торговцам, к примеру, продавать больше модулей для кораблей, чем обычно).
* Добавлены плагины-патчи ключевых слов для добавления модулей кораблей из различных модов (и оригинальной игры) различным торговцам.
* Вынесена возможность «Свободные полосы» (Free Lanes) в отдельный патч; документация скорректирована с учётом изменений.
* Добавлен небольшой опциональный патч, скрывающий все настройки фреймворка из меню «Настройки игрового процесса».
* Добавлен сторожевой таймер (watchdog) для проверки повреждения игровой сессии из-за некорректного спавна корабля.
* Патч совместимости для «Астродинамика Тёмной Звезды» (DarkStar Astrodynamics) изменён на патч совместимости из-за изменений в версии 5.0.0; теперь включает скрипт переопределения в соответствующем архиве.
Скрипты и технические исправления:
* Добавлена блокировка с таймаутом в управляющий скрипт: попытка получить запись VDM во время её инициализации будет ожидать завершения инициализации управляющего скрипта.
* Расширены возможности логирования: добавлена запись идентификатора стека (stack ID) и времени, затраченного на выполнение определённых функций.
* Изменён код логирования для централизации форматирования шестнадцатеричных идентификаторов (hex ID).
* Переработаны комментарии и структура кода для повышения читаемости и упрощения обслуживания.
Установка и документация:
* В файл сведений (README) добавлено описание известной проблемы с обновлением мода через интерфейс «Творений» (Creations).
* В установщик FOMOD добавлена опция, позволяющая указать, нужно ли копировать неиспользуемые патчи в подпапку «опциональные» (optional, по умолчанию: включено).
* Обновлено руководство пользователя («How To») с описанием новой функции динамического добавления ключевых слов.
* Добавлен автоматический рабочий процесс GitHub Workflow для автоматической публикации новых версий на GitHub и Nexus Mods.

Обновление:1.10.0
    Изменен стандартный способ генерации случайных кораблей в SVF, теперь он больше похож на стандартный: скрипт будет пытаться генерировать корабли до тех пор, пока не будет достигнуто запрошенное количество или не будут исчерпаны все варианты. Это может немного замедлить работу, особенно на низких уровнях, но обычно это незаметно.
    Добавлена ​​опция управления этим новым поведением в игровом процессе: «Ограничить количество попыток создания случайных кораблей», по умолчанию — «ВЫКЛ».
    Добавлено больше логов для отслеживания установки определенных модов (в частности, модов, которые либо А. известны как конфликтующие, либо Б. имеют предоставленные мной SVF-патчи).
    Исправлена ​​ошибка, из-за которой корабль «Кестраль» не отображался в патче для "Falkland Systems".
    Исправлена ​​ошибка, из-за которой разделитель параметров игрового процесса для "Falkland Systems2 не помечался как «активный», когда соответствующий патч включен.
    Добавлен плагин для скрытия всех параметров игрового процесса 2Ship Vendor Framework" (отдельная загрузка, не включена в основной архив).
    Удалено упоминание в файле readme о моде, которому больше не нужен патч совместимости (спасибо tiberseptm на Nexus Mods за то, что он это заметил и обратил на меня внимание).

Обновление:1.9.0
Сам мод не обновлялся, обновлен только патч для мода "Falkland Systems Ship Services".
- Исправлена ​​ошибка, из-за которой не отображался корабль "Кестраль".
- Исправлена ​​ошибка, из-за которой разделитель в параметрах игрового процесса для "Falkland Systems" не помечался как "активный" при включении этого патча.

Обновление:1.9.0
    Добавлены дополнительные сведения в логи, для облегчения поиска и устранения неисправностей.
    Добавлена ​​Даника Волкова из обновления игры 1.16.236 Free Lanes к торговцам кораблями.
    Добавлен корабль Hellhound (уникальный корабль Багрового флота, доступный после финального квеста) лейтенанту Джиллиан Тофт для игроков, которые поддерживают SysDef.
    Перемещены параметры минимизации/максимизации игровых настроек торговцев из основных патчей (то есть тех, которые я поддерживаю) в основной плагин, чтобы предотвратить ситуации, когда игровые параметры могут быть разделены.
    Обновлена ​​группа параметров настроек данного мода, чтобы она имела правильное название.
    Исправлена ​​ошибка, из-за которой патч DarkStar Astrodynamics некорректно добавлялся в списки форм, как это должно было быть.
    Обновлен патч Starvival для совместимости с версией 12.1.
    Обновлено поведение патча Starvival таким образом, чтобы он пытался использовать встроенный в Starvival способ добавления кредитов торговцам, а затем применял опцию «Богатые торговцы кораблями».
    Пересохранены и повторно экспортированы все плагины в последней версии Creation Kit (v1.16.236).
    Значительно расширен раздел «Добавить корабли поставщику» в документации «Как это сделать», содержит гораздо больше подробностей.

Обновление:1.8.1
- Исправлена ​​ошибка, из-за которой функция `SVF_Control:SVFControlInitialized()` выполняла свою работу недостаточно тщательно, что не позволяло торговцам корректно инициализироваться в определенных специфических ситуациях.
- Скорректирована продолжительность в скрипте торговца на корабле до того, как код объявит тайм-аут в ожидании инициализации `SVF_Control`.
- Немного скорректировано описание плагинов патчей Falklands Systems и Starvival в FOMOD установщике, чтобы добавить версию модов, которые они исправляют (v2 и v11 соответственно) для большей ясности.
- Немного скорректировано описание патча Falklands Systems в FOMOD установщике, чтобы добавить версию, для которой он предназначен (v2), для большей ясности.
- Добавлен параметр в систему создания .BA2 файла, чтобы созданные файлы .BA2 не очищались автоматически.

Обновление:1.8.0
- Обновлен патч для Falkland Systems, добавлен корабль "Kestrel", представленный во второй версии.
- Исправлен порядок настроек игры в патче для творения "Watchtower".
- Добавлено изображение для отображения списков для творения "Watchtower".

Обновление:1.7.0
- Добавлен патч для творения "Watchtower".

Обновление:1.6.1
- Исправлена ​​ошибка, из-за которой патчи для модов DarkStar Astrodynamics и The Den Astrodynamics всегда изначально выбирались в установщике FOMOD.
- Исправлено регулярное выражение для преобразования изображений Markdown в BBCode.

Обновление:1.6.0
Основной мод:
– Реализована концепция «Карты данных поставщиков», что позволило максимально снизить вероятность конфликтов в моде и, как следствие, удалить все прямые правки записей данных о поставщиках.
– Лейтенант Джиллиан Тофт на «Бдительности» будет назначена поставщиком кораблей после завершения квестовой цепочки «Багровый флот» (изменяет диалог `CF_Post` `[QUST:00143472]` и сцену `CF_Post_Toft_TL_ShipServices` `[SCEN:001F88DD]`).
– Добавлена ​​игровая опция, позволяющая восстанавливать уникальные корабли после покупки, вместо того, чтобы делать это разово.
– Добавлена ​​игровая опция «Богатые поставщики кораблей». Количество кредитов у продавцов кораблей контролируется другим игровым параметром.
- Добавлены игровые параметры для управления минимальным и максимальным количеством кораблей в категории «случайных», которые продавец кораблей попытается продать.
- Добавлено больше переменных кэширования для минимизации вызовов потенциально дорогостоящих внешних функций.
- Добавлены проверки работоспособности (с сообщениями в случае неудачи) для поддержки новых методологий и записей без конфликтов.
- Добавлено всплывающее сообщение, которое появляется при обращении к продавцу кораблей до того, как он будет готов, и ещё одно всплывающее сообщение, которое появляется, когда продавец будет готов.
- Изменён способ отслеживания уникальных кораблей, чтобы они отслеживались у всех продавцов.
- Доработано единообразие стиля во всех скриптах.
- Вспомогательные скрипты обновлены для использования собственной внутренней функции журналирования.
- Добавлено множество комментариев в код для прояснения деталей и (надеюсь) упрощения понимания некоторых фрагментов логики.
- Удалён код события OnInit из скрипта SVF_Control для большей ясности.
- Переработаны уровни ведения журнала для большей схожести с другими языками.
- Исправлена ​​ошибка, из-за которой ShipVendorScript мог попытаться зарегистрироваться для удалённого события по переменной, которая была равна None.
Патчи:
* При обновлении обязательно удалите все предыдущие патчи ексли вы их устанавливали, так как некоторые патчи больше не нужны, патчи начинаются на SVF-
- Добавлен патч для DarkStar Astrodynamics.
- Обновлен патч для Falkland Systems Ship Services для использования концепции «Карты данных поставщиков».
- Обновлен патч для Lower Landing Pad для использования концепции «Карты данных поставщиков».
- Обновлен патч для DLC Shattered Space для использования концепции «Карты данных поставщиков».
- Обновлен патч для Starvival.
- Исправлен патч для The Den Astrodynamics для удаления нескольких ошибочно добавленных кораблей.
- Удалены ненужные патчи совместимости «Generic».
- Удален ненужный патч Lower Landing Pad (Unlocked).

Журнал изменений:
Все изменения и обновления всех предыдущих версий читайте в файле Ship Vendor Framework.txt в архиве в папке Docs