diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 12 |
1 files changed, 2 insertions, 10 deletions
@@ -1,13 +1,12 @@ # FParkan -Open source проект с реализацией компонентов игрового движка игры **«Паркан: Железная Стратегия»** и набором [вспомогательных инструментов](tools) для исследования. +Open source проект с реализацией компонентов игрового движка игры **«Паркан: Железная Стратегия»**. ## Описание Проект находится в активной разработке и включает: - библиотеки для работы с форматами игровых архивов; -- инструменты для валидации/подготовки тестовых данных; - спецификации форматов и сопутствующую документацию. ## Установка @@ -19,13 +18,6 @@ Open source проект с реализацией компонентов игр - локально: каталог [`docs/`](docs) - сайт: <https://fparkan.popov.link> -## Инструменты - -Вспомогательные инструменты находятся в каталоге [`tools/`](tools). - -- [tools/archive_roundtrip_validator.py](tools/archive_roundtrip_validator.py) — инструмент верификации документации по архивам `NRes`/`RsLi` на реальных файлах (включая `unpack -> repack -> byte-compare`). -- [tools/init_testdata.py](tools/init_testdata.py) — подготовка тестовых данных по сигнатурам с раскладкой по каталогам. - ## Библиотеки - [crates/nres](crates/nres) — библиотека для работы с файлами архивов NRes (чтение, поиск, редактирование, сохранение). @@ -37,8 +29,8 @@ Open source проект с реализацией компонентов игр Для дополнительного тестирования на реальных игровых ресурсах: -- используйте [tools/init_testdata.py](tools/init_testdata.py) для подготовки локального набора; - используйте оригинальную копию игры (диск или [GOG-версия](https://www.gog.com/en/game/parkan_iron_strategy)); +- разместите игровые каталоги в [`testdata/`](testdata); - игровые ресурсы в репозиторий не включаются, так как защищены авторским правом. ## Contributing & Support |