@vnejs/docs 0.2.1

package/plugins/core/vendors.md

@@ -0,0 +1,45 @@
+# plugins/core/vendors/
+
+Пакет: `@vnejs/plugins.core.vendors` · namespace: `VENDORS`
+
+Обёртки над сторонними утилитами: clone, hash, uuid, debounce, дата, скриншот.
+
+## События
+
+| Ключ | Строка | Смысл |
+|------|--------|-------|
+| `UID` | `vne:vendors:uid` | Сгенерировать уникальный идентификатор uuid4. |
+| `HASH` | `vne:vendors:hash` | MD5-хеш объекта (идентификация строки сценария, проверка сохранений). |
+| `DATE` | `vne:vendors:date` | Форматирование timestamp через dayjs. Payload: `{ ts?, format? }`. |
+| `CLONE` | `vne:vendors:clone` | Deep clone через lodash (state, stack, args). |
+| `SCREEN` | `vne:vendors:screen` | Скриншот DOM через html2canvas → webp data URL. Payload: `{ width?, height?, quality?, id? }`. |
+| `DEBOUNCE` | `vne:vendors:debounce` | Вернуть lodash-debounced функцию. Payload: `{ func?, wait?, options? }`. |
+
+## Константы
+
+Нет.
+
+## Параметры
+
+Нет.
+
+## Настройки
+
+Нет.
+
+## Модули
+
+| Модуль | Зона ответственности |
+|--------|----------------------|
+| `vendors` | uid, hash, clone, debounce, date. |
+| `vendors.screen` | html2canvas screenshot; на init помечает media-элементы ignore. |
+
+## Близкие плагины
+
+### plugins/core/
+
+- [system.md](./system.md) — `SYSTEM`: `STARTED`; `CONST.SYSTEM.DOM_IDS.MEDIA` (html2canvas ignore)
+
+### Остальные
+
+— нет

package/plugins/entities/entities.md

@@ -0,0 +1,35 @@
+# plugins/entities/entities/
+
+Пакет: `@vnejs/plugins.entities.entities` · namespace: `ENTITIES`
+
+Регистрирует базовый контракт системы сущностей.
+
+## События
+
+Нет.
+
+## Константы
+
+Нет.
+
+## Параметры
+
+Нет.
+
+## Настройки
+
+Нет.
+
+## Модули
+
+Нет.
+
+## Близкие плагины
+
+### plugins/core/
+
+— нет
+
+### Остальные
+
+— нет

package/plugins/entities/wallet.md

@@ -0,0 +1,47 @@
+# plugins/entities/wallet/
+
+Пакет: `@vnejs/plugins.entities.wallet` · namespace: `WALLET`
+
+Управляет кошельками и валютами: add, set и reset из сценария и событий.
+
+## События
+
+| Ключ | Строка | Смысл |
+|------|--------|-------|
+| `ADD` | `vne:wallet:add` | Событие `ADD` namespace плагина. |
+| `SET` | `vne:wallet:set` | Записать или обновить значение. |
+| `REG` | `vne:wallet:reg` | Зарегистрировать обработчик. |
+| `RESET` | `vne:wallet:reset` | Событие `RESET` namespace плагина. |
+| `CHANGED` | `vne:wallet:changed` | Зафиксировать изменение состояния. |
+
+## Константы
+
+Нет.
+
+## Параметры
+
+| Ключ | Тип | Смысл |
+|------|-----|-------|
+| `CURRENCIES` | `string` | Значение по умолчанию: "CURRENCIES". |
+| `ITEMS` | `object` | Параметр `ITEMS`. |
+
+## Настройки
+
+Нет.
+
+## Модули
+
+| Модуль | Зона ответственности |
+|--------|----------------------|
+| `wallet` | Реестр обработчиков REG. |
+
+## Близкие плагины
+
+### plugins/core/
+
+- [scenario.md](../core/scenario.md) — `SCENARIO`: emitNext, EVENTS.LINE_EXEC_REG
+- [state.md](../core/state.md) — `STATE`: EVENTS.SET, EVENTS.CLEAR
+
+### Остальные
+
+- [entities.md](./entities.md) — базовый namespace `ENTITIES` (родительский пакет)

package/plugins/font/montserrat.md

@@ -0,0 +1,35 @@
+# plugins/font/montserrat/
+
+Пакет: `@vnejs/plugins.font.montserrat` · namespace: `UNKNOWN`
+
+Подключает шрифт Montserrat через CSS @font-face.
+
+## События
+
+Нет.
+
+## Константы
+
+Нет.
+
+## Параметры
+
+Нет.
+
+## Настройки
+
+Нет.
+
+## Модули
+
+Нет.
+
+## Близкие плагины
+
+### plugins/core/
+
+— нет
+
+### Остальные
+
+— нет

package/plugins/platform/android.md

@@ -0,0 +1,38 @@
+# plugins/platform/android/
+
+Пакет: `@vnejs/plugins.platform.android` · namespace: `ANDROID`
+
+На Android скрывает splash screen при старте и закрывает приложение.
+
+## События
+
+Нет.
+
+## Константы
+
+Нет.
+
+## Параметры
+
+Нет.
+
+## Настройки
+
+Нет.
+
+## Модули
+
+| Модуль | Зона ответственности |
+|--------|----------------------|
+| `android` | Обрабатывает STARTED, CLOSE. |
+
+## Близкие плагины
+
+### plugins/core/
+
+- [platforms.md](../core/platforms.md) — `PLATFORMS`: CONST.MOBILE, PARAMS.CURRENT_PLATFORM
+- [system.md](../core/system.md) — `SYSTEM`: EVENTS.STARTED, EVENTS.CLOSE
+
+### Остальные
+
+— нет

package/plugins/platform/electron.md

@@ -0,0 +1,40 @@
+# plugins/platform/electron/
+
+Пакет: `@vnejs/plugins.platform.electron` · namespace: `ELECTRON`
+
+Синхронизирует storage с хостом Electron и перезагружает игру при изменении состояния. Хост раскладывает state: `{module}.json` при group `_`, иначе `{module}/{group}.json`.
+
+## События
+
+Нет.
+
+## Константы
+
+Нет.
+
+## Параметры
+
+Нет.
+
+## Настройки
+
+Нет.
+
+## Модули
+
+| Модуль | Зона ответственности |
+|--------|----------------------|
+| `electron` | Обрабатывает CHANGED, STARTED, CLOSE_BEFORE. |
+
+## Близкие плагины
+
+### plugins/core/
+
+- [platforms.md](../core/platforms.md) — `PLATFORMS`: CONST.ELECTRON, PARAMS.CURRENT_PLATFORM
+- [storage.md](../core/storage.md) — `STORAGE`: EVENTS.CHANGED, EVENTS.SET_ALL, EVENTS.GET_ALL
+- [system.md](../core/system.md) — `SYSTEM`: EVENTS.STARTED, EVENTS.CLOSE_BEFORE, EVENTS.RELOAD, CONST.HOST
+- [vendors.md](../core/vendors.md) — `VENDORS`: EVENTS.DEBOUNCE
+
+### Остальные
+
+— нет

package/plugins/platform/metric.md

@@ -0,0 +1,42 @@
+# plugins/platform/metric/
+
+Пакет: `@vnejs/plugins.platform.metric` · namespace: `METRIC`
+
+Подключает Яндекс.Метрику: цели, параметры и события стека.
+
+## События
+
+| Ключ | Строка | Смысл |
+|------|--------|-------|
+| `GOAL` | `vne.metric.goal` | Событие `GOAL` namespace плагина. |
+| `PARAMS` | `vne.metric.params` | Событие `PARAMS` namespace плагина. |
+
+## Константы
+
+Нет.
+
+## Параметры
+
+| Ключ | Тип | Смысл |
+|------|-----|-------|
+| `YA_COUNTER_ID` | `number` | Значение по умолчанию: 0. |
+
+## Настройки
+
+Нет.
+
+## Модули
+
+| Модуль | Зона ответственности |
+|--------|----------------------|
+| `ya-metrika` | Обрабатывает EMIT, GOAL, PARAMS. |
+
+## Близкие плагины
+
+### plugins/core/
+
+- [stack.md](../core/stack.md) — `STACK`: EVENTS.EMIT
+
+### Остальные
+
+— нет

package/plugins/rpg/damage.md

@@ -0,0 +1,46 @@
+# plugins/rpg/damage/
+
+Пакет: `@vnejs/plugins.rpg.damage` · namespace: `DAMAGE`
+
+Считает итоговый урон через цепочку модификаторов (shift, multiplier).
+
+## События
+
+| Ключ | Строка | Смысл |
+|------|--------|-------|
+| `EMIT` | `vne:damage:emit` | Инициировать действие или цикл. |
+| `CALC_DAMAGE` | `vne:damage:calc_damage` | Событие `CALC_DAMAGE` namespace плагина. |
+
+## Константы
+
+- **`SOURCES.PHYSICAL`** — "physical"
+- **`SOURCES.MAGIC`** — "magic"
+- **`SUBSOURCES.FIRE`** — "fire"
+- **`SUBSOURCES.ICE`** — "ice"
+- **`SUBSOURCES.PIERCING`** — "piercing"
+- **`SUBSOURCES.FIST`** — "fist"
+
+## Параметры
+
+Нет.
+
+## Настройки
+
+Нет.
+
+## Модули
+
+| Модуль | Зона ответственности |
+|--------|----------------------|
+| `damage.calc` | Подмодуль `calc` плагина. |
+| `damage` | Точка входа emit: подготовка и запуск process. |
+
+## Близкие плагины
+
+### plugins/core/
+
+— нет
+
+### Остальные
+
+— нет

package/plugins/rpg/hit.md

@@ -0,0 +1,46 @@
+# plugins/rpg/hit/
+
+Пакет: `@vnejs/plugins.rpg.hit` · namespace: `HIT`
+
+Определяет исход атаки: промах, попадание, крит или крит-промах.
+
+## События
+
+| Ключ | Строка | Смысл |
+|------|--------|-------|
+| `EMIT` | `vne:hit:emit` | Инициировать действие или цикл. |
+| `CALC_CRIT_MISS_CHANCE` | `vne:hit:calc_crit_miss_chance` | Событие `CALC_CRIT_MISS_CHANCE` namespace плагина. |
+| `CALC_ACCURACY` | `vne:hit:calc_accuracy` | Событие `CALC_ACCURACY` namespace плагина. |
+| `CALC_CRIT_CHANCE` | `vne:hit:calc_crit_chance` | Событие `CALC_CRIT_CHANCE` namespace плагина. |
+
+## Константы
+
+- **`STATUS.CRITICAL_MISSED`** — "critical_missed"
+- **`STATUS.MISSED`** — "missed"
+- **`STATUS.HIT`** — "hit"
+- **`STATUS.CRITICAL`** — "critical"
+
+## Параметры
+
+Нет.
+
+## Настройки
+
+Нет.
+
+## Модули
+
+| Модуль | Зона ответственности |
+|--------|----------------------|
+| `hit.calc` | Обрабатывает CALC_CRIT_MISS_CHANCE, CALC_ACCURACY, CALC_CRIT_CHANCE. |
+| `hit` | Точка входа emit: подготовка и запуск process. |
+
+## Близкие плагины
+
+### plugins/core/
+
+— нет
+
+### Остальные
+
+— нет

package/plugins/rpg/skills.md

@@ -0,0 +1,47 @@
+# plugins/rpg/skills/
+
+Пакет: `@vnejs/plugins.rpg.skills` · namespace: `SKILLS`
+
+Логирует жизненный цикл навыков: emit, start и finish.
+
+## События
+
+| Ключ | Строка | Смысл |
+|------|--------|-------|
+| `EMIT` | `vne:skills:emit` | Инициировать действие или цикл. |
+| `EMIT_START` | `vne:skills:emit_start` | Начать процесс. |
+| `EMIT_FINISH` | `vne:skills:emit_finish` | Инициировать действие или цикл. |
+| `CHECK` | `vne:skills:check` | Проверить состояние или наличие ресурса. |
+
+Payload `EMIT`: `{ id?, caster?, target? }`. Lifecycle (`EMIT_START` / `EMIT_FINISH`): `{ skillId?, caster?, target? }`. `caster` — кто применяет навык, `target` — цель.
+
+## Константы
+
+Нет.
+
+## Параметры
+
+| Ключ | Тип | Смысл |
+|------|-----|-------|
+| `TYPES` | `string` | Виды навыков (`damage`, `heal`, …). |
+| `ITEMS` | `object` | Параметр `ITEMS`. |
+
+## Настройки
+
+Нет.
+
+## Модули
+
+| Модуль | Зона ответственности |
+|--------|----------------------|
+| `skills` | Обрабатывает EMIT, EMIT_START, EMIT_FINISH. |
+
+## Близкие плагины
+
+### plugins/core/
+
+- [logs.md](../core/logs.md) — `LOGS`: emitLog
+
+### Остальные
+
+— нет

package/plugins/save/auto.md

@@ -0,0 +1,47 @@
+# plugins/save/auto/
+
+Пакет: `@vnejs/plugins.save.auto` · namespace: `SAVE_AUTO`
+
+Создаёт автосохранения по интервалу или команде сценария.
+
+## События
+
+| Ключ | Строка | Смысл |
+|------|--------|-------|
+| `MAKE` | `vne:autosave:make` | Событие `MAKE` namespace плагина. |
+
+## Константы
+
+| Ключ | Смысл |
+|------|--------|
+| `SAVE_GROUP` | Storage group для автосохранений (`"autosave"`); доступ через `this.CONST.SAVE_AUTO.SAVE_GROUP`. |
+
+## Параметры
+
+| Ключ | Тип | Смысл |
+|------|-----|-------|
+| `DEFAULT_INTERVAL` | `number` | Значение по умолчанию: 300. |
+| `MAX_INDEX` | `number` | Значение по умолчанию: 9. |
+
+## Настройки
+
+| Ключ | Тип | Смысл |
+|------|-----|-------|
+| `INTERVAL` (`vne:autosave:interval`) | `string` | Настройка `vne:autosave:interval` в `shared.settings`. |
+
+## Модули
+
+| Модуль | Зона ответственности |
+|--------|----------------------|
+| `save.auto` | Подмодуль `auto` плагина; `SAVE.CREATE` с `group: "autosave"`. |
+
+## Близкие плагины
+
+### plugins/core/
+
+- [scenario.md](../core/scenario.md) — `SCENARIO`: EVENTS.LINE_EXEC_REG
+- [settings.md](../core/settings.md) — `SETTINGS`: EVENTS.INIT
+
+### Остальные
+
+- [save.md](./save.md) — `SAVE`: EVENTS.CREATE

package/plugins/save/continue.md

@@ -0,0 +1,43 @@
+# plugins/save/continue/
+
+Пакет: `@vnejs/plugins.save.continue` · namespace: `SAVE_CONTINUE`
+
+Ведёт слот «Продолжить»: создание, загрузка и предзагрузка.
+
+## События
+
+| Ключ | Строка | Смысл |
+|------|--------|-------|
+| `MAKE` | `vne:save_continue:make` | Событие `MAKE` namespace плагина. |
+| `LOAD` | `vne:save_continue:load` | Загрузить данные или ресурс. |
+| `PRELOAD` | `vne:save_continue:preload` | Событие `PRELOAD` namespace плагина. |
+
+## Константы
+
+| Ключ | Смысл |
+|------|--------|
+| `SAVE_GROUP` | Storage group для слота continue (`"continue"`); доступ через `this.CONST.SAVE_CONTINUE.SAVE_GROUP`. |
+
+## Параметры
+
+Нет.
+
+## Настройки
+
+Нет.
+
+## Модули
+
+| Модуль | Зона ответственности |
+|--------|----------------------|
+| `save.continue` | Обрабатывает MAKE, LOAD, PRELOAD; слот в `SAVE` с `group: "continue"`. |
+
+## Близкие плагины
+
+### plugins/core/
+
+- [state.md](../core/state.md) — `STATE`: CONST.MIGRATE_STATUS.OK
+
+### Остальные
+
+- [save.md](./save.md) — `SAVE`: EVENTS.GET, EVENTS.CREATE, EVENTS.LOAD, EVENTS.PRELOAD

package/plugins/save/save.md

@@ -0,0 +1,62 @@
+# plugins/save/save/
+
+Пакет: `@vnejs/plugins.save.save` · namespace: `SAVE`
+
+Сохраняет и загружает состояние игры с миграцией и скриншотами.
+
+## События
+
+| Ключ | Строка | Смысл |
+|------|--------|-------|
+| `GET` | `vne:save:get` | Прочитать слот (`{ key, group? }`) из `STORAGE`. |
+| `CLEAR` | `vne:save:clear` | Удалить все слоты модуля `save` в `STORAGE`. |
+| `DELETE` | `vne:save:delete` | Удалить слот (`{ key, group? }`). |
+| `CREATE` | `vne:save:create` | Создать слот (`{ key, group?, withScreenshot? }`). |
+| `KEY` | `vne:save:key` | Событие `KEY` namespace плагина. |
+| `SCREENSHOT` | `vne:save:screenshot` | Сделать скриншот для слота. |
+| `LOAD` | `vne:save:load` | Загрузить слот в `STATE` (`{ key, group? }`). |
+| `PRELOAD` | `vne:save:preload` | Предзагрузить слот (`{ key, group? }`). |
+
+## Константы
+
+Нет.
+
+## Параметры
+
+| Ключ | Тип | Смысл |
+|------|-----|-------|
+| `SCREENSHOT_QUALITY` | `number` | Значение по умолчанию: 0.5. |
+| `SCREENSHOT_WIDTH` | `number` | Значение по умолчанию: 1280. |
+| `SCREENSHOT_HEIGHT` | `number` | Значение по умолчанию: 720. |
+
+События `GET` / `CREATE` / `DELETE` / `LOAD` / `PRELOAD` принимают опциональный `group` и пробрасывают его в `STORAGE`. Конкретные группы задают вызывающие плагины (номер страницы в save view, `autosave`, `continue`).
+
+## Настройки
+
+Нет.
+
+## Модули
+
+| Модуль | Зона ответственности |
+|--------|----------------------|
+| `save.exec` | Подмодуль `exec` плагина. |
+| `save.key` | Обрабатывает KEY, SET, CLEAR. |
+| `save.load` | Обрабатывает LOAD, PRELOAD. |
+| `save.logs` | Обрабатывает GET, KEY, CLEAR, CREATE, …. |
+| `save` | Обрабатывает GET, CLEAR, DELETE, CREATE. |
+| `save.screen` | Подмодуль `screen` плагина. |
+
+## Близкие плагины
+
+### plugins/core/
+
+- [logs.md](../core/logs.md) — `LOGS`: emitLog, CONST.FILTER_FROM_RESULT_OPTIONS
+- [scenario.md](../core/scenario.md) — `SCENARIO`: emitNext, EVENTS.LINE_EXEC_REG
+- [state.md](../core/state.md) — `STATE`: EVENTS.SET, EVENTS.CLEAR, EVENTS.LOAD, EVENTS.PRELOAD, EVENTS.MIGRATE, EVENTS.GET
+- [storage.md](../core/storage.md) — `STORAGE`: EVENTS.GET, EVENTS.SET, EVENTS.RM_ALL, EVENTS.RM
+- [system.md](../core/system.md) — `SYSTEM`: CONST.DOM_IDS.APP
+- [vendors.md](../core/vendors.md) — `VENDORS`: EVENTS.SCREEN
+
+### Остальные
+
+— нет

package/plugins/scales/health.md

@@ -0,0 +1,37 @@
+# plugins/scales/health/
+
+Пакет: `@vnejs/plugins.scales.health` · namespace: `SCALE_HEALTH`
+
+Обрабатывает переполнение и опустошение шкалы здоровья.
+
+## События
+
+Нет.
+
+## Константы
+
+Нет.
+
+## Параметры
+
+Нет.
+
+## Настройки
+
+Нет.
+
+## Модули
+
+| Модуль | Зона ответственности |
+|--------|----------------------|
+| `scales.health` | Подмодуль `health` плагина. |
+
+## Близкие плагины
+
+### plugins/core/
+
+— нет
+
+### Остальные
+
+- [scales.md](./scales.md) — `SCALES`: PARAMS.TYPES

package/plugins/scales/mana.md

@@ -0,0 +1,37 @@
+# plugins/scales/mana/
+
+Пакет: `@vnejs/plugins.scales.mana` · namespace: `SCALE_MANA`
+
+Обрабатывает переполнение и опустошение шкалы маны.
+
+## События
+
+Нет.
+
+## Константы
+
+Нет.
+
+## Параметры
+
+Нет.
+
+## Настройки
+
+Нет.
+
+## Модули
+
+| Модуль | Зона ответственности |
+|--------|----------------------|
+| `scales.mana` | Подмодуль `mana` плагина. |
+
+## Близкие плагины
+
+### plugins/core/
+
+— нет
+
+### Остальные
+
+- [scales.md](./scales.md) — `SCALES`: PARAMS.TYPES