diff options
| author | Valentin Popov <valentin@popov.link> | 2026-06-22 00:58:51 +0300 |
|---|---|---|
| committer | Valentin Popov <valentin@popov.link> | 2026-06-22 00:58:51 +0300 |
| commit | 78fc5f1debf1395d5df0bab7cc0dde54351205cb (patch) | |
| tree | ef8f7c72a183723fcbea0b2d1fefd7c28ca7bc18 /docs/index.md | |
| parent | 50c2cf4686b53ebd2b76318223096660e92305a4 (diff) | |
| download | fparkan-78fc5f1debf1395d5df0bab7cc0dde54351205cb.tar.xz fparkan-78fc5f1debf1395d5df0bab7cc0dde54351205cb.zip | |
docs: rewrite MkDocs documentation
Diffstat (limited to 'docs/index.md')
| -rw-r--r-- | docs/index.md | 58 |
1 files changed, 46 insertions, 12 deletions
diff --git a/docs/index.md b/docs/index.md index 000ea34..2775ed7 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,17 +1,51 @@ -# Welcome to MkDocs +# FParkan -For full documentation visit [mkdocs.org](https://www.mkdocs.org). +FParkan -- самостоятельная техническая книга о восстановлении игрового движка +Iron3D из *Parkan: Iron Strategy*. Она ведёт от запуска оригинальной программы +и карты DLL к форматам ресурсов, загрузке миссии, геометрии, материалам, +рендеру, поведению, звуку, сети и плану чистой совместимой реализации. -## Commands +Сайт оформлен как онлайн-книга: тома читаются последовательно, а справочник +используется как быстрый доступ к форматам, проверочным правилам и границам +доказанного знания. -* `mkdocs new [dir-name]` - Create a new project. -* `mkdocs serve` - Start the live-reloading docs server. -* `mkdocs build` - Build the documentation site. -* `mkdocs -h` - Print help message and exit. +## Как читать -## Project layout +Если вы впервые разбираете игровой движок, начните с тома I и II. Там вводится +лексика, доказательная политика, модульная архитектура и жизненный цикл кадра. - mkdocs.yml # The configuration file. - docs/ - index.md # The documentation homepage. - ... # Other markdown pages, images and other files. +Если нужна реализация совместимого движка, читайте тома III--VII линейно: +ресурсы, миссии, мир, рендер, интерактивные подсистемы и порядок работ. + +Если вы проверяете выводы, переходите к тому VIII и приложениям. Там собраны +уровни уверенности, corpus gates, открытые вопросы и критерии закрытия. + +## Восемь томов + +1. **Путеводитель и методика** -- назначение книги, маршруты чтения, язык + предметной области и правила проверки. +2. **Запуск, архитектура и игровой цикл** -- `iron_3d.exe`, пятнадцать DLL, + сервисы, World3D, очередь объектов и границы кадра. +3. **Ресурсная система и форматы** -- NRes, RsLi, кэши, имена, `objects.rlb`, + unit DAT и сквозное разрешение ресурсов. +4. **Мир, миссии и runtime** -- TMA, ландшафт, ареалы, маршруты, создание мира + и свойства размещённых объектов. +5. **Геометрия, материалы и рендер** -- MSH, анимация, WEAR, MAT0, Texm, FXID, + свет, атмосфера и полный render frame. +6. **Поведение, управление, звук и сеть** -- AI, Behavior, Wizard, Control, + ввод, камера, звук и DirectPlay-слой. +7. **Руководство по полной реализации** -- целевая архитектура, этапы работ, + тестовый контур, точность, скорость и критерий совместимости. +8. **Справочник и доказательная база** -- ABI, конфигурация, статистика + корпусов, границы знания и глоссарий. + +## Политика доказательств + +Специфические утверждения об Iron3D принимаются только после локальной проверки +на исполняемых файлах, DLL, демоверсии, полных каталогах Частей 1 и 2 или на +взаимных инвариантах реальных ресурсов. Внешние описания и текущий код FParkan +могут подсказывать вопросы, но не заменяют проверку. + +Неизвестные поля не получают правдоподобных имён. Пока смысл не закрыт, +документация фиксирует raw layout, границы, безопасное чтение и lossless +сохранение. |
