[Master_TW_DAR]

Проект BSSR - Bulat Steel Setup Reforged

Что такое BSSR простыми словами ?

BSSR или Bulat Steel Setup Reforged - это проект по перековке с нуля существующей программы-установщика BS_Setup.exe в интересах мода Булатная Сталь.

Конечная цель разработки BSSR

Конечная цель проекта BSSR - заменить BS_Setup.exe, чтобы обеспечить еще больше возможностей по расширяемости мода Булатная Сталь с помощью сабмодов.

Исторические предпосылки для создания BSSR

Спойлер (раскрыть)

Некоторое время назад камрад Leeekaaa заинтересовался, может ли моя программа OpenTWEMP Community Browser помочь в конфигурировании мода Булатная Сталь.
Последовало совместное обсуждение данного вопроса, в результате чего я согласился взяться за решение поднятой проблемы, объединив общие интересы сторон.
Сейчас у меня нет времени на подробный рассказ, поэтому я просто приведу цитату из своего прошлого обсуждения в ЛС, т.к. это наиболее точное разъяснение моего замысла:

Цитата

Насчет темы BS_Setup.

Появились очень интересные мысли на этот счёт:

-) Вероятнее всего я буду проектировать универсальный механизм конфигуратора сабмодов - как часть своей собственной программы.
-) Этот универсальный конфигуратор можно будет запускать как посредством моего приложения, так и отдельно (по желанию пользователя).
-) Универсальность конфигуратора будет заключаться в том, что любой модмейкер сможет персонализировать конфигуратор сабмодов под свой мод.
-) Универсальный конфигуратор можно будет модифицировать без изменения исходного кода (например, с помощью специального конфиг-файла).
-) Разумеется, заинтересованные модмейкеры получат подробную инструкцию, как использовать подобный конфигуратор в собственных целях.
-) Исходный код универсального конфигуратора будет доступен (например, у меня на GitHub) и любой желающий получит возможность улучшать программу.
-) В случае, если что-то будет непонятно, или понадобится что-то улучшить в интересах Вашего проекта - буду готов оказать помощь/поддержку.
-) Исходный код универсального конфигуратора будет принадлежать моему проекту, в то же время любая кастомизация конфигуратора для Булатной Стали - исключительно собственность Вашей команды (для простоты приведу аналогию: движок M2TW принадлежит CA, модификации для M2TW - авторам этих модификаций).

Это может показаться слишком замудренным вариантом, но, как мне кажется, это идеальный вариант, при котором все будут в выигрыше:
-) Каждый из нас будет спокойно заниматься собственным проектом - фактически мы станем проектами-партнерами.
-) Ваши идеи/просьбы/пожелания по поводу возможных дальнейших улучшений будут стимулировать развитие моего проекта.
-) Мои помощь/поддержка по части программирования сделает Ваш мод еще более классным с технической точки зрения.

Однако, возвращаясь с небес на землю, отмечу, что пока затрудняюсь оценить, сколько времени и усилий потребуется для реализации задуманного.
Давайте начнем с чего-то небольшого - так сказать, "одобрите мои смелые начинания" )))

Назначение данной темы

Спойлер (раскрыть)

Я создал данную тему, чтобы:

1) Документировать историю создания данной программы (всевозможные обновления и важные сведения).
2) Подключить к взаимодействию сообщество Булатной Стали уже на раннем этапе развития программы.
3) Увеличить шансы того, что мои наработки сохранит как можно большее количество заинтересованных лиц.

Однако наиболее важная причина связана с желанием публиковать обновления BSSR независимо от сроков релизов мода Булатная Сталь, чтобы команда создателей BS всегда могла сделать выбор в пользу включения в состав Булатной Стали более стабильной или свежей версии BSSR.

Как связаны BSSR и BS_Setup.exe ?

BS_Setup.exe - проверенный временем конфигуратор мода Булатная Сталь, однако является ограниченным в модификации в силу закрытости исходного кода.
BSSR - новый альтернативный конфигуратор мода Булатная Сталь, находится на ранней стадии развития, однако позиционируется как ПО с открытым исходным кодом.
Ожидается, что на определенном этапе своего развития BSSR полностью заменит BS_Setup.exe.

Что такое BSSR техническим языком ?

BSSR - это конфигурационная настройка для мода "Булатная Сталь" поверх утилиты TWEMP.Browser.App.Utilities-CLI.M2TW-Localization-Switcher.exe.
Утилита TWEMP.Browser.App.Utilities-CLI.M2TW-Localization-Switcher.exe - это консольное приложение, основанное на библиотеке M2TW Addons Setup Framework.
M2TW Addons Setup Framework развивается как модуль подключаемого функционала для приложения OpenTWEMP Community Browser в рамках проекта OpenTWEMP.

Текущее состояние развития BSSR

В настоящий момент BSSR реализует следующие возможности:

• Автоматизация переключения локализации для мода путем замены необходимых файлов в режиме командной строки.
  
• Отслеживание хранилища файлов локализации (сабмодов в общем случае) с помощью конфигурационного файла.

Демонстрация BSSR

Для просмотра ссылки Зарегистрируйтесь

Инструкция - Установка BSSR

Спойлер (раскрыть)

1. Скачайте архив с последней версией BSSR (смотрите раздел "Ссылки для скачивания").
2. Распакуйте содержимое архива в корневой каталог мода "Булатная Сталь" (например, на моем ПК это директория "A:\TWEMP\mods\Bulat Steel TW 2.1.5").
3. Используйте для запуска программы пакетный файл "BSSR.bat".

После успешной установки Ваш каталог мода должен содержать:

-) .twemp - домашний каталог BSSR (а также инфраструктуры проекта OpenTWEMP в целом)
-) .twemp\bin - каталог хранения исполняемых двоичных файлов BSSR.
-) .twemp\BSSR-CFG.xml - пользовательский файл конфигурации BSSR.
-) BSSR.bat - сценарий запуска BSSR для конечных пользователей.

Руководство - Конфигурирование BSSR

Спойлер (раскрыть)

После установки BSSR откройте в Вашем текстовом редакторе конфигурационный файл .twemp\BSSR-CFG.xml.

Структура данного файла представляет собой структуру типичного документа на языке разметки XML.

Для того чтобы успешно выполнить конфигурацию BSSR, понадобится указать корректные значения следующих элементов:

SourceDirectoryRelativePath - относительный путь к исходной директории хранилища сабмодов.
DestinationDirectoryRelativePath - относительный путь к целевой директории установки сабмодов.
ModGameLocale - информация о конкретной локализации (сабмоде в общем смысле) для Вашего мода.

Рассмотрим конкретный пример стандартной конфигурации BSSR:

<?xml version="1.0" encoding="utf-8"?>
<ModSubmodsConfiguration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

    <SourceDirectoryRelativePath>..\..\addons</SourceDirectoryRelativePath>

    <DestinationDirectoryRelativePath>..\..\</DestinationDirectoryRelativePath>


    <SupportedLocalizations>
        <ModGameLocale ID="ENG" Title="BULAT STEEL (English)" ContentFolderName="BS_ENG" />
        <ModGameLocale ID="RUS" Title="BULAT STEEL (Russian)" ContentFolderName="BS_RUS" />
    </SupportedLocalizations>

</ModSubmodsConfiguration>

Допустим, что Ваш корневой каталог установки мода (в нашем случае это Булатная Сталь) является

"С:\GAMES\Medieval II Total War\mods\Bulat Steel TW 2.1.5" (далее я буду ссылаться на данный каталог как BS_HOME в целях сокращения).

Пусть Ваши локализации (в общем случае сабмоды) для мода расположены в отдельной директории:

"<BS_HOME>\addons", где каждая конкретная локализация хранится в своем собственном подкаталоге, например:

- "<BS_HOME>\addons\BS_ENG" - локализация для мода на английском языке
- "<BS_HOME>\addons\BS_RUS" - локализация для мода на русском языке

Вернемся к вышеприведенной конфигурации BSSR и разберем элементы, связанные с установкой относительных путей.

Относительные пути (наподобие "..\..\") указываются относительно домашней директории программы TWEMP.Browser.App.Utilities-CLI.M2TW-Localization-Switcher.exe:
"<BS_HOME>\.twemp\bin\TWEMP.Browser.App.Utilities-CLI.M2TW- Localization-Switcher.exe"

Теперь перейдем к непосредственно к элементам конфигурации:

<SourceDirectoryRelativePath>..\..\addons</SourceDirectoryRelativePath>

В данном случае SourceDirectoryRelativePath указывает на "<BS_HOME>\addons"

<DestinationDirectoryRelativePath>..\..\</DestinationDirectoryRelativePath>

В данном случае DestinationDirectoryRelativePath указывает на "<BS_HOME>"

Каждый элемент локализации (сабмода в общем случае) конфигурируется следующим образом:

<ModGameLocale ID="ENG" Title="BULAT STEEL (English)" ContentFolderName="BS_ENG" />

ID - краткое уникальное имя, используемое для интерактивного ввода в программе с целью выбора конкретной локализации.
Title - подробное текстовое описание, которое служит для распознавания той или иной локализации пользователем.
ContentFolderName - имя каталога, который содержит все необходимые файлы для использования конкретной локализации.

В текущем примере файлы английской локализации должны храниться в следующем каталоге:
"<BS_HOME>\addons\BS_ENG"

ПРИМЕЧАНИЕ 1:

Конфигурация BSSR работает только с относительными путями к каталогам!
Помните, что BSSR отслеживает указанные Вами пути каталогов относительно "<BS_HOME>\.twemp\bin\".

ПРИМЕЧАНИЕ 2:

Несколько раз мной упоминалось (в скобках), что конфигурирование BSSR применимо "для сабмодов в общем случае". Что это значит?
Это означает, что если применить мышление мододела конкретно к текущей реализации BSSR, то уже сейчас можно смело вместо локализаций использовать конкретные сабмоды.
Утилите TWEMP.Browser.App.Utilities-CLI.M2TW-Localization-Switcher.exe нет дела до того, что конкретно Вы конфигурируете - это универсальный механизм программы-свитчера.
Однако следует отдать должное - конкретно в данный момент это с практической точки зрения не совсем удобно, т.к. всё-таки программа находится на ранней стадии развития.

Ссылки на скачивание BSSR (для внедрения в мод)

Для просмотра ссылки ЗарегистрируйтесьДля просмотра ссылки ЗарегистрируйтесьДля просмотра ссылки Зарегистрируйтесь
Важная информация для команды BULAT STEEL

Спойлер (раскрыть)

Ниже приведены рекомендации для всех, кто планирует использовать BSSR сейчас и в будущем:

• Мододелы BS, советую первые запуски программы производить на тестовой установке Булатки (обязательно сделайте бэкап каталога data перед запуском программы).
  
• Думаю, что можно дать попробовать потестировать данную программу геймерам, особенно англоязычной аудитории, которая максимально заинтересована в локализации мода.
  
• Приветствуется любая конструктивная обратная связь, я всегда открыт для диалога как с модмейкерами, так и с геймерами.

Дальнейшие планы (2025+)

Спойлер (раскрыть)

Если говорить о дальнейших направлениях разработки, то для меня здесь всё очевидно:

• Исследование внутреннего устройства BS_Setup.exe и структуры сабмодов Булатной Стали.
  
• Реализация BSSR как программы с графическим пользовательским интерфейсом.
  
• Наращивание функционала движка M2TW Addons Setup Framework

Ожидаю, что в декабре у меня появится достаточно свободного времени, чтобы поразмыслить о дальнейшем развитии BSSR и запланировать соответствующие задачи на 2025 год.