@vnejs/docs 0.2.16 → 0.2.18

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (11) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/README.md +1 -0
  3. package/architecture.md +10 -1
  4. package/manifest.json +4 -0
  5. package/package.json +2 -1
  6. package/plugins/views/settings.md +1 -1
  7. package/plugins/views.screens/eula.md +1 -0
  8. package/plugins/views.screens/gallery.md +1 -1
  9. package/plugins/views.screens/mainmenu.md +4 -1
  10. package/plugins/views.screens/save.md +1 -1
  11. package/plugins/views.screens/settings.md +1 -1
package/CHANGELOG.md ADDED
@@ -0,0 +1,11 @@
1
+ # Changelog
2
+
3
+ Краткая история изменений плагинов и внешнего API. Версии — релизы пакета `@vnejs/docs`.
4
+
5
+ ## 0.2.18
6
+
7
+ - `views.screens/mainmenu` — вертикальные стрелки в модуле `mainmenu.controller.arrows` на `@vnejs/module.controller.arrows.vertical`; индекс в стейте `currentArrowVerticalItem` (ACCEPT читает его, не `currentItem` базы). Кнопки `ACCEPT` / `INTERACT` и хендлер `ACCEPT` → `CLICK` в `mainmenu.controller.accept` на `@vnejs/module.controller.accept` (зеркало `STATE_UPDATE`). `mainmenu.controller` пушит пустой `controls` на `ZINDEX`, чтобы стопорить слои ниже. `STATE.SET` / `STATE.CLEAR` эмитят `HIDE` с `{ isForce: true }` из модуля `mainmenu.hide` на `@vnejs/module.controller.hide.on.state`. Accept / arrows / backgrounds больше не слушают `STATE.SET` / `STATE.CLEAR` напрямую — только `HIDE`.
8
+ - `views/settings` — горизонтальная навигация TextControls: стрелки циклят `options` (`selector_texts` сразу `SETTINGS.SET`), `INTERACT` для `actions` без `settingKey`.
9
+ - `views.screens/settings` — overlay-BGM на SHOW стартует с громкостью `SETTINGS.MUSIC.VOLUME`.
10
+ - `views.screens/gallery` — overlay-BGM на SHOW стартует с громкостью `SETTINGS.MUSIC.VOLUME`.
11
+ - `views.screens/save` — overlay-BGM на SHOW стартует с громкостью `SETTINGS.MUSIC.VOLUME`.
package/README.md CHANGED
@@ -28,6 +28,7 @@ npm i @vnejs/docs
28
28
  - [Сценарий — guide](./scenario.guide/README.md) — синтаксис `.vne` и тематические гайды
29
29
  - [Сценарий — catalog](./scenario.catalog/README.md) — каталог `$` / `%` команд
30
30
  - [Архитектура](./architecture.md) — каталоги монорепы и их связи, mermaid-диаграммы
31
+ - [Changelog](./CHANGELOG.md) — изменения плагинов и API по версиям `@vnejs/docs`
31
32
 
32
33
  ## Быстрый ориентир по монорепе
33
34
 
package/architecture.md CHANGED
@@ -136,6 +136,9 @@ flowchart TD
136
136
  MCT["@vnejs/module.controller.tabs"]
137
137
  MCP["@vnejs/module.controller.preload"]
138
138
  MCB["@vnejs/module.controller.backgrounds"]
139
+ MCAC["@vnejs/module.controller.accept"]
140
+ MCAV["@vnejs/module.controller.arrows.vertical"]
141
+ MCHS["@vnejs/module.controller.hide.on.state"]
139
142
  MSC["@vnejs/module.scales.common"]
140
143
 
141
144
  M --> MC
@@ -148,6 +151,9 @@ flowchart TD
148
151
  MC --> MCT
149
152
  MC --> MCP
150
153
  MC --> MCB
154
+ MC --> MCAC
155
+ MC --> MCAV
156
+ MC --> MCHS
151
157
  MC --> MSC
152
158
  MCO --> ML
153
159
  ```
@@ -165,7 +171,10 @@ flowchart TD
165
171
  | **`@vnejs/module.controller.audio`** | Overlay-BGM для view-экранов: pause global / play `view` / resume на SHOW/HIDE/PRELOAD |
166
172
  | **`@vnejs/module.controller.tabs`** | Навигация по вкладкам view-экранов: TAB_PREV/TAB_NEXT → `TAB_SET`, PUSH/POP controls на SHOW/HIDE |
167
173
  | **`@vnejs/module.controller.preload`** | Предзагрузка меток и событий экрана по SHOW / PRELOAD / MEMORY.CLEARED; SHOW/HIDE/PRELOAD задаёт плагин |
168
- | **`@vnejs/module.controller.backgrounds`** | Ротация списка фонов по SHOW / таймеру / MEMORY.CLEARED; стоп на HIDE и STATE.SET/CLEAR; события и список задаёт плагин |
174
+ | **`@vnejs/module.controller.backgrounds`** | Ротация списка фонов по SHOW / таймеру / MEMORY.CLEARED; стоп на HIDE; события и список задаёт плагин |
175
+ | **`@vnejs/module.controller.accept`** | ACCEPT / INTERACT → событие ACCEPT плагина; PUSH/POP controls на SHOW/HIDE |
176
+ | **`@vnejs/module.controller.arrows.vertical`** | ARROW_UP / ARROW_BOTTOM по видимым пунктам; PUSH/POP controls на SHOW/HIDE |
177
+ | **`@vnejs/module.controller.hide.on.state`** | STATE.SET / STATE.CLEAR → emit HIDE плагина (`isForce` задаёт наследник) |
169
178
  | **`@vnejs/module.scales.common`** | База для scales / RPG-модулей |
170
179
 
171
180
  ### Принципы
package/manifest.json CHANGED
@@ -39,6 +39,10 @@
39
39
  "architecture": {
40
40
  "path": "architecture.md",
41
41
  "role": "Monorepo architecture (read rarely for scenario authoring)"
42
+ },
43
+ "changelog": {
44
+ "path": "CHANGELOG.md",
45
+ "role": "Plugin and API changes by @vnejs/docs version"
42
46
  }
43
47
  }
44
48
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vnejs/docs",
3
- "version": "0.2.16",
3
+ "version": "0.2.18",
4
4
  "description": "VNEJS documentation for engine consumers and coding agents",
5
5
  "files": [
6
6
  "*.md",
@@ -13,6 +13,7 @@
13
13
  "./package.json": "./package.json",
14
14
  "./manifest.json": "./manifest.json",
15
15
  "./README.md": "./README.md",
16
+ "./CHANGELOG.md": "./CHANGELOG.md",
16
17
  "./architecture.md": "./architecture.md",
17
18
  "./plugins/*": "./plugins/*",
18
19
  "./scenario.guide/*": "./scenario.guide/*",
package/plugins/views/settings.md CHANGED
@@ -37,7 +37,7 @@
37
37
 
38
38
  | Модуль | Зона ответственности |
39
39
  |--------|----------------------|
40
- | `settings.fields.controller` | `SHOW`/`HIDE`/`TAB_SET`; `ARROW_*` / `INTERACT`→применить option/toggle; `SETTINGS.SET`. `ACCEPT` не обрабатывает — оставляют экраны. |
40
+ | `settings.fields.controller` | `SHOW`/`HIDE`/`TAB_SET`; `ARROW_UP`/`ARROW_BOTTOM` по полям. На `selector_texts` / `actions` (`options`): `ARROW_LEFT`/`ARROW_RIGHT` циклят `currentItemInner` (modulo); у `selector_texts` сразу `SETTINGS.SET`. `INTERACT` — option value или named action (в т.ч. `actions` без `settingKey`). `ACCEPT` не обрабатывает — оставляют экраны. |
41
41
  | `settings.fields.view` | Обёртка `<View {...propsView} />` (fade show/hide); внутри вкладки `<SettingsTabContent />` с `PositionBox opacity` для crossfade по `tabKey`. |
42
42
 
43
43
  ## Близкие плагины
package/plugins/views.screens/eula.md CHANGED
@@ -22,6 +22,7 @@
22
22
 
23
23
  | Ключ | Тип | Смысл |
24
24
  |------|-----|-------|
25
+ | `ENABLED` | `boolean` | Показывать экран при `MAINMENU.SHOW`; по умолчанию `false`. |
25
26
  | `LANGS` | `string` | Значение по умолчанию: "LANGS". |
26
27
 
27
28
  ## Настройки
package/plugins/views.screens/gallery.md CHANGED
@@ -49,7 +49,7 @@ ACCEPT/INTERACT эмитит `CHOOSE` только для выбранного
49
49
 
50
50
  | Модуль | Зона ответственности |
51
51
  |--------|----------------------|
52
- | `gallery.controller.audio` | Наследник `ModuleControllerAudio`: SHOW/HIDE/PRELOAD → pause global, play/stop `view`-трека; `VOLUME_SETTING = MUSIC.VOLUME`; при `VOLUME_CHANGED` / смене `VOLUME_SETTING` — повторный `AUDIO.VOLUME`. |
52
+ | `gallery.controller.audio` | Наследник `ModuleControllerAudio`: SHOW/HIDE/PRELOAD → pause global, play/stop `view`-трека; `VOLUME_SETTING = MUSIC.VOLUME`; SHOW передаёт в `AUDIO.PLAY` уже посчитанный `volume`; при `VOLUME_CHANGED` / смене `VOLUME_SETTING` — повторный `AUDIO.VOLUME`. |
53
53
  | `gallery.controller` | Обрабатывает UPDATE, HIDE, TAB_SET, …. ACCEPT/INTERACT → `CHOOSE` только если слот открыт. |
54
54
  | `gallery.controller.tabs` | Наследник `ModuleControllerTabs`: TAB_PREV/TAB_NEXT → `TAB_SET`; PUSH/POP controls на SHOW/HIDE. |
55
55
  | `gallery` | Обрабатывает OPEN, CHECK, CLEAR. |
package/plugins/views.screens/mainmenu.md CHANGED
@@ -48,7 +48,10 @@
48
48
 
49
49
  | Модуль | Зона ответственности |
50
50
  |--------|----------------------|
51
- | `mainmenu.controller` | Обрабатывает ACCEPT, UPDATE, SHOW, HIDE, STATE_UPDATE, UPDATE_FAST, UPDATE_FORCE, …. |
51
+ | `mainmenu.controller` | Обрабатывает UPDATE, SHOW, HIDE, STATE_UPDATE, UPDATE_FAST, UPDATE_FORCE, …. На SHOW пушит пустой `controls` на `ZINDEX`, чтобы стопорить слои ниже. |
52
+ | `mainmenu.hide` | Наследует `@vnejs/module.controller.hide.on.state`: `STATE.SET` / `STATE.CLEAR` → `HIDE` с `{ isForce: true }`. |
53
+ | `mainmenu.controller.accept` | Наследует `@vnejs/module.controller.accept`: `ACCEPT` / `INTERACT` → `ACCEPT` → `CLICK` по `currentArrowVerticalItem`; зеркалит `STATE_UPDATE`; PUSH/POP на SHOW/HIDE. |
54
+ | `mainmenu.controller.arrows` | Наследует `@vnejs/module.controller.arrows.vertical`: `ARROW_UP` / `ARROW_BOTTOM` по видимым пунктам; PUSH/POP controls на SHOW/HIDE; эмитит `STATE_UPDATE` с `{ currentArrowVerticalItem }` и `UPDATE_FAST`. |
52
55
  | `mainmenu.backgrounds` | Наследует `@vnejs/module.controller.backgrounds`: ротация `BACKGROUNDS`, preload и таймер; эмитит `STATE_UPDATE` и `UPDATE_FAST`. |
53
56
  | `mainmenu.preload` | Наследует `@vnejs/module.controller.preload`: по SHOW / PRELOAD / MEMORY.CLEARED грузит `PRELOAD_LABELS` и `PRELOAD_EVENTS`. |
54
57
  | `mainmenu.scenario` | LINE_EXEC → SHOW, LINE_LOAD → PRELOAD. |
package/plugins/views.screens/save.md CHANGED
@@ -39,7 +39,7 @@ ACCEPT/INTERACT повторяет клик по слоту: на вкладке
39
39
 
40
40
  | Модуль | Зона ответственности |
41
41
  |--------|----------------------|
42
- | `save.controller.audio` | Наследник `ModuleControllerAudio`: SHOW/HIDE/PRELOAD → pause global, play/stop `view`-трека; `VOLUME_SETTING = MUSIC.VOLUME`; при `VOLUME_CHANGED` / смене `VOLUME_SETTING` — повторный `AUDIO.VOLUME`. |
42
+ | `save.controller.audio` | Наследник `ModuleControllerAudio`: SHOW/HIDE/PRELOAD → pause global, play/stop `view`-трека; `VOLUME_SETTING = MUSIC.VOLUME`; SHOW передаёт в `AUDIO.PLAY` уже посчитанный `volume`; при `VOLUME_CHANGED` / смене `VOLUME_SETTING` — повторный `AUDIO.VOLUME`. |
43
43
  | `save.controller` | Обрабатывает UPDATE, HIDE, LOAD, TAB_SET, …. SHOW принимает `{ tab }`; в `SAVE.*` передаёт `group` (номер страницы или `autosave`). ACCEPT/INTERACT: save → `CREATE`, load/autosave → `LOAD` при `screen`. |
44
44
  | `save.controller.tabs` | Наследник `ModuleControllerTabs`: TAB_PREV/TAB_NEXT → `TAB_SET`; `getTabKeys` фильтрует SAVE vs LOAD/AUTOSAVE. |
45
45
  | `save.controller.load` | Подмодуль `controller.load` плагина. |
package/plugins/views.screens/settings.md CHANGED
@@ -38,7 +38,7 @@
38
38
 
39
39
  | Модуль | Зона ответственности |
40
40
  |--------|----------------------|
41
- | `settings.controller.audio` | Наследник `ModuleControllerAudio`: SHOW/HIDE/PRELOAD → pause global, play/stop `view`-трека. |
41
+ | `settings.controller.audio` | Наследник `ModuleControllerAudio`: SHOW/HIDE/PRELOAD → pause global, play/stop `view`-трека; `VOLUME_SETTING = MUSIC.VOLUME`; SHOW передаёт в `AUDIO.PLAY` уже посчитанный `volume`; при `VOLUME_CHANGED` / смене `VOLUME_SETTING` — повторный `AUDIO.VOLUME`. |
42
42
  | `settings.controller` | SHOW/HIDE/TAB_SET; `BACK`/`MENU`/`GAMEMENU` → hide; связка с `SETTINGS_VIEW`. |
43
43
  | `settings.controller.tabs` | Наследник `ModuleControllerTabs`: TAB_PREV/TAB_NEXT → `TAB_SET`; `getTabKeys` по `showInSettings`. |
44
44
  | `settings.view` | Chrome экрана (Screen, tabs, cross); поля и example text — в `SETTINGS_VIEW`. |