diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 60 |
1 files changed, 8 insertions, 52 deletions
@@ -1,55 +1,11 @@ -# FParkan +# Utilities for the game "Parkan: Iron Strategy" -Open source проект с реализацией компонентов игрового движка игры **«Паркан: Железная Стратегия»** и набором [вспомогательных инструментов](tools) для исследования. +This repository contains utilities, tools, and libraries for the game "Parkan: Iron Strategy." -## Описание +## List of projects -Проект находится в активной разработке и включает: - -- библиотеки для работы с форматами игровых архивов; -- инструменты для валидации/подготовки тестовых данных; -- спецификации форматов и сопутствующую документацию. - -## Установка - -Проект находится в начальной стадии, подробная инструкция по установке пока отсутствует. - -## Документация - -- локально: каталог [`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 (чтение, поиск, редактирование, сохранение). -- [crates/rsli](crates/rsli) — библиотека для работы с файлами архивов RsLi (чтение, поиск, загрузка/распаковка поддерживаемых методов). - -## Тестирование - -Базовое тестирование проходит на синтетических тестах из репозитория. - -Для дополнительного тестирования на реальных игровых ресурсах: - -- используйте [tools/init_testdata.py](tools/init_testdata.py) для подготовки локального набора; -- используйте оригинальную копию игры (диск или [GOG-версия](https://www.gog.com/en/game/parkan_iron_strategy)); -- игровые ресурсы в репозиторий не включаются, так как защищены авторским правом. - -## Contributing & Support - -Проект активно поддерживается и открыт для contribution. Issues и pull requests можно создавать в обоих репозиториях: - -- **Primary development**: [valentineus/fparkan](https://code.popov.link/valentineus/fparkan) -- **GitHub mirror**: [valentineus/fparkan](https://github.com/valentineus/fparkan) - -Основная разработка ведётся в self-hosted репозитории. - -## Лицензия - -Проект распространяется под лицензией **[GNU GPL v2](LICENSE.txt)**. +- [unpacker](unpacker): Text-based utility for unpacking game resources in the NRres format. Allows unpacking 100% of game resources. +- [packer](packer): Text-based utility for packing game resources in the NRres format. Allows packing 100% of game resources. +- [texture-decoder](texture-decoder): (WIP) Decoder for game textures. Decodes approximately 20% of game textures. +- [libnres](libnres): _(Deprecation)_ Library for NRes files. +- [nres-cli](nres-cli): _(Deprecation)_ Console tool for NRes files. |