@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,35 @@
1
+ # Point-and-click: % point-and-click
2
+
3
+ Hotspot-выбор на фоне. UI — view-плагин; ветки — как у choose.
4
+
5
+ ```vne
6
+ % point-and-click
7
+ % point-and-click.option {lupa} 25 25
8
+ hided: $ flag pac_1
9
+ $ flag pac_1
10
+ "Нашли предмет."
11
+ $ point-and-click repeat
12
+ % point-and-click.option {pencil} 50 50
13
+ hided: $ flag pac_2
14
+ $ flag pac_2
15
+ "Другая точка."
16
+ $ point-and-click repeat
17
+ "Все точки осмотрены — сценарий продолжается."
18
+ ```
19
+
20
+ ## Команды
21
+
22
+ | Синтаксис | Смысл |
23
+ |-----------|--------|
24
+ | `% point-and-click` | Открыть режим; собрать `.option` |
25
+ | `% point-and-click.option {icon} x y` | Hotspot: иконка + координаты |
26
+ | `$ point-and-click repeat` | Вернуться к ближайшему `% point-and-click` выше |
27
+
28
+ `x` / `y` — числа (проценты/координаты UI — по конвенции игры). `{icon}` — id иконки из медиа.
29
+
30
+ Props `hided:` / `disabled:` — как у choose.
31
+
32
+ ## См. также
33
+
34
+ - [`../plugins/scenario/point_and_click.md`](../plugins/scenario/point_and_click.md)
35
+ - View: [`../plugins/views.scenario/point_and_click.md`](../plugins/views.scenario/point_and_click.md)
@@ -0,0 +1,51 @@
1
+ # QTE и random
2
+
3
+ ## % qte
4
+
5
+ Quick Time Event по id из параметров игры (`PARAMS.QTE.ITEMS`).
6
+
7
+ ```vne
8
+ % qte door_lock
9
+ "Успех — тело indented-блока"
10
+ "Провал или после блока — следующая строка"
11
+ ```
12
+
13
+ | Исход | Поведение |
14
+ |-------|-----------|
15
+ | Success | `curLine` на первую строку внутри блока |
16
+ | Fail / неизвестный id | Пропуск indented-блока |
17
+
18
+ UI — [`../plugins/views.scenario/qte.md`](../plugins/views.scenario/qte.md).
19
+
20
+ ### QTE на опции choose
21
+
22
+ Нужен compatibility choose↔qte в бандле:
23
+
24
+ ```vne
25
+ % choose
26
+ % choose.option "Рискнуть"
27
+ qte: easy
28
+ "Успех QTE"
29
+ % choose.option "Сдаться" | qte-fallback
30
+ "Прямой выбор или fail QTE"
31
+ ```
32
+
33
+ Keyword `| qte-fallback` помечает ветку при провале.
34
+
35
+ ## % random
36
+
37
+ Случайно выбирает одну из вложенных `% random.option`:
38
+
39
+ ```vne
40
+ % random
41
+ % random.option
42
+ "Ветка A"
43
+ % random.option
44
+ "Ветка B"
45
+ ```
46
+
47
+ ## См. также
48
+
49
+ - [`../plugins/scenario/qte.md`](../plugins/scenario/qte.md)
50
+ - [`../plugins/scenario/random.md`](../plugins/scenario/random.md)
51
+ - [choose.md](./choose.md)
@@ -0,0 +1,67 @@
1
+ # Переменные: flag и counter
2
+
3
+ ## flag — булевы флаги
4
+
5
+ ```vne
6
+ $ flag seen
7
+ $ flag seen set
8
+ $ flag seen unset
9
+ $ flag seen unset | global
10
+ ```
11
+
12
+ | Форма | Смысл |
13
+ |-------|--------|
14
+ | `$ flag <name>` | Установить (set) |
15
+ | `$ flag <name> set` | Явный set |
16
+ | `$ flag <name> unset` | Снять |
17
+ | `\| global` | Глобальный (между прохождениями / слотами — по правилам vars) |
18
+
19
+ ### Условный блок `% flag`
20
+
21
+ ```vne
22
+ % flag testsFlags1
23
+ "Тело выполнится, если флаг установлен"
24
+ % flag testsFlags5 unset
25
+ "Тело, если флаг снят"
26
+ % flag testsFlags1 | global
27
+ "Проверка глобального флага"
28
+ ```
29
+
30
+ ## counter — числа
31
+
32
+ ```vne
33
+ $ counter n ++
34
+ $ counter n --
35
+ $ counter n += 2
36
+ $ counter n -= 2
37
+ $ counter n = 10
38
+ $ counter n ++ | global
39
+ ```
40
+
41
+ Операции изменения: `++`, `--`, `+=`, `-=`, `=`.
42
+
43
+ ### Условный блок `% counter`
44
+
45
+ ```vne
46
+ % counter n > 0
47
+ "…"
48
+ % counter n === 10 | global
49
+ "…"
50
+ ```
51
+
52
+ Сравнения: `>`, `>=`, `===`, `!==`, `<`, `<=`.
53
+
54
+ ### В props опций
55
+
56
+ ```vne
57
+ % choose.option "+1"
58
+ disabled: $ counter n > 0 | global
59
+ $ counter n ++ | global
60
+ % choose.option "Обнулить"
61
+ hided: $ counter n === 0 | global
62
+ $ counter n = 0 | global
63
+ ```
64
+
65
+ ## См. также
66
+
67
+ - [`../plugins/vars/flags.md`](../plugins/vars/flags.md), [`counters.md`](../plugins/vars/counters.md)
@@ -0,0 +1,65 @@
1
+ # UI и экраны
2
+
3
+ ## interface (ADV / UI сценария)
4
+
5
+ ```vne
6
+ $ interface show
7
+ $ interface hide
8
+ $ interface view adv
9
+ ```
10
+
11
+ Действия: `show`, `hide`, `view` (режим/вид интерфейса — значение из игры, часто `adv`).
12
+
13
+ ## Экраны
14
+
15
+ ```vne
16
+ $ intro
17
+ $ mainmenu
18
+ $ credits show
19
+ $ credits hide
20
+ $ settings.defaults
21
+ ```
22
+
23
+ | Команда | Смысл |
24
+ |---------|--------|
25
+ | `$ intro` | Интро-экран |
26
+ | `$ mainmenu` | Главное меню |
27
+ | `$ credits show` / `hide` | Титры |
28
+ | `$ settings.defaults` | Сброс/дефолты настроек (по плагину) |
29
+
30
+ Точный момент вызова (из `init`, из меню) задаёт сценарий игры.
31
+
32
+ ## video / comment / achievement
33
+
34
+ ```vne
35
+ $ video play {cutscene/01}
36
+ $ comment "Подсказка игроку" 5000
37
+ $ achievement unlock some_id
38
+ $ achievement lock some_id
39
+ ```
40
+
41
+ | Модуль | Действия |
42
+ |--------|----------|
43
+ | `video` | `play` |
44
+ | `comment` | текст + опционально длительность; `hide` |
45
+ | `achievement` | `lock`, `unlock` |
46
+
47
+ ## wallet / time / date
48
+
49
+ Реже в диалогах, но есть в каталоге команд:
50
+
51
+ ```vne
52
+ $ wallet add …
53
+ $ wallet set …
54
+ $ wallet reset
55
+ $ time add …
56
+ $ time set …
57
+ $ date add …
58
+ $ date set …
59
+ ```
60
+
61
+ ## См. также
62
+
63
+ - [`../plugins/views.scenario/interface.md`](../plugins/views.scenario/interface.md)
64
+ - Screens: [`../plugins/views.screens/`](../plugins/views.screens/)
65
+ - [`../plugins/views/video.md`](../plugins/views/video.md), [`comment.md`](../plugins/views/comment.md), [`achievement.md`](../plugins/views/achievement.md)