48 lines
2.5 KiB
Markdown
48 lines
2.5 KiB
Markdown
# FParkan
|
|
|
|
Open source проект с реализацией компонентов игрового движка игры **«Паркан: Железная Стратегия»**.
|
|
|
|
## Описание
|
|
|
|
Проект находится в активной разработке и включает:
|
|
|
|
- библиотеки для работы с форматами игровых архивов;
|
|
- спецификации форматов и сопутствующую документацию.
|
|
|
|
## Установка
|
|
|
|
Проект находится в начальной стадии, подробная инструкция по установке пока отсутствует.
|
|
|
|
## Документация
|
|
|
|
- локально: каталог [`docs/`](docs)
|
|
- сайт: <https://fparkan.popov.link>
|
|
|
|
## Библиотеки
|
|
|
|
- [crates/nres](crates/nres) — библиотека для работы с файлами архивов NRes (чтение, поиск, редактирование, сохранение).
|
|
- [crates/rsli](crates/rsli) — библиотека для работы с файлами архивов RsLi (чтение, поиск, загрузка/распаковка поддерживаемых методов).
|
|
|
|
## Тестирование
|
|
|
|
Базовое тестирование проходит на синтетических тестах из репозитория.
|
|
|
|
Для дополнительного тестирования на реальных игровых ресурсах:
|
|
|
|
- используйте оригинальную копию игры (диск или [GOG-версия](https://www.gog.com/en/game/parkan_iron_strategy));
|
|
- разместите игровые каталоги в [`testdata/`](testdata);
|
|
- игровые ресурсы в репозиторий не включаются, так как защищены авторским правом.
|
|
|
|
## 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)**.
|