Перейти к содержанию

Графическое приложение и релизы

Крейт gui (бинарь back2mw-gui.exe, egui/eframe) — тонкое окно над библиотекой back2mw. Вся логика вне окна лежит в crates/back2mw и покрыта тестами; окно проверяется руками.

Что показывает окно

Сверху вниз: полоса с переключателем языка RU / EN в правом углу, ряд «Morrowind» (путь + «Обзор…» + статус), ряд «Oblivion», выбор мира и смещения, свёрнутый раздел «Дополнительно», таблица плагинов из Data Oblivion (чекбокс, файл, тип ESM/ESP, «Оригинал»/«Мод», размер, мастера). Внизу — галочки «Собрать файлы в BSA», «Подтянуть цены к Morrowind», «Только собрать в папку результата, не устанавливать», «Ещё zip-архив для раздачи», кнопка «Конвертировать» и справа «Удалить из игры…». Во время работы появляется журнал; по завершении — итог и напоминание, что включить вручную.

Язык

Кнопки RU / EN в правом верхнем углу переключают весь текст окна и язык сообщений библиотеки — журнала, замечаний, ошибок; выбор хранится в config.toml ключом language (ru/en), по умолчанию — английский. Тот же ключ читает консоль (у неё ещё флаг --lang).

Язык один на процесс и живёт в крейте lang: окно и консоль вызывают lang::set, а код пишет обе версии строки рядом — lang.tr("…", "…") в окне, lang::tr!("…", "…", аргументы) и lang::trw!(f, …) в библиотеке. Строки журнала, показанные до переключения, остаются на прежнем языке. Пояснения к выброшенным эффектам берутся из таблиц: русские — из data/effects.tsv, английские — из docs/notes_en.tsv.

Что окно умеет сверх «Конвертировать» (как консоль)

Консоль Окно
--offset dx,dy галочка «Своё смещение» и поля dx/dy под выбором мира; ключ offset = [dx, dy]
all (в игру не пишет) галочка «Только собрать в папку результата»
--morrowind-prices галочка «Подтянуть цены к Morrowind»; ключ morrowind_prices (его читает и консоль)
--lua-map галочка «Карта мира для MWSE» под выбором мира (видна, когда мир выбран); ключ lua_map (его читает и консоль) — см. Карта мира для MWSE
package [--bsa] галочка «Ещё zip-архив» при сборке; или «Упаковать в zip» в «Дополнительно» (BSA — по галочке BSA)
validate «Проверить» в «Дополнительно» (нужны пути к esmtool/niftest)
install «Установить в Data Files» в «Дополнительно»; на чужие файлы — тот же вопрос «перезаписать?»
uninstall «Удалить из игры…» внизу справа (активна, если есть манифест), с подтверждением
--only <EDID> поле «Только записи» (через запятую); не сохраняется, чтобы забытая выборка не урезала следующую сборку
--esmtool, --niftest, --work, --out поля в «Дополнительно»; ключи esmtool, niftest, work_dir, output_dir — те же, что читает консоль. Пустое поле — умолчание (_back2mw-output в папках игр, инструменты — из BACK2MW_ESMTOOL/BACK2MW_NIFTEST)
--config <файл> «Другой…» у «Файл настроек» или back2mw-gui.exe --config <файл> (на время запуска, не запоминается)
  • «Проверить», «Упаковать в zip», «Установить» работают с папкой результата — туда кладёт мод «Только собрать» и консольный all. Проверка вынесена в библиотеку (validate::check_output) и общая с консолью.
  • «Только собрать» перед сборкой очищает папку результата от прежней сборки (плагины, .bsa, папки ассетов, package/), только если там лежит back2mw-assets.tsv — знак, что папка наша; прочие файлы не трогаются. Консольный all папку не чистит.
  • Zip при сборке делается из loose-файлов до упаковки в BSA и кладётся в <папка результата>\package и при установке в игру.
  • Ключи offset и language общие с консолью: она читает их из того же файла (флаги --offset и --lang сильнее). Ключи окна worldspace, build_only, package_zip консоль в файле допускает, но не читает; build_only/package_zip/lua_map пишутся, только когда включены.
  • Проверено запуском 2026-09-26: окно открывается, оба языка отображаются, language и пути сохраняются. Не проверено руками: кнопки «Проверить», «Упаковать», «Установить», «Удалить из игры», сборка с «Только собрать» и со своим смещением. Консольный validate после выноса в библиотеку проверен на dist\output (SEWorld.esp цел, мешей 1 593, брака 0).

Выбор мира (worldspace)

Под заголовком таблицы — выпадающий список «Мир (worldspace)». В нём worldspace отмеченных плагинов, у которых нет родителя (WNAM): города — дочерние worldspace — вливаются в свой мир сами и отдельно не показываются; у мира с городами в подписи их число («SEWorld — Shivering Isles (Oblivion.esm), городов: 5»). Первый пункт — «Не переносить — только объекты», дальше миры по алфавиту EDID (без учёта регистра).

  • Список ищется в фоне после загрузки таблицы (back2mw::worlds, tes4_read::list_worldspaces): читается только группа WRLD, ячейки пропускаются по размеру. У Oblivion.esm — 54 мира за 93 мс (2026-09-26, back2mw/tests/real_worlds.rs), среди них много тестовых (Test*) и квестовых планов Обливиона — они показываются как есть.
  • Выбранный мир даёт плагин <EDID>.esp: ландшафт, регионы, города в тех же ячейках, интерьеры, достижимые дверями, и объекты, которые там стоят (T3.7, T3.9, T6.1). Из плагина с этим миром берутся только такие объекты; остальные отмеченные плагины конвертируются как обычно.
  • Выбор хранится в config.toml ключом worldspace. Консольная версия ключ только допускает: у неё мир задаёт флаг --worldspace. Сняли галочку с плагина мира — выбор сбрасывается.
  • В итоге после конвертации — число внешних ячеек и интерьеров.

Поиск игр и сохранение настроек

  • При запуске сохранённые пути перепроверяются (Data Files\Morrowind.esm, Data\Oblivion.esm); чего нет — ищется в стандартных папках Steam и GOG на всех дисках (detect.rs): типовые …\steamapps\common, SteamLibrary, GOG Games, GOG Galaxy\Games и библиотеки из libraryfolders.vdf. Реестр не читается. Не нашлось — игрок указывает папку сам (корень игры или папка данных).
  • Настройки (source_data, target_data, отмеченные плагины, галочки, мир, смещение, язык, пути из «Дополнительно») пишутся в config.toml рядом с программой, а если туда писать нельзя — в %LOCALAPPDATA%\back2mw. Это тот же файл, что читает консольная версия; чужие ключи при записи не теряются (комментарии — теряются). Путь, который не менялся, остаётся как был записан (в том числе относительный), чтобы переносимая папка оставалась переносимой.

Что делает «Конвертировать»

  1. pipeline::run собирает мод в <Morrowind>\_back2mw-output\stage (с «Только собрать» — сразу в папку результата, и шаг 3 пропускается): читает отмеченные плагины, превращает их записи в записи Morrowind, ищет меши и текстуры (сначала свободные файлы в Data\Meshes, Data\Textures, потом все *.bsa Oblivion из Data — моды, дополнения, Oblivion*; архивы Morrowind в этой папке пропускаются), конвертирует. Каждый отмеченный плагин даёт свой плагин Morrowind с тем же именем (Mod1.esp → Mod1.esp), плагины не сливаются (T1.15).
  2. С галочкой BSA ассеты каждого плагина пакуются в его собственный архив (Mod1.bsa); ассет, нужный двум плагинам, лежит в обоих. Без галочки ассеты остаются общими папками.
  3. install::install копирует результат в Data Files Morrowind и пишет манифест back2mw-install.tsv. Повторная конвертация заменяет прежнюю установку; откат — кнопка «Удалить из игры…» или back2mw.exe uninstall --target-data "<Data Files>".
  4. esmtool/niftest запускаются, только если пути к ним заданы (поле в «Дополнительно», ключ в config.toml или переменная окружения). В отличие от консольного all, без них сборка не падает.

Чужой файл на том же месте — отказ до записи. Morrowind.ini не меняется: плагин и (для BSA) архив включаются вручную.

Ограничения (важно знать)

  • Что берётся из плагина. Что происходит с каждым типом записи — в разделе Типы записей. Без выбранного мира переносятся записи с моделью (предметы, объекты мира, статика, деревья), магия, уровневые списки и существа на донорах; с миром — ещё ячейки, ландшафт, интерьеры, NPC и их диалоги. Модель ищется в свободных файлах Data\Meshes и во всех BSA (моды, дополнения, Oblivion) — мод не обязан нести BSA. Скрипты не переносятся. Меши, которые не удалось прочитать, пропускаются; причины перечислены в замечаниях.
  • Порядок загрузки свой, не игровой (plugins.rs): Oblivion.esm, остальные .esm, оригинальные .esp, моды по имени. Индекс плагина в этом порядке — старший байт абсолютного FormID, из которого выводится строковый ID. У Oblivion.esm индекс всегда 0, его ID стабильны. У модов ID стабильны, пока не меняется набор установленных плагинов: поставили мод, который по имени встаёт раньше, — индексы сдвинулись. Пока это компромисс (Plugins.txt и даты файлов не читаются).
  • Переопределение (мод меняет STAT из Oblivion.esm) заменяет запись: побеждает плагин позже в порядке загрузки. Если EDID при этом изменился, запись пропускается с замечанием.
  • Запись с путём меша не ASCII или с мастером, которого нет в Data, пропускается с замечанием.
  • BSA Morrowind ищет файлы по слабому 64-битному хешу, и на реальных данных он совпадает у разных путей (7 файлов из 7 445 в проверенной установке). Такие файлы остаются отдельными (loose) рядом с архивом; в замечаниях перечислены.
  • Длина путей: MODL и ITEX — всегда не длиннее 31 знака, ob\<имя>_<хеш> (T1.14): длиннее Construction Set обрезает. Каталоги источника в имени файла не сохраняются. Плагины, собранные до 2026-09-24, надо пересобрать.
  • Иконки оружия кладутся в Icons\ob\ (loose) или в архив своего плагина.
  • Мастера плагина Morrowind — Morrowind.esm плюс те его мастера Oblivion, что отмечены в том же прогоне. Мод, сконвертированный без своего мастера, мастера не получает: его переопределения станут отдельными записями, а не заменой.
  • Имена предметов переносятся байт в байт: русский мод (cp1251) даст русские имена в русском Morrowind. esmtool и английская игра покажут их кракозябрами — это не порча.
  • Окно проверено только запуском (не падает, находит игры, пишет настройки); визуально и в игре — не проверялось.

Как выпустить релиз

git tag v0.2.0
git push origin v0.2.0

Тег v* запускает .github/workflows/release.yml на windows-latest: тесты, сборка cargo build --release -p gui -p back2mw и публикация GitHub Release (тег с - в имени — предрелиз). К релизу прикладываются back2mw-<тег>-windows-x64.zip (back2mw-gui.exe, back2mw.exe, README.txt, config.example.toml), оба exe отдельно и SHA256SUMS.txt. Права — contents: write, отдельный токен не нужен.

Список изменений собирает .github/scripts/changelog.sh из коммитов между предыдущим тегом и этим (без слияний) и группирует по семантическому префиксу; заметки — на английском: feat: — «Features», fix: — «Fixes», perf:, refactor:, docs:, test:, build:, ci:, chore:, revert:; область в скобках (fix(gui): …) выделяется, ! (refactor!: …) попадает ещё и в «Breaking changes». Коммит без префикса — в «Other». Версию задаёт только тег: префиксы ни на что, кроме группировки, не влияют. Посмотреть заметки заранее: bash .github/scripts/changelog.sh v0.2.0 (тег должен существовать локально).

Какой workflow что запускает:

Изменение Workflow
код: crates/, data/, Cargo.toml, Cargo.lock, rust-toolchain.toml ci.yml — fmt, clippy, тесты (Linux), окно (Windows)
документация: docs/, zensical*.toml, data/*.tsv docs.yml — сборка сайта и деплой на GitHub Pages
тег v* release.yml — тесты, сборка, релиз

Не проверено: ни один workflow ещё не запускался (в репозитории нет коммитов и remote).