35 lines
4.6 KiB
Markdown
35 lines
4.6 KiB
Markdown
# Документация Faset Engine
|
|
|
|
Актуализировано 18.09.2026 по принятым решениям. Реализация MVP ведётся параллельно с проверками и пользовательским руководством.
|
|
|
|
## Канонические документы
|
|
|
|
- [Manual](manual/index.md) — пользовательское руководство на английском, с приоритетом C++ gameplay и работающих примеров.
|
|
- [IMPLEMENTATION.md](IMPLEMENTATION.md) — результаты проверок и ограничения каждого checkpoint.
|
|
- [PLAN.md](../PLAN.md) — порядок реализации, критерии приёмки MVP и развитие после него; здесь ведётся статус работ.
|
|
- [ARCHITECTURE.md](ARCHITECTURE.md) — принятый стек, контракты и владение данными.
|
|
- [DEPENDENCIES.md](DEPENDENCIES.md) — независимость, выбранные зависимости и версии.
|
|
- [PUBLICATION.md](PUBLICATION.md) — состав публичного репозитория и происхождение материалов.
|
|
|
|
## Исследовательская база
|
|
|
|
- [Индекс исследований](studies/README.md).
|
|
- [Манифест источников](studies/source-manifest.json) — commits, версии и границы изучения.
|
|
- [Карта документации](studies/map/README.md) — локальный интерактивный просмотр, исходники которого входят в Git.
|
|
|
|
Архитектура определяет принятые контракты, PLAN — объём и порядок реализации. Исследования объясняют происхождение решений; отвергнутые варианты остаются историей, неподтверждённые идеи — гипотезами. Исправление противоречия должно затрагивать все текущие описания, включая карту.
|
|
|
|
## Что уже выбрано
|
|
|
|
C++ с последующим Lua; EnTT; Vulkan 1.3, Render Graph и Slang; SDL3; Box2D/Box3D; собственный retained UI редактора с тёмной темой; ImGui для отладки; CMake/Ninja/Clang; JSON authoring и cooked binary; отдельный Player; статический gameplay и DLL/SO-плагины редактора под согласованный SDK; вложенные сцены и overrides; fixed tick и Update/FixedUpdate/LateUpdate.
|
|
|
|
**MCP принадлежит только редактору и его сервисам.** Обычный Blender остаётся внешним инструментом; дополнительный плагин не является модификацией Blender. Сборка первой версии под каждую ОС проверяется на этой ОС.
|
|
|
|
Основной язык движка — **английский**: UI редактора, встроенные команды, диагностика, публичный API и описания CLI/MCP tools. Это не ограничивает Unicode-текст проектов и языки игр. Корневой README ведётся на английском; текущая проектная документация, исследования и карта остаются преимущественно на русском. Локализация редактора запланирована после MVP.
|
|
|
|
## Дальнейшие изменения
|
|
|
|
У изменения контракта должны быть причина, влияние на данные/API и проверяемый результат. Версии библиотек, стандарт C++, минимальные версии ОС и вспомогательные библиотеки фиксируются на M0 как реализационные параметры, а не повторный выбор архитектуры.
|
|
|
|
Различать «изучено в чужом движке», «принято для Faset», «реализовано» и «измерено». Статический анализ исходников не доказывает производительность будущего Faset. Возможности сначала проходят критерии PLAN, затем описываются как реализованные.
|