Документация VNEJS

Монорепозиторий движка визуальных новелл VNEJS — plugin-архитектура на TypeScript с событийной шиной и композицией через bundles/.

Публикуемый пакет: @vnejs/docs. Установка у потребителя:

npm i @vnejs/docs

Машинное оглавление: manifest.json.

Для агента / автора сценария

Пишете или правите .vne во внешней игре — сначала смотрите сценарные разделы, не архитектуру плагинов.

| Приоритет | Раздел | Когда открывать | |-----------|--------|-----------------| | 1 | scenario.guide/ | Авторские гайды с примерами (вариант B) | | 1 | scenario.catalog/ | Полный индекс команд из SCENARIO_COMMANDS + stubs (вариант C) | | 2 | plugins/ | События, модули, internals плагина | | 3 | architecture.md | Модель монорепы — редко, не для написания реплик |

Сейчас в пакете два параллельных входа для сценария — сравните и выберите удобный. Оба ссылаются на plugins/ за деталями.

Содержание

• Сценарий — guide — синтаксис .vne и тематические гайды
• Сценарий — catalog — каталог $ / % команд
• Архитектура — каталоги монорепы и их связи, mermaid-диаграммы

Быстрый ориентир по монорепе

| Каталог | Роль | | ------------------------------------------------------------- | ---------------------------------------- | | packages/ | Runtime: shared, observer, core, … | | modules_extensions/ | Базовые классы модулей | | configs/ | Общие TypeScript-конфиги | | contracts/ | Публичный API плагина | | plugins/ | Реализация поведения | | compatibility/ | Связка между плагинами | | bundles/ | Сборка набора плагинов для игры | | helpers/ | Утилиты без привязки к движку | | uis/ | React-компоненты для view-плагинов | | cli/ | Сборка монорепы и игр | | games/ | Проекты игр: сценарий, entry, dist | | vs_code_extensions/ | Подсветка .vne в редакторе |

games/ подключает один bundles/ и получает VneCore — точку входа в движок.