Документация движка FOnline
Это главная страница пользовательской документации переиспользуемого движка FOnline. Она предназначена для разработчиков игр, авторов инструментов, релиз-инженеров и разработчиков движка, работающих с отдельной копией Engine без документации другого игрового проекта.
С чего начать
- Начало работы знакомит нового разработчика с репозиторием, поддерживаемыми процессами и границей ответственности движка и проекта.
- Первый headless-проект FOnline настраивает, собирает и запускает минимальный проверенный сервер.
- Первый игровой клиент добавляет подключённый настольный клиент, загрузку карты и управляемое сервером взаимодействие.
- Первое изменение контента проводит локализованные данные прототипа через запекание и runtime-поиск.
- Первый автоматизированный тест добавляет проверки метаданных, серверного контента и результата, видимого клиенту.
- Минимальный проект и минимальный многопользовательский проект являются принадлежащими движку исполняемыми исходниками учебных материалов.
Сборка и выпуск игры
- Подключение Engine к проекту определяет границу репозитория между игрой и закреплённой ревизией движка.
- Конфигурация проекта описывает
.fomain, пакеты ресурсов, sub-config, переопределения и проверку. - Процесс сборки описывает пресеты, зависимости, выбор цели и обычный цикл настройки и сборки.
- Процесс генерации задаёт порядок codegen, скриптов, ресурсов, метаданных, документации и артефактов сайта.
- Матрица поддержки разделяет проверенные, smoke-проверенные, доступные в исходниках, экспериментальные и неподдерживаемые комбинации.
- Упаковка и выпуск определяет объявления пакетов, payload, происхождение, границы подписания, приёмку, публикацию и откат.
- Безопасность и секреты, релизные операции и резервное копирование и восстановление описывают переиспользуемые эксплуатационные границы выпуска.
- Обновление движка задаёт сверку полного диапазона ревизий, проверку совместимости, регенерацию и откат.
Создание контента
- Формат прототипов
- Формат карт
- Формат моделей и анимация моделей
- Форматы изображений и спрайтов и корневое движение спрайтов
- Текст и локализация
- Формат эффектов
- Формат и runtime частиц
- Форматы шрифтов и компоновка текста
- Аудио и видео
Каждое руководство ссылается на сгенерированный справочник, если движок владеет декларативной грамматикой или машиночитаемым контрактом. Игра владеет своими каталогами, балансом, заданиями, диалогами, визуальной политикой и политикой локализации.
Устройство среды выполнения
- Архитектура движка и дерево исходников объясняют, где должен находиться код конкретного поведения.
- Модель сущностей и свойств, карты, движение и геометрия, полномочия и сеть и хранение данных — фасад базы, очередь commit, согласованные с backend снимки и журналы восстановления — описывают переиспользуемую модель мира.
- Клиентская среда выполнения, серверная среда выполнения, frontend и рендеринг и разделение клиента и обновление описывают процессы и слой представления.
- Среда выполнения скриптов, скрипты Managed C#, жизненный цикл и конкурентность скриптов, стиль и рефакторинг AngelScript и удалённые вызовы задают переиспользуемый скриптовый контракт.
- Frontend и рендеринг описывает нативные примитивы рендеринга и ввода Engine; высокоуровневые GUI-библиотеки принадлежат проекту.
Инструменты и проверка изменений
- Интерактивное руководство Mapper описывает повседневное редактирование карт, историю, безопасное сохранение и визуальную проверку.
- Инструменты Mapper описывают жизненный цикл Mapper, автоматизацию скриптами, детерминированные снимки и headless-интеграцию.
- Инструменты создания частиц и просмотрщики анимации и частиц описывают сфокусированную визуальную проверку.
- Игровое и интеграционное тестирование, тестирование, отладка и профилирование помогают выбрать достаточные доказательства для изменения.
- Протокол AiControl и исполняемый пример протокола определяют нейтральный к проекту транспорт автоматизации и его границу безопасности.
Справочники
- Приложения перечисляют точки входа исполняемых файлов и библиотек.
- Интерфейс проекта CMake содержит точные параметры, стадии, hooks и доступные проекту helper-функции.
- CLI BuildTools и CLI вспомогательных инструментов содержат полученные из парсеров команды, аргументы, значения по умолчанию, варианты и точный вывод справки.
- Сгенерированные API и метаданные описывают поток аннотаций исходного кода, codegen, сгенерированных моделей и публикации.
- Essentials задаёт нативный фундамент, строгий порядок include, словарь выделения памяти и карту подсистем.
- Индекс публичных контрактов связывает все домены сгенерированных контрактов и их метки стабильности.
- Владение методами Script API группирует нативные экспорты скриптов по стороне выполнения и типу получателя.
- Справочник нативных расширений описывает роли, hooks, fallback и сгенерированные привязки.
- Матрица поддержки платформ фиксирует доказательства для заявлений о поддержке.
Канонические машиночитаемые модели находятся в
Docs/generated/. ИИ-клиентам следует начинать с
llms.txt, использовать
docs-manifest.json для стабильных метаданных
документов и загружать llms-full.txt, только когда
нужен ограниченный самостоятельный корпус.
Сопровождение движка и документации
- Сопровождение документации задаёт владение источниками, сверку ревизий, порядок регенерации и доказательства для рецензирования.
- Процесс перевода задаёт английский источник, русское зеркало, глоссарий, хеши актуальности и паритет кода.
- Публикация сайта определяет
маршрут GitHub Pages/Jekyll, локальный просмотр, собранный артефакт и
production-проверки
fonline.ru. - Управление изменениями контрактов классифицирует изменения сгенерированных моделей и решения по ломающим изменениям.
- Проверка примеров документации и оценка документации для ИИ задают проверки исполняемых примеров, поиска и доказательств.
- Контракты нативного кода и сопровождение сторонних библиотек определяют низкоуровневые правила для разработчиков движка.
Активный production-план и история проверок остаются в
Docs/ProductionDocumentationPlan.md,
Docs/_meta/DocumentationBacklog.md и
Docs/_meta/DocumentationVerificationReport.md
до запланированного переноса в _meta/ с долговечными редиректами.
Граница ответственности
Документация движка владеет переиспользуемым поведением среды выполнения, инструментами, сборочными и платформенными контрактами, форматами, сгенерированными API и соглашениями нативного и скриптового кода. Подключающий проект владеет конкретным игровым контентом, правилами продукта, политикой развёртывания, учётными данными сервисов и проектными командами.
Нормативные процедуры Engine должны выполняться из отдельной копии движка и не должны зависеть от файлов Last Frontier, TLA или другого проекта. Внешние проекты могут давать привязанные к ревизии доказательства, но переиспользуемые helpers и регрессионные тесты, на которых основана гарантия Engine, должны находиться в этом репозитории.