@vnejs/docs 0.2.65 → 0.2.67

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 (261) hide show
  1. package/README.md +35 -35
  2. package/architecture/backends.md +18 -0
  3. package/architecture/build.md +37 -0
  4. package/architecture/bundles.md +20 -0
  5. package/architecture/cli.md +25 -0
  6. package/architecture/compatibility.md +22 -0
  7. package/architecture/configs.md +19 -0
  8. package/architecture/contracts.md +30 -0
  9. package/architecture/dependencies.md +55 -0
  10. package/architecture/editor.md +7 -0
  11. package/architecture/games.md +38 -0
  12. package/architecture/helpers.md +14 -0
  13. package/architecture/model.md +43 -0
  14. package/architecture/modules.md +87 -0
  15. package/architecture/packages.md +43 -0
  16. package/architecture/plugins.md +36 -0
  17. package/architecture/uis.md +23 -0
  18. package/changelog/0.2.18.md +7 -0
  19. package/changelog/0.2.19.md +14 -0
  20. package/changelog/0.2.20.md +10 -0
  21. package/changelog/0.2.21.md +5 -0
  22. package/changelog/0.2.22.md +11 -0
  23. package/changelog/0.2.23.md +4 -0
  24. package/changelog/0.2.25.md +6 -0
  25. package/changelog/0.2.26.md +12 -0
  26. package/changelog/0.2.29.md +10 -0
  27. package/changelog/0.2.31.md +5 -0
  28. package/changelog/0.2.32.md +3 -0
  29. package/changelog/0.2.33.md +5 -0
  30. package/changelog/0.2.34.md +8 -0
  31. package/changelog/0.2.35.md +33 -0
  32. package/changelog/0.2.36.md +10 -0
  33. package/changelog/0.2.38.md +19 -0
  34. package/changelog/0.2.39.md +16 -0
  35. package/changelog/0.2.40.md +9 -0
  36. package/changelog/0.2.42.md +3 -0
  37. package/changelog/0.2.43.md +10 -0
  38. package/changelog/0.2.46.md +3 -0
  39. package/changelog/0.2.47.md +25 -0
  40. package/changelog/0.2.49.md +3 -0
  41. package/changelog/0.2.50.md +6 -0
  42. package/changelog/0.2.51.md +6 -0
  43. package/changelog/0.2.52.md +5 -0
  44. package/changelog/0.2.53.md +12 -0
  45. package/changelog/0.2.55.md +19 -0
  46. package/changelog/0.2.56.md +11 -0
  47. package/changelog/0.2.57.md +7 -0
  48. package/changelog/0.2.58.md +8 -0
  49. package/changelog/0.2.59.md +6 -0
  50. package/changelog/0.2.60.md +5 -0
  51. package/changelog/0.2.61.md +11 -0
  52. package/changelog/0.2.62.md +8 -0
  53. package/changelog/0.2.63.md +4 -0
  54. package/changelog/0.2.64.md +4 -0
  55. package/changelog/0.2.65.md +3 -0
  56. package/changelog/0.2.66.md +5 -0
  57. package/changelog/README.md +43 -0
  58. package/manifest.json +66 -5
  59. package/package.json +6 -4
  60. package/plugins/ai/ai.md +29 -29
  61. package/plugins/ai/checkers.md +26 -26
  62. package/plugins/audio/ambient.md +20 -20
  63. package/plugins/audio/audio.md +40 -40
  64. package/plugins/audio/music.md +20 -20
  65. package/plugins/audio/sound.md +20 -20
  66. package/plugins/audio/voice.md +23 -23
  67. package/plugins/canvas/bg.md +44 -44
  68. package/plugins/canvas/bg.speak.md +34 -34
  69. package/plugins/canvas/fill.md +33 -33
  70. package/plugins/canvas/layer.md +35 -35
  71. package/plugins/canvas/sprite.md +46 -46
  72. package/plugins/canvas/sprite.speak.md +33 -33
  73. package/plugins/canvas/text.md +37 -37
  74. package/plugins/canvas/video.md +37 -37
  75. package/plugins/canvas.layers/bl.md +33 -33
  76. package/plugins/canvas.layers/fl.md +33 -33
  77. package/plugins/canvas.layers/ml.md +33 -33
  78. package/plugins/canvas.layers/ul.md +32 -32
  79. package/plugins/canvas.props/animation.md +25 -25
  80. package/plugins/canvas.props/clip.md +22 -22
  81. package/plugins/canvas.props/filters.md +20 -20
  82. package/plugins/canvas.props/mask.md +23 -23
  83. package/plugins/canvas.props/scale.md +20 -20
  84. package/plugins/common/grid.md +23 -23
  85. package/plugins/common/turn.md +18 -18
  86. package/plugins/controls/controls.md +31 -31
  87. package/plugins/controls/cursor.md +54 -54
  88. package/plugins/controls/gamepad.md +56 -56
  89. package/plugins/controls/keyboard.md +17 -17
  90. package/plugins/core/components.md +28 -28
  91. package/plugins/core/interact.md +26 -26
  92. package/plugins/core/logs.md +28 -28
  93. package/plugins/core/media.md +38 -38
  94. package/plugins/core/memory.md +28 -28
  95. package/plugins/core/platforms.md +19 -19
  96. package/plugins/core/scenario.md +48 -48
  97. package/plugins/core/settings.md +24 -24
  98. package/plugins/core/stack.md +39 -39
  99. package/plugins/core/state.md +30 -30
  100. package/plugins/core/storage.md +56 -56
  101. package/plugins/core/system.md +37 -37
  102. package/plugins/core/vendors.md +19 -19
  103. package/plugins/entities/entities.md +16 -16
  104. package/plugins/entities/wallet.md +27 -27
  105. package/plugins/font/montserrat.md +16 -16
  106. package/plugins/game/checkers.md +38 -38
  107. package/plugins/platform/android.md +17 -17
  108. package/plugins/platform/electron.md +21 -21
  109. package/plugins/platform/metric.md +23 -23
  110. package/plugins/rpg/damage.md +22 -22
  111. package/plugins/rpg/hit.md +24 -24
  112. package/plugins/rpg/skills.md +26 -26
  113. package/plugins/save/auto.md +26 -26
  114. package/plugins/save/continue.md +23 -23
  115. package/plugins/save/quick.md +24 -24
  116. package/plugins/save/save.md +37 -37
  117. package/plugins/scales/health.md +17 -17
  118. package/plugins/scales/mana.md +17 -17
  119. package/plugins/scales/scales.md +31 -31
  120. package/plugins/scenario/autoread.md +36 -36
  121. package/plugins/scenario/choose.md +74 -65
  122. package/plugins/scenario/fastforward.md +46 -46
  123. package/plugins/scenario/history.md +41 -41
  124. package/plugins/scenario/pause.md +27 -27
  125. package/plugins/scenario/point_and_click.md +51 -51
  126. package/plugins/scenario/qte.md +54 -54
  127. package/plugins/scenario/random.md +17 -17
  128. package/plugins/settings/filter.md +19 -19
  129. package/plugins/settings/potato.md +22 -22
  130. package/plugins/settings/ratio.md +19 -19
  131. package/plugins/settings/textsize.md +19 -19
  132. package/plugins/settings/volume.md +21 -21
  133. package/plugins/text/inject.md +22 -22
  134. package/plugins/text/locs.md +36 -36
  135. package/plugins/text/meet.md +19 -19
  136. package/plugins/text/smooth.md +33 -33
  137. package/plugins/text/text.md +76 -69
  138. package/plugins/text/wall.md +20 -20
  139. package/plugins/time/date.md +22 -22
  140. package/plugins/time/time.md +23 -23
  141. package/plugins/vars/counters.md +28 -28
  142. package/plugins/vars/flags.md +24 -24
  143. package/plugins/vars/vars.md +29 -29
  144. package/plugins/views/achievement.md +44 -44
  145. package/plugins/views/comment.md +31 -31
  146. package/plugins/views/controls.hints.md +34 -34
  147. package/plugins/views/cursor.md +19 -19
  148. package/plugins/views/fps.md +33 -33
  149. package/plugins/views/gamepad.debug.md +32 -32
  150. package/plugins/views/settings.md +39 -39
  151. package/plugins/views/video.md +37 -37
  152. package/plugins/views.scenario/choose.md +41 -41
  153. package/plugins/views.scenario/interface.controls.md +31 -31
  154. package/plugins/views.scenario/interface.fastforward.md +29 -29
  155. package/plugins/views.scenario/interface.md +74 -74
  156. package/plugins/views.scenario/point_and_click.md +39 -39
  157. package/plugins/views.scenario/qte.md +51 -51
  158. package/plugins/views.screens/checkers.md +35 -35
  159. package/plugins/views.screens/confirm.md +35 -35
  160. package/plugins/views.screens/credits.md +31 -31
  161. package/plugins/views.screens/disclaimer.md +42 -42
  162. package/plugins/views.screens/eula.md +37 -37
  163. package/plugins/views.screens/gallery.full.md +41 -41
  164. package/plugins/views.screens/gallery.md +75 -75
  165. package/plugins/views.screens/gamemenu.md +41 -41
  166. package/plugins/views.screens/history.md +39 -39
  167. package/plugins/views.screens/intro.md +32 -32
  168. package/plugins/views.screens/loading.md +30 -30
  169. package/plugins/views.screens/mainmenu.md +49 -49
  170. package/plugins/views.screens/mainmenu.socials.md +25 -25
  171. package/plugins/views.screens/save.md +66 -66
  172. package/plugins/views.screens/settings.defaults.md +37 -37
  173. package/plugins/views.screens/settings.md +40 -40
  174. package/scenario.catalog/README.md +13 -13
  175. package/scenario.catalog/index.md +35 -35
  176. package/scenario.catalog/stubs/achievement.md +4 -4
  177. package/scenario.catalog/stubs/audio.ambient.md +4 -4
  178. package/scenario.catalog/stubs/audio.music.md +4 -4
  179. package/scenario.catalog/stubs/audio.sound.md +4 -4
  180. package/scenario.catalog/stubs/audio.voice.md +4 -4
  181. package/scenario.catalog/stubs/bl.animation.md +5 -5
  182. package/scenario.catalog/stubs/bl.bg.md +5 -5
  183. package/scenario.catalog/stubs/bl.clip.md +5 -5
  184. package/scenario.catalog/stubs/bl.fill.md +5 -5
  185. package/scenario.catalog/stubs/bl.filter.md +5 -5
  186. package/scenario.catalog/stubs/bl.mask.md +5 -5
  187. package/scenario.catalog/stubs/bl.scale.md +5 -5
  188. package/scenario.catalog/stubs/bl.sprite.md +5 -5
  189. package/scenario.catalog/stubs/bl.text.md +5 -5
  190. package/scenario.catalog/stubs/bl.video.md +5 -5
  191. package/scenario.catalog/stubs/choose.block.md +7 -7
  192. package/scenario.catalog/stubs/choose.md +4 -4
  193. package/scenario.catalog/stubs/choose.option.md +7 -7
  194. package/scenario.catalog/stubs/comment.md +5 -5
  195. package/scenario.catalog/stubs/counter.md +5 -5
  196. package/scenario.catalog/stubs/credits.md +4 -4
  197. package/scenario.catalog/stubs/date.md +4 -4
  198. package/scenario.catalog/stubs/disclaimer.md +5 -5
  199. package/scenario.catalog/stubs/fl.animation.md +5 -5
  200. package/scenario.catalog/stubs/fl.bg.md +5 -5
  201. package/scenario.catalog/stubs/fl.clip.md +5 -5
  202. package/scenario.catalog/stubs/fl.fill.md +5 -5
  203. package/scenario.catalog/stubs/fl.filter.md +5 -5
  204. package/scenario.catalog/stubs/fl.mask.md +5 -5
  205. package/scenario.catalog/stubs/fl.scale.md +5 -5
  206. package/scenario.catalog/stubs/fl.sprite.md +5 -5
  207. package/scenario.catalog/stubs/fl.text.md +5 -5
  208. package/scenario.catalog/stubs/fl.video.md +5 -5
  209. package/scenario.catalog/stubs/flag.md +13 -13
  210. package/scenario.catalog/stubs/interface.md +4 -4
  211. package/scenario.catalog/stubs/intro.md +4 -4
  212. package/scenario.catalog/stubs/mainmenu.md +4 -4
  213. package/scenario.catalog/stubs/ml.animation.md +5 -5
  214. package/scenario.catalog/stubs/ml.bg.md +5 -5
  215. package/scenario.catalog/stubs/ml.clip.md +5 -5
  216. package/scenario.catalog/stubs/ml.fill.md +5 -5
  217. package/scenario.catalog/stubs/ml.filter.md +5 -5
  218. package/scenario.catalog/stubs/ml.mask.md +5 -5
  219. package/scenario.catalog/stubs/ml.scale.md +5 -5
  220. package/scenario.catalog/stubs/ml.sprite.md +5 -5
  221. package/scenario.catalog/stubs/ml.text.md +5 -5
  222. package/scenario.catalog/stubs/ml.video.md +5 -5
  223. package/scenario.catalog/stubs/other.md +6 -6
  224. package/scenario.catalog/stubs/pause.md +5 -5
  225. package/scenario.catalog/stubs/point-and-click.block.md +4 -4
  226. package/scenario.catalog/stubs/point-and-click.md +4 -4
  227. package/scenario.catalog/stubs/point-and-click.option.md +4 -4
  228. package/scenario.catalog/stubs/qte.md +4 -4
  229. package/scenario.catalog/stubs/random.md +4 -4
  230. package/scenario.catalog/stubs/random.option.md +4 -4
  231. package/scenario.catalog/stubs/save.auto.md +4 -4
  232. package/scenario.catalog/stubs/save.md +5 -5
  233. package/scenario.catalog/stubs/scenario.md +4 -4
  234. package/scenario.catalog/stubs/settings.defaults.md +4 -4
  235. package/scenario.catalog/stubs/stack.md +4 -4
  236. package/scenario.catalog/stubs/text.meet.md +4 -4
  237. package/scenario.catalog/stubs/text.wall.md +4 -4
  238. package/scenario.catalog/stubs/time.md +4 -4
  239. package/scenario.catalog/stubs/ul.animation.md +5 -5
  240. package/scenario.catalog/stubs/ul.bg.md +5 -5
  241. package/scenario.catalog/stubs/ul.clip.md +5 -5
  242. package/scenario.catalog/stubs/ul.fill.md +5 -5
  243. package/scenario.catalog/stubs/ul.filter.md +5 -5
  244. package/scenario.catalog/stubs/ul.mask.md +5 -5
  245. package/scenario.catalog/stubs/ul.scale.md +5 -5
  246. package/scenario.catalog/stubs/ul.sprite.md +5 -5
  247. package/scenario.catalog/stubs/ul.text.md +5 -5
  248. package/scenario.catalog/stubs/video.md +4 -4
  249. package/scenario.catalog/stubs/wallet.md +4 -4
  250. package/scenario.guide/README.md +38 -38
  251. package/scenario.guide/audio.md +11 -11
  252. package/scenario.guide/canvas.md +23 -23
  253. package/scenario.guide/choose.md +28 -28
  254. package/scenario.guide/dialogue.md +23 -23
  255. package/scenario.guide/flow.md +21 -21
  256. package/scenario.guide/point-and-click.md +12 -12
  257. package/scenario.guide/qte-random.md +20 -20
  258. package/scenario.guide/vars.md +19 -19
  259. package/scenario.guide/views.md +20 -20
  260. package/CHANGELOG.md +0 -387
  261. package/architecture.md +0 -566
@@ -1,50 +1,50 @@
1
- # QTE и random
1
+ # QTE and random
2
2
 
3
3
  ## % qte
4
4
 
5
- Quick Time Event по id из параметров игры (`PARAMS.QTE.ITEMS`).
5
+ A quick time event by id from the game params (`PARAMS.QTE.ITEMS`).
6
6
 
7
7
  ```vne
8
8
  % qte door_lock
9
- "Успех — тело indented-блока"
10
- "Провал или после блока — следующая строка"
9
+ "Success — the indented body"
10
+ "Fail, or after the block — the next line"
11
11
  ```
12
12
 
13
- | Исход | Поведение |
14
- | --------------------- | --------------------------------------- |
15
- | Success | `curLine` на первую строку внутри блока |
16
- | Fail / неизвестный id | Пропуск indented-блока |
13
+ | Result | Behavior |
14
+ | ----------------- | -------------------------------------------------- |
15
+ | Success | `curLine` moves to the first line inside the block |
16
+ | Fail / unknown id | Skip the indented block |
17
17
 
18
- UI — [`../plugins/views.scenario/qte.md`](../plugins/views.scenario/qte.md).
18
+ The UI is [`../plugins/views.scenario/qte.md`](../plugins/views.scenario/qte.md).
19
19
 
20
- ### QTE на опции choose
20
+ ### QTE on a choose option
21
21
 
22
- Нужен compatibility choose↔qte в бандле:
22
+ The bundle needs choose↔qte compatibility:
23
23
 
24
24
  ```vne
25
25
  % choose
26
- % choose.option "Рискнуть"
26
+ % choose.option "Take the risk"
27
27
  qte: easy
28
- "Успех QTE"
29
- % choose.option "Сдаться" | qte-fallback
30
- "Прямой выбор или fail QTE"
28
+ "QTE success"
29
+ % choose.option "Give up" | qte-fallback
30
+ "A direct pick, or a failed QTE"
31
31
  ```
32
32
 
33
- Keyword `| qte-fallback` помечает ветку при провале.
33
+ The keyword `| qte-fallback` marks the branch used on failure.
34
34
 
35
35
  ## % random
36
36
 
37
- Случайно выбирает одну из вложенных `% random.option`:
37
+ Picks one nested `% random.option` at random:
38
38
 
39
39
  ```vne
40
40
  % random
41
41
  % random.option
42
- "Ветка A"
42
+ "Branch A"
43
43
  % random.option
44
- "Ветка B"
44
+ "Branch B"
45
45
  ```
46
46
 
47
- ## См. также
47
+ ## See also
48
48
 
49
49
  - [`../plugins/scenario/qte.md`](../plugins/scenario/qte.md)
50
50
  - [`../plugins/scenario/random.md`](../plugins/scenario/random.md)
@@ -1,6 +1,6 @@
1
- # Переменные: flag и counter
1
+ # Variables: flag and counter
2
2
 
3
- ## flag — булевы флаги
3
+ ## flag — boolean flags
4
4
 
5
5
  ```vne
6
6
  $ flag seen
@@ -9,25 +9,25 @@ $ flag seen unset
9
9
  $ flag seen unset | global
10
10
  ```
11
11
 
12
- | Форма | Смысл |
13
- | --------------------- | ------------------------------------------------------------- |
14
- | `$ flag <name>` | Установить (set) |
15
- | `$ flag <name> set` | Явный set |
16
- | `$ flag <name> unset` | Снять |
17
- | `\| global` | Глобальный (между прохождениями / слотами — по правилам vars) |
12
+ | Form | Meaning |
13
+ | --------------------- | -------------------------------------------------------- |
14
+ | `$ flag <name>` | Set the flag |
15
+ | `$ flag <name> set` | Set the flag explicitly |
16
+ | `$ flag <name> unset` | Clear the flag |
17
+ | `\| global` | Global (across playthroughs / slots — by the vars rules) |
18
18
 
19
- ### Условный блок `% flag`
19
+ ### Conditional block `% flag`
20
20
 
21
21
  ```vne
22
22
  % flag testsFlags1
23
- "Тело выполнится, если флаг установлен"
23
+ "The body runs when the flag is set"
24
24
  % flag testsFlags5 unset
25
- "Тело, если флаг снят"
25
+ "The body runs when the flag is clear"
26
26
  % flag testsFlags1 | global
27
- "Проверка глобального флага"
27
+ "Check a global flag"
28
28
  ```
29
29
 
30
- ## counter — числа
30
+ ## counter — numbers
31
31
 
32
32
  ```vne
33
33
  $ counter n ++
@@ -38,9 +38,9 @@ $ counter n = 10
38
38
  $ counter n ++ | global
39
39
  ```
40
40
 
41
- Операции изменения: `++`, `--`, `+=`, `-=`, `=`.
41
+ Change ops: `++`, `--`, `+=`, `-=`, `=`.
42
42
 
43
- ### Условный блок `% counter`
43
+ ### Conditional block `% counter`
44
44
 
45
45
  ```vne
46
46
  % counter n > 0
@@ -49,19 +49,19 @@ $ counter n ++ | global
49
49
  "…"
50
50
  ```
51
51
 
52
- Сравнения: `>`, `>=`, `===`, `!==`, `<`, `<=`.
52
+ Comparisons: `>`, `>=`, `===`, `!==`, `<`, `<=`.
53
53
 
54
- ### В props опций
54
+ ### In option props
55
55
 
56
56
  ```vne
57
57
  % choose.option "+1"
58
58
  disabled: $ counter n > 0 | global
59
59
  $ counter n ++ | global
60
- % choose.option "Обнулить"
60
+ % choose.option "Reset"
61
61
  hided: $ counter n === 0 | global
62
62
  $ counter n = 0 | global
63
63
  ```
64
64
 
65
- ## См. также
65
+ ## See also
66
66
 
67
67
  - [`../plugins/vars/flags.md`](../plugins/vars/flags.md), [`counters.md`](../plugins/vars/counters.md)
@@ -1,6 +1,6 @@
1
- # UI и экраны
1
+ # UI and screens
2
2
 
3
- ## interface (ADV / UI сценария)
3
+ ## interface (ADV / scenario UI)
4
4
 
5
5
  ```vne
6
6
  $ interface show
@@ -8,9 +8,9 @@ $ interface hide
8
8
  $ interface view adv
9
9
  ```
10
10
 
11
- Действия: `show`, `hide`, `view` (режим/вид интерфейса — значение из игры, часто `adv`).
11
+ Actions: `show`, `hide`, `view` (the interface mode or view — a game value, often `adv`).
12
12
 
13
- ## Экраны
13
+ ## Screens
14
14
 
15
15
  ```vne
16
16
  $ intro
@@ -21,34 +21,34 @@ $ credits hide
21
21
  $ settings.defaults
22
22
  ```
23
23
 
24
- | Команда | Смысл |
25
- | ------------------------- | -------------------------------------------- |
26
- | `$ intro` | Интро-экран |
27
- | `$ disclaimer show <id>` | Дисклеймер (title/text/accept по id из locs) |
28
- | `$ mainmenu` | Главное меню |
29
- | `$ credits show` / `hide` | Титры |
30
- | `$ settings.defaults` | Сброс/дефолты настроек (по плагину) |
24
+ | Command | Meaning |
25
+ | ------------------------- | ---------------------------------------------- |
26
+ | `$ intro` | Intro screen |
27
+ | `$ disclaimer show <id>` | Disclaimer (title/text/accept by id from locs) |
28
+ | `$ mainmenu` | Main menu |
29
+ | `$ credits show` / `hide` | Credits |
30
+ | `$ settings.defaults` | Reset settings to defaults (by the plugin) |
31
31
 
32
- Точный момент вызова (из `init`, из меню) задаёт сценарий игры.
32
+ The game scenario decides when to call these (from `init`, from a menu).
33
33
 
34
34
  ## video / comment / achievement
35
35
 
36
36
  ```vne
37
37
  $ video play {cutscene/01}
38
- $ comment "Подсказка игроку" 5000
38
+ $ comment "A hint for the player" 5000
39
39
  $ achievement unlock some_id
40
40
  $ achievement lock some_id
41
41
  ```
42
42
 
43
- | Модуль | Действия |
44
- | ------------- | ---------------------------------------- |
45
- | `video` | `play` |
46
- | `comment` | текст + опционально длительность; `hide` |
47
- | `achievement` | `lock`, `unlock` |
43
+ | Module | Actions |
44
+ | ------------- | -------------------------------------- |
45
+ | `video` | `play` |
46
+ | `comment` | text plus an optional duration; `hide` |
47
+ | `achievement` | `lock`, `unlock` |
48
48
 
49
49
  ## wallet / time / date
50
50
 
51
- Реже в диалогах, но есть в каталоге команд:
51
+ Less common in dialogue, but present in the command catalog:
52
52
 
53
53
  ```vne
54
54
  $ wallet add …
@@ -60,7 +60,7 @@ $ date add …
60
60
  $ date set …
61
61
  ```
62
62
 
63
- ## См. также
63
+ ## See also
64
64
 
65
65
  - [`../plugins/views.scenario/interface.md`](../plugins/views.scenario/interface.md)
66
66
  - Screens: [`../plugins/views.screens/`](../plugins/views.screens/)