@vnejs/docs 0.2.1

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 (191) hide show
  1. package/README.md +49 -0
  2. package/architecture.md +507 -0
  3. package/manifest.json +44 -0
  4. package/package.json +27 -0
  5. package/plugins/audio/ambient.md +39 -0
  6. package/plugins/audio/audio.md +61 -0
  7. package/plugins/audio/music.md +39 -0
  8. package/plugins/audio/sound.md +39 -0
  9. package/plugins/audio/voice.md +43 -0
  10. package/plugins/canvas/bg.md +76 -0
  11. package/plugins/canvas/bg.speak.md +54 -0
  12. package/plugins/canvas/fill.md +66 -0
  13. package/plugins/canvas/layer.md +57 -0
  14. package/plugins/canvas/sprite.md +85 -0
  15. package/plugins/canvas/sprite.speak.md +53 -0
  16. package/plugins/canvas/text.md +63 -0
  17. package/plugins/canvas/video.md +71 -0
  18. package/plugins/canvas.layers/bl.md +47 -0
  19. package/plugins/canvas.layers/fl.md +47 -0
  20. package/plugins/canvas.layers/ml.md +47 -0
  21. package/plugins/canvas.layers/ul.md +46 -0
  22. package/plugins/canvas.props/animation.md +48 -0
  23. package/plugins/canvas.props/clip.md +43 -0
  24. package/plugins/canvas.props/filters.md +39 -0
  25. package/plugins/canvas.props/mask.md +44 -0
  26. package/plugins/canvas.props/scale.md +41 -0
  27. package/plugins/controls/controls.md +41 -0
  28. package/plugins/controls/cursor.md +59 -0
  29. package/plugins/controls/gamepad.md +37 -0
  30. package/plugins/controls/keyboard.md +37 -0
  31. package/plugins/core/components.md +47 -0
  32. package/plugins/core/interact.md +45 -0
  33. package/plugins/core/logs.md +46 -0
  34. package/plugins/core/media.md +59 -0
  35. package/plugins/core/memory.md +44 -0
  36. package/plugins/core/platforms.md +48 -0
  37. package/plugins/core/scenario.md +63 -0
  38. package/plugins/core/settings.md +43 -0
  39. package/plugins/core/stack.md +57 -0
  40. package/plugins/core/state.md +51 -0
  41. package/plugins/core/storage.md +89 -0
  42. package/plugins/core/system.md +56 -0
  43. package/plugins/core/vendors.md +45 -0
  44. package/plugins/entities/entities.md +35 -0
  45. package/plugins/entities/wallet.md +47 -0
  46. package/plugins/font/montserrat.md +35 -0
  47. package/plugins/platform/android.md +38 -0
  48. package/plugins/platform/electron.md +40 -0
  49. package/plugins/platform/metric.md +42 -0
  50. package/plugins/rpg/damage.md +46 -0
  51. package/plugins/rpg/hit.md +46 -0
  52. package/plugins/rpg/skills.md +47 -0
  53. package/plugins/save/auto.md +47 -0
  54. package/plugins/save/continue.md +43 -0
  55. package/plugins/save/save.md +62 -0
  56. package/plugins/scales/health.md +37 -0
  57. package/plugins/scales/mana.md +37 -0
  58. package/plugins/scales/scales.md +54 -0
  59. package/plugins/scenario/autoread.md +50 -0
  60. package/plugins/scenario/choose.md +111 -0
  61. package/plugins/scenario/fastforward.md +61 -0
  62. package/plugins/scenario/pause.md +43 -0
  63. package/plugins/scenario/point_and_click.md +95 -0
  64. package/plugins/scenario/qte.md +97 -0
  65. package/plugins/scenario/random.md +38 -0
  66. package/plugins/settings/filter.md +39 -0
  67. package/plugins/settings/potato.md +41 -0
  68. package/plugins/settings/ratio.md +41 -0
  69. package/plugins/settings/textsize.md +39 -0
  70. package/plugins/settings/volume.md +41 -0
  71. package/plugins/text/inject.md +41 -0
  72. package/plugins/text/locs.md +49 -0
  73. package/plugins/text/meet.md +40 -0
  74. package/plugins/text/smooth.md +51 -0
  75. package/plugins/text/text.md +78 -0
  76. package/plugins/text/wall.md +41 -0
  77. package/plugins/time/date.md +42 -0
  78. package/plugins/time/time.md +43 -0
  79. package/plugins/vars/counters.md +46 -0
  80. package/plugins/vars/flags.md +44 -0
  81. package/plugins/vars/vars.md +51 -0
  82. package/plugins/views/achievement.md +64 -0
  83. package/plugins/views/comment.md +49 -0
  84. package/plugins/views/cursor.md +39 -0
  85. package/plugins/views/fps.md +51 -0
  86. package/plugins/views/video.md +57 -0
  87. package/plugins/views.scenario/choose.md +79 -0
  88. package/plugins/views.scenario/interface.controls.md +50 -0
  89. package/plugins/views.scenario/interface.fastforward.md +50 -0
  90. package/plugins/views.scenario/interface.md +68 -0
  91. package/plugins/views.scenario/point_and_click.md +87 -0
  92. package/plugins/views.scenario/qte.md +105 -0
  93. package/plugins/views.screens/confirm.md +48 -0
  94. package/plugins/views.screens/credits.md +46 -0
  95. package/plugins/views.screens/eula.md +54 -0
  96. package/plugins/views.screens/gallery.full.md +48 -0
  97. package/plugins/views.screens/gallery.md +69 -0
  98. package/plugins/views.screens/gamemenu.md +52 -0
  99. package/plugins/views.screens/history.md +70 -0
  100. package/plugins/views.screens/intro.md +50 -0
  101. package/plugins/views.screens/loading.md +48 -0
  102. package/plugins/views.screens/mainmenu.md +61 -0
  103. package/plugins/views.screens/mainmenu.socials.md +45 -0
  104. package/plugins/views.screens/save.md +63 -0
  105. package/plugins/views.screens/settings.defaults.md +51 -0
  106. package/plugins/views.screens/settings.md +53 -0
  107. package/scenario.catalog/README.md +38 -0
  108. package/scenario.catalog/index.md +109 -0
  109. package/scenario.catalog/stubs/achievement.md +16 -0
  110. package/scenario.catalog/stubs/audio.ambient.md +16 -0
  111. package/scenario.catalog/stubs/audio.music.md +16 -0
  112. package/scenario.catalog/stubs/audio.sound.md +16 -0
  113. package/scenario.catalog/stubs/audio.voice.md +16 -0
  114. package/scenario.catalog/stubs/bl.animation.md +18 -0
  115. package/scenario.catalog/stubs/bl.bg.md +18 -0
  116. package/scenario.catalog/stubs/bl.clip.md +18 -0
  117. package/scenario.catalog/stubs/bl.fill.md +18 -0
  118. package/scenario.catalog/stubs/bl.filter.md +18 -0
  119. package/scenario.catalog/stubs/bl.mask.md +18 -0
  120. package/scenario.catalog/stubs/bl.scale.md +18 -0
  121. package/scenario.catalog/stubs/bl.sprite.md +18 -0
  122. package/scenario.catalog/stubs/bl.text.md +18 -0
  123. package/scenario.catalog/stubs/bl.video.md +18 -0
  124. package/scenario.catalog/stubs/choose.block.md +25 -0
  125. package/scenario.catalog/stubs/choose.md +18 -0
  126. package/scenario.catalog/stubs/choose.option.md +24 -0
  127. package/scenario.catalog/stubs/comment.md +17 -0
  128. package/scenario.catalog/stubs/counter.md +21 -0
  129. package/scenario.catalog/stubs/credits.md +17 -0
  130. package/scenario.catalog/stubs/date.md +17 -0
  131. package/scenario.catalog/stubs/fl.animation.md +18 -0
  132. package/scenario.catalog/stubs/fl.bg.md +18 -0
  133. package/scenario.catalog/stubs/fl.clip.md +18 -0
  134. package/scenario.catalog/stubs/fl.fill.md +18 -0
  135. package/scenario.catalog/stubs/fl.filter.md +18 -0
  136. package/scenario.catalog/stubs/fl.mask.md +18 -0
  137. package/scenario.catalog/stubs/fl.scale.md +18 -0
  138. package/scenario.catalog/stubs/fl.sprite.md +18 -0
  139. package/scenario.catalog/stubs/fl.text.md +18 -0
  140. package/scenario.catalog/stubs/fl.video.md +18 -0
  141. package/scenario.catalog/stubs/flag.md +24 -0
  142. package/scenario.catalog/stubs/interface.md +17 -0
  143. package/scenario.catalog/stubs/intro.md +16 -0
  144. package/scenario.catalog/stubs/mainmenu.md +16 -0
  145. package/scenario.catalog/stubs/ml.animation.md +18 -0
  146. package/scenario.catalog/stubs/ml.bg.md +18 -0
  147. package/scenario.catalog/stubs/ml.clip.md +18 -0
  148. package/scenario.catalog/stubs/ml.fill.md +18 -0
  149. package/scenario.catalog/stubs/ml.filter.md +18 -0
  150. package/scenario.catalog/stubs/ml.mask.md +18 -0
  151. package/scenario.catalog/stubs/ml.scale.md +18 -0
  152. package/scenario.catalog/stubs/ml.sprite.md +18 -0
  153. package/scenario.catalog/stubs/ml.text.md +18 -0
  154. package/scenario.catalog/stubs/ml.video.md +18 -0
  155. package/scenario.catalog/stubs/other.md +17 -0
  156. package/scenario.catalog/stubs/pause.md +16 -0
  157. package/scenario.catalog/stubs/point-and-click.block.md +21 -0
  158. package/scenario.catalog/stubs/point-and-click.md +18 -0
  159. package/scenario.catalog/stubs/point-and-click.option.md +20 -0
  160. package/scenario.catalog/stubs/qte.md +16 -0
  161. package/scenario.catalog/stubs/random.md +16 -0
  162. package/scenario.catalog/stubs/random.option.md +16 -0
  163. package/scenario.catalog/stubs/save.auto.md +16 -0
  164. package/scenario.catalog/stubs/save.md +16 -0
  165. package/scenario.catalog/stubs/scenario.md +17 -0
  166. package/scenario.catalog/stubs/settings.defaults.md +16 -0
  167. package/scenario.catalog/stubs/stack.md +18 -0
  168. package/scenario.catalog/stubs/text.meet.md +16 -0
  169. package/scenario.catalog/stubs/text.wall.md +17 -0
  170. package/scenario.catalog/stubs/time.md +17 -0
  171. package/scenario.catalog/stubs/ul.animation.md +18 -0
  172. package/scenario.catalog/stubs/ul.bg.md +18 -0
  173. package/scenario.catalog/stubs/ul.clip.md +18 -0
  174. package/scenario.catalog/stubs/ul.fill.md +18 -0
  175. package/scenario.catalog/stubs/ul.filter.md +18 -0
  176. package/scenario.catalog/stubs/ul.mask.md +18 -0
  177. package/scenario.catalog/stubs/ul.scale.md +18 -0
  178. package/scenario.catalog/stubs/ul.sprite.md +18 -0
  179. package/scenario.catalog/stubs/ul.text.md +18 -0
  180. package/scenario.catalog/stubs/video.md +16 -0
  181. package/scenario.catalog/stubs/wallet.md +17 -0
  182. package/scenario.guide/README.md +82 -0
  183. package/scenario.guide/audio.md +29 -0
  184. package/scenario.guide/canvas.md +46 -0
  185. package/scenario.guide/choose.md +54 -0
  186. package/scenario.guide/dialogue.md +58 -0
  187. package/scenario.guide/flow.md +71 -0
  188. package/scenario.guide/point-and-click.md +35 -0
  189. package/scenario.guide/qte-random.md +51 -0
  190. package/scenario.guide/vars.md +67 -0
  191. package/scenario.guide/views.md +65 -0
@@ -0,0 +1,51 @@
1
+ # plugins/views.screens/settings.defaults/
2
+
3
+ Пакет: `@vnejs/plugins.views.screens.settings.defaults` · namespace: `SETTINGS_DEFAULTS`
4
+
5
+ Экран выбора настроек по умолчанию при первом запуске сценария.
6
+
7
+ ## События
8
+
9
+ | Ключ | Строка | Смысл |
10
+ |------|--------|-------|
11
+ | `UPDATE` | `vne:settings_defaults:update` | Обновить состояние или отображение. |
12
+ | `SHOW` | `vne:settings_defaults:show` | Показать UI или слой. |
13
+ | `HIDE` | `vne:settings_defaults:hide` | Скрыть UI или слой. |
14
+ | `CONFIRM` | `vne:settings_defaults:confirm` | Продвинуть сценарий к следующей строке. |
15
+
16
+ ## Константы
17
+
18
+ Нет.
19
+
20
+ ## Параметры
21
+
22
+ | Ключ | Тип | Смысл |
23
+ |------|-----|-------|
24
+ | `BACKGROUND` | `string` | Значение по умолчанию: "BACKGROUND". |
25
+
26
+ ## Настройки
27
+
28
+ | Ключ | Тип | Смысл |
29
+ |------|-----|-------|
30
+ | `INITED` (`vne:settings_defaults:inited`) | `string` | Настройка `vne:settings_defaults:inited` в `shared.settings`. |
31
+
32
+ ## Модули
33
+
34
+ | Модуль | Зона ответственности |
35
+ |--------|----------------------|
36
+ | `settings.defaults.controller` | Обрабатывает UPDATE, SHOW, HIDE, EXTERNAL_UPDATE, …. |
37
+ | `settings.defaults` | Связь со сценарием: шаг next после завершения действия. |
38
+ | `settings.defaults.view` | Подмодуль `defaults.view` плагина. |
39
+
40
+ ## Близкие плагины
41
+
42
+ ### plugins/core/
43
+
44
+ - [components.md](../core/components.md) — `COMPONENTS`: EVENTS.EXTERNAL_UPDATE
45
+ - [memory.md](../core/memory.md) — `MEMORY`: EVENTS.CLEARED
46
+ - [scenario.md](../core/scenario.md) — `SCENARIO`: emitNext, EVENTS.LINE_EXEC_REG, CONST.LINE_KEYWORDS.SKIP_IF_POSSIBLE
47
+ - [settings.md](../core/settings.md) — `SETTINGS`: EVENTS.CHANGED, EVENTS.INIT, EVENTS.SET
48
+
49
+ ### Остальные
50
+
51
+ - [settings.md](./settings.md) — `SETTINGS_VIEW`: PARAMS.TABS
@@ -0,0 +1,53 @@
1
+ # plugins/views.screens/settings/
2
+
3
+ Пакет: `@vnejs/plugins.views.screens.settings` · namespace: `SETTINGS_VIEW`
4
+
5
+ Экран настроек с вкладками и полями toggle, range и списками значений.
6
+
7
+ ## События
8
+
9
+ | Ключ | Строка | Смысл |
10
+ |------|--------|-------|
11
+ | `SHOW` | `vne:settings_view:show` | Показать UI или слой. |
12
+ | `HIDE` | `vne:settings_view:hide` | Скрыть UI или слой. |
13
+ | `UPDATE` | `vne:settings_view:update` | Обновить состояние или отображение. |
14
+ | `PRELOAD` | `vne:settings_view:preload` | Событие `PRELOAD` namespace плагина. |
15
+ | `TAB_SET` | `vne:settings_view:tab_set` | Выбрать вкладку по ключу из `PARAMS.TABS` (`{ tab: string }`). |
16
+
17
+ ## Константы
18
+
19
+ Нет.
20
+
21
+ ## Параметры
22
+
23
+ | Ключ | Тип | Смысл |
24
+ |------|-----|-------|
25
+ | `TRANSITION` | `string` | Значение по умолчанию: "TRANSITION". |
26
+ | `AUDIO_NAME` | `string` | Имя трека на слое `view` при открытии экрана; пустая строка — без overlay-музыки. |
27
+
28
+ ## Настройки
29
+
30
+ Нет.
31
+
32
+ ## Модули
33
+
34
+ | Модуль | Зона ответственности |
35
+ |--------|----------------------|
36
+ | `settings.controller.audio` | Наследник `ModuleControllerAudio`: SHOW/HIDE/PRELOAD → pause global, play/stop `view`-трека. |
37
+ | `settings.controller` | Обрабатывает HIDE, SET, TAB_SET, UPDATE, …; `currentTab` — ключ вкладки. |
38
+ | `settings.controller.tabs` | Наследник `ModuleControllerTabs`: TAB_PREV/TAB_NEXT → `TAB_SET`; `getTabKeys` по `showInSettings`. |
39
+ | `settings.view` | Подмодуль `view` плагина. |
40
+
41
+ ## Близкие плагины
42
+
43
+ ### plugins/core/
44
+
45
+ - [components.md](../core/components.md) — `COMPONENTS`: EVENTS.EXTERNAL_UPDATE
46
+ - [memory.md](../core/memory.md) — `MEMORY`: EVENTS.CLEARED
47
+ - [settings.md](../core/settings.md) — `SETTINGS`: EVENTS.SET, EVENTS.CHANGED, EVENTS.INIT
48
+ - [state.md](../core/state.md) — `STATE`: EVENTS.SET, EVENTS.CLEAR
49
+
50
+ ### Остальные
51
+
52
+ - [audio.md](../audio/audio.md) — `AUDIO`: EVENTS.GLOBAL_PAUSE, EVENTS.PLAY, EVENTS.STOP, EVENTS.GLOBAL_RESUME, EVENTS.MEDIA_LOAD
53
+ - [controls.md](../controls/controls.md) — `CONTROLS`: CONST.BUTTONS.BACK, CONST.BUTTONS.MENU, CONST.BUTTONS.GAMEMENU, CONST.BUTTONS.INTERACT, CONST.BUTTONS.ACCEPT, CONST.BUTTONS.TAB_PREV, CONST.BUTTONS.TAB_NEXT
@@ -0,0 +1,38 @@
1
+ # Каталог сценарных команд (вариант C)
2
+
3
+ Полный surface `$` / `%` команд для агента и автора. Каждая запись — короткий stub + ссылка на plugin doc.
4
+
5
+ Параллельный вход с развёрнутыми гайдами: [`../scenario.guide/`](../scenario.guide/).
6
+
7
+ ## Как читать
8
+
9
+ 1. Откройте [`index.md`](./index.md) — оглавление всех команд.
10
+ 2. Перейдите в stub (`stubs/<name>.md`) за сигнатурой и примером.
11
+ 3. Если нужны события/модули — plugin doc из stub.
12
+
13
+ ## Source of truth
14
+
15
+ Машинный каталог живёт в контрактах:
16
+
17
+ ```text
18
+ contracts/**/src/commands.ts → export const SCENARIO_COMMANDS
19
+ ```
20
+
21
+ Тот же набор агрегирует VS Code grammar (`vs_code_extensions/vne-language`, `load-commands.js`). Этот markdown-каталог в первой итерации **собран вручную** по текущим `commands.ts`; позже его можно генерировать тем же merge.
22
+
23
+ Runtime регистрирует handlers отдельно через `SCENARIO.LINE_EXEC_REG` — stubs описывают author-facing синтаксис, не internals.
24
+
25
+ ## Структура
26
+
27
+ ```text
28
+ scenario.catalog/
29
+ README.md
30
+ index.md
31
+ stubs/
32
+ flag.md # $ и % вместе, где оба есть
33
+ choose.md # $ choose
34
+ choose.block.md # % choose
35
+ choose.option.md
36
+ bl.bg.md # canvas: слой.kind
37
+ …
38
+ ```
@@ -0,0 +1,109 @@
1
+ # Индекс команд (SCENARIO_COMMANDS)
2
+
3
+ Однострочные описания → stub. Guide: [`../scenario.guide/`](../scenario.guide/).
4
+
5
+ ## Core / flow
6
+
7
+ | Команда | Кратко | Stub |
8
+ |---------|--------|------|
9
+ | `$ scenario` | `anchor`, `goto` | [scenario.md](./stubs/scenario.md) |
10
+ | `$ stack` | `jump`, `call`, `pop` | [stack.md](./stubs/stack.md) |
11
+ | `$ pause` | пауза | [pause.md](./stubs/pause.md) |
12
+ | `$ save` | `key` | [save.md](./stubs/save.md) |
13
+ | `$ save.auto` | автосохранение | [save.auto.md](./stubs/save.auto.md) |
14
+
15
+ ## Диалог / текст
16
+
17
+ | Команда | Кратко | Stub |
18
+ |---------|--------|------|
19
+ | `other` (без `$`) | реплики `"…"` / `<speaker> "…"` | [other.md](./stubs/other.md) |
20
+ | `$ text.meet` | знакомство со спикером | [text.meet.md](./stubs/text.meet.md) |
21
+ | `$ text.wall` | `start`, `end`, `clear` | [text.wall.md](./stubs/text.wall.md) |
22
+
23
+ ## Vars
24
+
25
+ | Команда | Кратко | Stub |
26
+ |---------|--------|------|
27
+ | `$ flag` / `% flag` | set/unset и условный блок | [flag.md](./stubs/flag.md) |
28
+ | `$ counter` / `% counter` | арифметика и сравнения | [counter.md](./stubs/counter.md) |
29
+
30
+ ## Choose / PAC / QTE / random
31
+
32
+ | Команда | Кратко | Stub |
33
+ |---------|--------|------|
34
+ | `% choose` | меню опций | [choose.block.md](./stubs/choose.block.md) |
35
+ | `% choose.option` | ветка опции | [choose.option.md](./stubs/choose.option.md) |
36
+ | `$ choose` | `repeat` | [choose.md](./stubs/choose.md) |
37
+ | `% point-and-click` | hotspots | [point-and-click.block.md](./stubs/point-and-click.block.md) |
38
+ | `% point-and-click.option` | `{icon} x y` | [point-and-click.option.md](./stubs/point-and-click.option.md) |
39
+ | `$ point-and-click` | `repeat` | [point-and-click.md](./stubs/point-and-click.md) |
40
+ | `% qte` | QTE по id | [qte.md](./stubs/qte.md) |
41
+ | `% random` | случайная ветка | [random.md](./stubs/random.md) |
42
+ | `% random.option` | опция random | [random.option.md](./stubs/random.option.md) |
43
+
44
+ ## Audio
45
+
46
+ | Команда | Кратко | Stub |
47
+ |---------|--------|------|
48
+ | `$ audio.music` | play/stop/pause/resume/volume | [audio.music.md](./stubs/audio.music.md) |
49
+ | `$ audio.ambient` | то же | [audio.ambient.md](./stubs/audio.ambient.md) |
50
+ | `$ audio.sound` | то же | [audio.sound.md](./stubs/audio.sound.md) |
51
+ | `$ audio.voice` | то же | [audio.voice.md](./stubs/audio.voice.md) |
52
+
53
+ ## Views / screens / entities / time
54
+
55
+ | Команда | Кратко | Stub |
56
+ |---------|--------|------|
57
+ | `$ interface` | `show`, `hide`, `view` | [interface.md](./stubs/interface.md) |
58
+ | `$ intro` | интро | [intro.md](./stubs/intro.md) |
59
+ | `$ mainmenu` | главное меню | [mainmenu.md](./stubs/mainmenu.md) |
60
+ | `$ credits` | `show`, `hide` | [credits.md](./stubs/credits.md) |
61
+ | `$ settings.defaults` | дефолты настроек | [settings.defaults.md](./stubs/settings.defaults.md) |
62
+ | `$ video` | `play` | [video.md](./stubs/video.md) |
63
+ | `$ comment` | комментарий / `hide` | [comment.md](./stubs/comment.md) |
64
+ | `$ achievement` | `lock`, `unlock` | [achievement.md](./stubs/achievement.md) |
65
+ | `$ wallet` | `add`, `set`, `reset` | [wallet.md](./stubs/wallet.md) |
66
+ | `$ time` | `add`, `set` | [time.md](./stubs/time.md) |
67
+ | `$ date` | `add`, `set` | [date.md](./stubs/date.md) |
68
+
69
+ ## Canvas layers
70
+
71
+ Паттерн: `$ <layer>.<kind> <action> …`. Слои: `bl`, `fl`, `ml`, `ul`. Guide: [canvas.md](../scenario.guide/canvas.md).
72
+
73
+ ### bl
74
+
75
+ | Команда | Actions | Stub |
76
+ |---------|---------|------|
77
+ | `$ bl.bg` | show, hide, change | [bl.bg.md](./stubs/bl.bg.md) |
78
+ | `$ bl.sprite` | show, hide, change, move | [bl.sprite.md](./stubs/bl.sprite.md) |
79
+ | `$ bl.video` | show, hide, change | [bl.video.md](./stubs/bl.video.md) |
80
+ | `$ bl.text` | show, hide, change, move | [bl.text.md](./stubs/bl.text.md) |
81
+ | `$ bl.fill` | show, change, hide | [bl.fill.md](./stubs/bl.fill.md) |
82
+ | `$ bl.filter` | set, unset | [bl.filter.md](./stubs/bl.filter.md) |
83
+ | `$ bl.scale` | set, unset | [bl.scale.md](./stubs/bl.scale.md) |
84
+ | `$ bl.clip` | set, unset | [bl.clip.md](./stubs/bl.clip.md) |
85
+ | `$ bl.mask` | set, unset, change | [bl.mask.md](./stubs/bl.mask.md) |
86
+ | `$ bl.animation` | set, unset | [bl.animation.md](./stubs/bl.animation.md) |
87
+
88
+ ### fl / ml
89
+
90
+ Те же kind, что у `bl` (`bg` … `animation`, включая `video`):
91
+
92
+ - `fl.*` → [fl.bg.md](./stubs/fl.bg.md), [fl.sprite.md](./stubs/fl.sprite.md), [fl.video.md](./stubs/fl.video.md), [fl.text.md](./stubs/fl.text.md), [fl.fill.md](./stubs/fl.fill.md), [fl.filter.md](./stubs/fl.filter.md), [fl.scale.md](./stubs/fl.scale.md), [fl.clip.md](./stubs/fl.clip.md), [fl.mask.md](./stubs/fl.mask.md), [fl.animation.md](./stubs/fl.animation.md)
93
+ - `ml.*` → [ml.bg.md](./stubs/ml.bg.md), [ml.sprite.md](./stubs/ml.sprite.md), [ml.video.md](./stubs/ml.video.md), [ml.text.md](./stubs/ml.text.md), [ml.fill.md](./stubs/ml.fill.md), [ml.filter.md](./stubs/ml.filter.md), [ml.scale.md](./stubs/ml.scale.md), [ml.clip.md](./stubs/ml.clip.md), [ml.mask.md](./stubs/ml.mask.md), [ml.animation.md](./stubs/ml.animation.md)
94
+
95
+ ### ul
96
+
97
+ Без `video`:
98
+
99
+ | Команда | Stub |
100
+ |---------|------|
101
+ | `$ ul.bg` | [ul.bg.md](./stubs/ul.bg.md) |
102
+ | `$ ul.sprite` | [ul.sprite.md](./stubs/ul.sprite.md) |
103
+ | `$ ul.text` | [ul.text.md](./stubs/ul.text.md) |
104
+ | `$ ul.fill` | [ul.fill.md](./stubs/ul.fill.md) |
105
+ | `$ ul.filter` | [ul.filter.md](./stubs/ul.filter.md) |
106
+ | `$ ul.scale` | [ul.scale.md](./stubs/ul.scale.md) |
107
+ | `$ ul.clip` | [ul.clip.md](./stubs/ul.clip.md) |
108
+ | `$ ul.mask` | [ul.mask.md](./stubs/ul.mask.md) |
109
+ | `$ ul.animation` | [ul.animation.md](./stubs/ul.animation.md) |
@@ -0,0 +1,16 @@
1
+ # $ achievement
2
+
3
+ | | |
4
+ |--|--|
5
+ | Тип | `module` (`$`) |
6
+ | Сигнатура | `$ achievement <action> …` |
7
+ | Actions / args | lock, unlock |
8
+ | Plugin doc | [views/achievement.md](../plugins/views/achievement.md) |
9
+
10
+ ## Примеры
11
+
12
+ ```vne
13
+ $ achievement unlock id
14
+ ```
15
+
16
+ Source of truth: `SCENARIO_COMMANDS` в соответствующем `contracts/**/commands.ts`.
@@ -0,0 +1,16 @@
1
+ # $ audio.ambient
2
+
3
+ | | |
4
+ |--|--|
5
+ | Тип | `module` (`$`) |
6
+ | Сигнатура | `$ audio.ambient <action> …` |
7
+ | Actions / args | play, stop, pause, resume, volume |
8
+ | Plugin doc | [audio/ambient.md](../plugins/audio/ambient.md) |
9
+
10
+ ## Примеры
11
+
12
+ ```vne
13
+ $ audio.ambient play {rain}
14
+ ```
15
+
16
+ Source of truth: `SCENARIO_COMMANDS` в соответствующем `contracts/**/commands.ts`.
@@ -0,0 +1,16 @@
1
+ # $ audio.music
2
+
3
+ | | |
4
+ |--|--|
5
+ | Тип | `module` (`$`) |
6
+ | Сигнатура | `$ audio.music <action> …` |
7
+ | Actions / args | play, stop, pause, resume, volume |
8
+ | Plugin doc | [audio/music.md](../plugins/audio/music.md) |
9
+
10
+ ## Примеры
11
+
12
+ ```vne
13
+ $ audio.music play {theme}
14
+ ```
15
+
16
+ Source of truth: `SCENARIO_COMMANDS` в соответствующем `contracts/**/commands.ts`.
@@ -0,0 +1,16 @@
1
+ # $ audio.sound
2
+
3
+ | | |
4
+ |--|--|
5
+ | Тип | `module` (`$`) |
6
+ | Сигнатура | `$ audio.sound <action> …` |
7
+ | Actions / args | play, stop, pause, resume, volume |
8
+ | Plugin doc | [audio/sound.md](../plugins/audio/sound.md) |
9
+
10
+ ## Примеры
11
+
12
+ ```vne
13
+ $ audio.sound play {ui/click}
14
+ ```
15
+
16
+ Source of truth: `SCENARIO_COMMANDS` в соответствующем `contracts/**/commands.ts`.
@@ -0,0 +1,16 @@
1
+ # $ audio.voice
2
+
3
+ | | |
4
+ |--|--|
5
+ | Тип | `module` (`$`) |
6
+ | Сигнатура | `$ audio.voice <action> …` |
7
+ | Actions / args | play, stop, pause, resume, volume |
8
+ | Plugin doc | [audio/voice.md](../plugins/audio/voice.md) |
9
+
10
+ ## Примеры
11
+
12
+ ```vne
13
+ $ audio.voice play {fl/line_01}
14
+ ```
15
+
16
+ Source of truth: `SCENARIO_COMMANDS` в соответствующем `contracts/**/commands.ts`.
@@ -0,0 +1,18 @@
1
+ # $ bl.animation
2
+
3
+ | | |
4
+ |--|--|
5
+ | Тип | `module` (`$`) |
6
+ | Сигнатура | `$ bl.animation <action> …` |
7
+ | Actions / args | set, unset |
8
+ | Plugin doc | [canvas.layers/bl.md](../plugins/canvas.layers/bl.md) |
9
+
10
+ ## Примеры
11
+
12
+ ```vne
13
+ $ bl.animation set …
14
+ ```
15
+
16
+ Паттерн всех слоёв одинаков — см. [guide canvas](../../scenario.guide/canvas.md).
17
+
18
+ Source of truth: `SCENARIO_COMMANDS` в соответствующем `contracts/**/commands.ts`.
@@ -0,0 +1,18 @@
1
+ # $ bl.bg
2
+
3
+ | | |
4
+ |--|--|
5
+ | Тип | `module` (`$`) |
6
+ | Сигнатура | `$ bl.bg <action> …` |
7
+ | Actions / args | show, hide, change |
8
+ | Plugin doc | [canvas.layers/bl.md](../plugins/canvas.layers/bl.md) |
9
+
10
+ ## Примеры
11
+
12
+ ```vne
13
+ $ bl.bg show …
14
+ ```
15
+
16
+ Паттерн всех слоёв одинаков — см. [guide canvas](../../scenario.guide/canvas.md).
17
+
18
+ Source of truth: `SCENARIO_COMMANDS` в соответствующем `contracts/**/commands.ts`.
@@ -0,0 +1,18 @@
1
+ # $ bl.clip
2
+
3
+ | | |
4
+ |--|--|
5
+ | Тип | `module` (`$`) |
6
+ | Сигнатура | `$ bl.clip <action> …` |
7
+ | Actions / args | set, unset |
8
+ | Plugin doc | [canvas.layers/bl.md](../plugins/canvas.layers/bl.md) |
9
+
10
+ ## Примеры
11
+
12
+ ```vne
13
+ $ bl.clip set …
14
+ ```
15
+
16
+ Паттерн всех слоёв одинаков — см. [guide canvas](../../scenario.guide/canvas.md).
17
+
18
+ Source of truth: `SCENARIO_COMMANDS` в соответствующем `contracts/**/commands.ts`.
@@ -0,0 +1,18 @@
1
+ # $ bl.fill
2
+
3
+ | | |
4
+ |--|--|
5
+ | Тип | `module` (`$`) |
6
+ | Сигнатура | `$ bl.fill <action> …` |
7
+ | Actions / args | show, change, hide |
8
+ | Plugin doc | [canvas.layers/bl.md](../plugins/canvas.layers/bl.md) |
9
+
10
+ ## Примеры
11
+
12
+ ```vne
13
+ $ bl.fill show …
14
+ ```
15
+
16
+ Паттерн всех слоёв одинаков — см. [guide canvas](../../scenario.guide/canvas.md).
17
+
18
+ Source of truth: `SCENARIO_COMMANDS` в соответствующем `contracts/**/commands.ts`.
@@ -0,0 +1,18 @@
1
+ # $ bl.filter
2
+
3
+ | | |
4
+ |--|--|
5
+ | Тип | `module` (`$`) |
6
+ | Сигнатура | `$ bl.filter <action> …` |
7
+ | Actions / args | set, unset |
8
+ | Plugin doc | [canvas.layers/bl.md](../plugins/canvas.layers/bl.md) |
9
+
10
+ ## Примеры
11
+
12
+ ```vne
13
+ $ bl.filter set …
14
+ ```
15
+
16
+ Паттерн всех слоёв одинаков — см. [guide canvas](../../scenario.guide/canvas.md).
17
+
18
+ Source of truth: `SCENARIO_COMMANDS` в соответствующем `contracts/**/commands.ts`.
@@ -0,0 +1,18 @@
1
+ # $ bl.mask
2
+
3
+ | | |
4
+ |--|--|
5
+ | Тип | `module` (`$`) |
6
+ | Сигнатура | `$ bl.mask <action> …` |
7
+ | Actions / args | set, unset, change |
8
+ | Plugin doc | [canvas.layers/bl.md](../plugins/canvas.layers/bl.md) |
9
+
10
+ ## Примеры
11
+
12
+ ```vne
13
+ $ bl.mask set …
14
+ ```
15
+
16
+ Паттерн всех слоёв одинаков — см. [guide canvas](../../scenario.guide/canvas.md).
17
+
18
+ Source of truth: `SCENARIO_COMMANDS` в соответствующем `contracts/**/commands.ts`.
@@ -0,0 +1,18 @@
1
+ # $ bl.scale
2
+
3
+ | | |
4
+ |--|--|
5
+ | Тип | `module` (`$`) |
6
+ | Сигнатура | `$ bl.scale <action> …` |
7
+ | Actions / args | set, unset |
8
+ | Plugin doc | [canvas.layers/bl.md](../plugins/canvas.layers/bl.md) |
9
+
10
+ ## Примеры
11
+
12
+ ```vne
13
+ $ bl.scale set …
14
+ ```
15
+
16
+ Паттерн всех слоёв одинаков — см. [guide canvas](../../scenario.guide/canvas.md).
17
+
18
+ Source of truth: `SCENARIO_COMMANDS` в соответствующем `contracts/**/commands.ts`.
@@ -0,0 +1,18 @@
1
+ # $ bl.sprite
2
+
3
+ | | |
4
+ |--|--|
5
+ | Тип | `module` (`$`) |
6
+ | Сигнатура | `$ bl.sprite <action> …` |
7
+ | Actions / args | show, hide, change, move |
8
+ | Plugin doc | [canvas.layers/bl.md](../plugins/canvas.layers/bl.md) |
9
+
10
+ ## Примеры
11
+
12
+ ```vne
13
+ $ bl.sprite show …
14
+ ```
15
+
16
+ Паттерн всех слоёв одинаков — см. [guide canvas](../../scenario.guide/canvas.md).
17
+
18
+ Source of truth: `SCENARIO_COMMANDS` в соответствующем `contracts/**/commands.ts`.
@@ -0,0 +1,18 @@
1
+ # $ bl.text
2
+
3
+ | | |
4
+ |--|--|
5
+ | Тип | `module` (`$`) |
6
+ | Сигнатура | `$ bl.text <action> …` |
7
+ | Actions / args | show, hide, change, move |
8
+ | Plugin doc | [canvas.layers/bl.md](../plugins/canvas.layers/bl.md) |
9
+
10
+ ## Примеры
11
+
12
+ ```vne
13
+ $ bl.text show …
14
+ ```
15
+
16
+ Паттерн всех слоёв одинаков — см. [guide canvas](../../scenario.guide/canvas.md).
17
+
18
+ Source of truth: `SCENARIO_COMMANDS` в соответствующем `contracts/**/commands.ts`.
@@ -0,0 +1,18 @@
1
+ # $ bl.video
2
+
3
+ | | |
4
+ |--|--|
5
+ | Тип | `module` (`$`) |
6
+ | Сигнатура | `$ bl.video <action> …` |
7
+ | Actions / args | show, hide, change |
8
+ | Plugin doc | [canvas.layers/bl.md](../plugins/canvas.layers/bl.md) |
9
+
10
+ ## Примеры
11
+
12
+ ```vne
13
+ $ bl.video show …
14
+ ```
15
+
16
+ Паттерн всех слоёв одинаков — см. [guide canvas](../../scenario.guide/canvas.md).
17
+
18
+ Source of truth: `SCENARIO_COMMANDS` в соответствующем `contracts/**/commands.ts`.
@@ -0,0 +1,25 @@
1
+ # % choose
2
+
3
+ | | |
4
+ |--|--|
5
+ | Тип | `block` (`%`) |
6
+ | Сигнатура | `% choose` |
7
+ | Plugin doc | [scenario/choose.md](../../plugins/scenario/choose.md) |
8
+
9
+ ## Примеры
10
+
11
+ ```vne
12
+ % choose
13
+ % choose.option "Осмотреть"
14
+ hided: $ flag seen
15
+ $ flag seen
16
+ $ choose repeat
17
+ % choose.option "Уйти"
18
+ "…"
19
+ ```
20
+
21
+ Если все опции `hided` — блок пропускается.
22
+
23
+ См. [guide choose](../../scenario.guide/choose.md).
24
+
25
+ Source of truth: `contracts/scenario/choose/src/commands.ts`.
@@ -0,0 +1,18 @@
1
+ # $ choose
2
+
3
+ | | |
4
+ |--|--|
5
+ | Тип | `module` (`$`) |
6
+ | Сигнатура | `$ choose repeat` |
7
+ | Actions | `repeat` |
8
+ | Plugin doc | [scenario/choose.md](../../plugins/scenario/choose.md) |
9
+
10
+ ## Примеры
11
+
12
+ ```vne
13
+ $ choose repeat
14
+ ```
15
+
16
+ Возврат к ближайшему `% choose` выше в той же метке. Полный цикл «осмотреть → меню» — в [guide choose](../../scenario.guide/choose.md).
17
+
18
+ Source of truth: `contracts/scenario/choose/src/commands.ts`.
@@ -0,0 +1,24 @@
1
+ # % choose.option
2
+
3
+ | | |
4
+ |--|--|
5
+ | Тип | `block` (`%`) |
6
+ | Сигнатура | `% choose.option "…"` |
7
+ | Plugin doc | [scenario/choose.md](../../plugins/scenario/choose.md) |
8
+
9
+ ## Примеры
10
+
11
+ ```vne
12
+ % choose.option "Уйти"
13
+ "Ветка"
14
+ % choose.option "С QTE"
15
+ qte: easy
16
+ % choose.option "Fallback" | qte-fallback
17
+ "…"
18
+ ```
19
+
20
+ Props: `hided:`, `disabled:`, `qte:`. Keyword `| qte-fallback`.
21
+
22
+ См. [guide choose](../../scenario.guide/choose.md).
23
+
24
+ Source of truth: `contracts/scenario/choose/src/commands.ts`.
@@ -0,0 +1,17 @@
1
+ # $ comment
2
+
3
+ | | |
4
+ |--|--|
5
+ | Тип | `module` (`$`) |
6
+ | Сигнатура | `$ comment …` |
7
+ | Actions / args | hide (+ freeform text line) |
8
+ | Plugin doc | [views/comment.md](../plugins/views/comment.md) |
9
+
10
+ ## Примеры
11
+
12
+ ```vne
13
+ $ comment "Подсказка" 5000
14
+ $ comment hide
15
+ ```
16
+
17
+ Source of truth: `SCENARIO_COMMANDS` в соответствующем `contracts/**/commands.ts`.
@@ -0,0 +1,21 @@
1
+ # counter ($ и %)
2
+
3
+ | | |
4
+ |--|--|
5
+ | Тип | `module` (`$`) и `block` (`%`) |
6
+ | `$ counter` | `$ counter <name> [op] [number]` — `++` `--` `+=` `-=` `=` |
7
+ | `% counter` | `% counter <name> <compare> [number]` — `>` `>=` `===` `!==` `<` `<=` |
8
+ | Plugin doc | [vars/counters.md](../../plugins/vars/counters.md) |
9
+
10
+ ## Примеры
11
+
12
+ ```vne
13
+ $ counter n ++
14
+ $ counter n = 10 | global
15
+ % counter n > 0
16
+ "…"
17
+ ```
18
+
19
+ См. также [guide vars](../../scenario.guide/vars.md).
20
+
21
+ Source of truth: `SCENARIO_COMMANDS` в `contracts/vars/counters/src/commands.ts`.
@@ -0,0 +1,17 @@
1
+ # $ credits
2
+
3
+ | | |
4
+ |--|--|
5
+ | Тип | `module` (`$`) |
6
+ | Сигнатура | `$ credits <action>` |
7
+ | Actions / args | show, hide |
8
+ | Plugin doc | [views.screens/credits.md](../plugins/views.screens/credits.md) |
9
+
10
+ ## Примеры
11
+
12
+ ```vne
13
+ $ credits show
14
+ $ credits hide
15
+ ```
16
+
17
+ Source of truth: `SCENARIO_COMMANDS` в соответствующем `contracts/**/commands.ts`.