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

Разработчику

Сборка

Rust (версия — в rust-toolchain.toml), Windows с тулчейном MSVC. Workspace из семи крейтов:

Крейт Что делает
tes4_read чтение плагинов TES4/TES5 и BSA v103; про TES3 не знает
transform единственный, кто знает записи обеих игр: все правила перевода
tes3_out запись плагина и BSA TES3 через Greatness7/tes3
mesh_convert NIF 20.x → 4.0.0.2, деревья SpeedTree, лица FaceGen, звук, иконки
back2mw CLI, стадии, файловая система, установка
gui окно на egui
lang язык сообщений (русский, английский), общий для всех крейтов; зависимостей нет

Границы между крейтами проверяет тест crates/back2mw/tests/dependency_boundaries.rs. Подробно — Архитектура.

cargo build --release -p back2mw -p gui

Проверки

cargo fmt --all
cargo clippy --workspace --all-targets --all-features -- -D warnings
cargo test   --workspace --all-targets

CI (.github/workflows/ci.yml) прогоняет то же на Ubuntu (окно — на Windows) и ставит esmtool из пакета OpenMW (openmw-cs на Ubuntu 24.04): тесты на синтетике пишут плагин и проверяют его независимым читателем.

Тесты на реальных данных

Игровых файлов в репозитории нет и не будет — ни целиком, ни фрагментами. Тесты на настоящих Oblivion.esm и Morrowind.esm помечены #[ignore] и запускаются явно:

BACK2MW_GAME_DATA='<каталог, где рядом лежат Oblivion.esm, его BSA и Morrowind.esm/.bsa>' \
BACK2MW_OBLIVION_DATA='<папка Data Oblivion>' \
BACK2MW_ESMTOOL='<путь к esmtool.exe>' \
BACK2MW_NIFTEST='<путь к niftest.exe>' \
BACK2MW_BSATOOL='<путь к bsatool.exe>' \
  cargo test --workspace -- --ignored --nocapture
Переменная Смысл
BACK2MW_GAME_DATA один каталог с данными обеих игр (жёсткие ссылки или junction, если игры в разных папках)
BACK2MW_OBLIVION_DATA папка Data Oblivion
BACK2MW_ESMTOOL, BACK2MW_NIFTEST, BACK2MW_BSATOOL инструменты OpenMW
BACK2MW_REQUIRE_ESMTOOL=1 не пропускать проверку esmtool в обычном прогоне
BACK2MW_KEEP_OUTPUT=1 оставить work//output/ теста, чтобы открыть в NifSkope

Тест с внешним инструментом без переменной уходит в пропуск и показывает ok: зелёный прогон за сотые доли секунды значит, что ничего не проверено.

Инструменты проверки. esmtool проверяется по коду возврата; niftest всегда возвращает 0, и ошибку видно только по строке Failed to read в stderr. OpenMW мягче оригинального движка, поэтому его «ок» — необходимое условие, а не достаточное. tes3conv — не независимый оракул: он построен на той же Greatness7/tes3.

Правила кода

  • Комментарии — на английском; doc-комментарий объясняет почему. Кириллица в коде бывает только русской половиной пары lang (и в тестах русского вывода).
  • Всё, что видит пользователь (журнал, замечания, тексты ошибок, вывод консоли), пишется на двух языках через крейт lang: lang::tr!("русский {x}", "english {x}") вместо format!, lang::trw!(f, …) вместо write! в Display, lang::tr("…", "…") для строк без подстановок. Сообщения expect/assert! — пояснения к инвариантам для разработчика, они пишутся по-английски. Тест, проверяющий текст сообщения, сверяет английский (язык по умолчанию); русский — внутри lang::with(Lang::Ru, || …), а не через lang::set: тесты идут параллельно в одном процессе.
  • На данных из файла — никаких unwrap/expect/паник; ошибки разбора — enum с позицией или полем.
  • Детерминированность: одинаковый вход → побайтово одинаковый выход; обход HashMap в вывод — только после сортировки; ID вычисляются, а не раздаются счётчиком.
  • Новая запись Oblivion — декларативная спека в tes4_read/src/records/, перевод — модуль в transform/src/.
  • Таблицы контента — в data/*.tsv, не в коде. На сайте они показываются как есть.
  • Лицензии зависимостей — только разрешительные; GPL и LGPL — никогда.
  • Схему ID (transform/ids.rs) и смещения не менять: это совместимость с сохранениями игроков.

Документация

Сайт собирается Zensical с темой Catppuccin:

pip install -r docs/requirements.txt
python docs/gen_tables.py                 # таблицы из data/*.tsv → docs/_generated/
zensical serve                            # русская версия
zensical serve -f zensical.en.toml        # английская версия

Страницы — docs/ru/ и docs/en/ с одинаковой структурой; конфигурация — zensical.toml (русский) и zensical.en.toml (английский); публикация на GitHub Pages — .github/workflows/docs.yml. Таблицы соответствия на страницах типов включаются из data/*.tsv при сборке, поэтому всегда совпадают с тем, что читает конвертер. Пояснения в этих файлах — русские; английские переводы лежат в docs/notes_en.tsv, и генератор предупреждает о пояснении без перевода. Строки effects этого файла читает и конвертер: это причина выброшенного эффекта в английском журнале, и тест требует её для каждого такого эффекта.