@vnejs/docs 0.2.65 → 0.2.67

package/scenario.catalog/stubs/wallet.md

@@ -2,16 +2,16 @@
 
 |                |                                                     |
 | -------------- | --------------------------------------------------- |
-| Тип            | `module` (`$`)                                      |
-| Сигнатура      | `$ wallet <action> …`                               |
+| Type           | `module` (`$`)                                      |
+| Signature      | `$ wallet <action> …`                               |
 | Actions / args | add, set, reset                                     |
 | Plugin doc     | [entities/wallet.md](../plugins/entities/wallet.md) |
 
-## Примеры
+## Examples
 
 ```vne
 $ wallet add …
 $ wallet reset
 ```
 
-Source of truth: `SCENARIO_COMMANDS` в соответствующем `contracts/**/commands.ts`.
+Source of truth: `SCENARIO_COMMANDS` in the matching `contracts/**/commands.ts`.

package/scenario.guide/README.md

@@ -1,82 +1,82 @@
-# Сценарный гайд (вариант B)
+# Scenario guide (variant B)
 
-Авторский слой для написания `.vne`. Здесь — синтаксис, примеры и типичные паттерны. События и модули плагинов — в [`../plugins/`](../plugins/).
+Author layer for writing `.vne`. Syntax, examples, and common patterns live here. Plugin events and modules are in [`../plugins/`](../plugins/).
 
-Параллельный вход: [`../scenario.catalog/`](../scenario.catalog/) (индекс команд из `SCENARIO_COMMANDS`).
+The other entry is [`../scenario.catalog/`](../scenario.catalog/) (the command index from `SCENARIO_COMMANDS`).
 
-## Оглавление
+## Contents
 
-| Страница                                   | Тема                                            |
+| Page                                       | Topic                                           |
 | ------------------------------------------ | ----------------------------------------------- |
-| [dialogue.md](./dialogue.md)               | Реплики, speakers, wall / meet                  |
+| [dialogue.md](./dialogue.md)               | Lines, speakers, wall / meet                    |
 | [flow.md](./flow.md)                       | `stack`, `scenario`, `pause`, `save`            |
 | [vars.md](./vars.md)                       | `flag`, `counter`                               |
 | [choose.md](./choose.md)                   | `% choose`                                      |
 | [point-and-click.md](./point-and-click.md) | `% point-and-click`                             |
 | [qte-random.md](./qte-random.md)           | `% qte`, `% random`                             |
 | [audio.md](./audio.md)                     | `$ audio.*`                                     |
-| [canvas.md](./canvas.md)                   | слои `bl` / `fl` / `ml` / `ul`                  |
+| [canvas.md](./canvas.md)                   | Layers `bl` / `fl` / `ml` / `ul`                |
 | [views.md](./views.md)                     | interface, screens, video, comment, achievement |
 
-## Структура файла
+## File shape
 
 ```vne
 import tests/stack
 
 label init:
-  "Стартовая реплика"
+  "Opening line"
   $ stack jump prologue/1
 
 label prologue/1:
-  fl "Реплика персонажа"
+  fl "Character line"
 ```
 
-- **`import <path>`** — подключить другой `.vne` (путь без расширения, относительно каталога scenario).
-- **`label <name>:`** — метка; к ней прыгают через `$ stack jump/call` и `$ scenario goto`.
-- Отступы (indent) задают тело блоков (`% choose`, `% flag`, …).
+- **`import <path>`** — load another `.vne` (path without the extension, relative to the scenario folder).
+- **`label <name>:`** — a label. Jump to it with `$ stack jump/call` and `$ scenario goto`.
+- Indent is the body of a block (`% choose`, `% flag`, …).
 
-## Типы строк
+## Line kinds
 
-| Вид    | Пример                     | Смысл                             |
-| ------ | -------------------------- | --------------------------------- |
-| Диалог | `"Текст"` или `fl "Текст"` | Модуль `other` (без `$`)          |
-| Модуль | `$ flag seen`              | Префикс `$` — вызов модуля        |
-| Блок   | `% choose`                 | Префикс `%` — блок с indent-телом |
+| Kind   | Example                 | Meaning                                     |
+| ------ | ----------------------- | ------------------------------------------- |
+| Dialog | `"Text"` or `fl "Text"` | Module `other` (no `$`)                     |
+| Module | `$ flag seen`           | Prefix `$` calls a module                   |
+| Block  | `% choose`              | Prefix `%` is a block with an indented body |
 
-## Keywords строки
+## Line keywords
 
-После `|` на той же строке (общие для сценария):
+After `|` on the same line (shared by the scenario):
 
-| Keyword            | Смысл                                               |
-| ------------------ | --------------------------------------------------- |
-| `async`            | Не блокировать продвижение, пока строка выполняется |
-| `autonext`         | Автопереход дальше после строки                     |
-| `skip-if-possible` | Пропустить строку, если движок может                |
+| Keyword            | Meaning                                  |
+| ------------------ | ---------------------------------------- |
+| `async`            | Do not block advance while the line runs |
+| `autonext`         | Advance automatically after the line     |
+| `skip-if-possible` | Skip the line when the engine can        |
 
-Доменные keywords живут в плагинах, например `| global` (vars), `| qte-fallback` (choose↔qte), `| extend` (text).
+Domain keywords live in plugins, for example `| global` (vars), `| qte-fallback` (choose↔qte), `| extend` (text).
 
-## Props в indent
+## Indent props
 
-Под блоками и опциями часто встречаются свойства:
+Blocks and options often use props:
 
 ```vne
-% choose.option "Осмотреть"
+% choose.option "Look around"
   hided: $ flag seen
   disabled: $ counter n > 3
   qte: easy
 ```
 
-- **`hided:`** — скрыть опцию, если условие истинно.
-- **`disabled:`** — показать, но недоступна.
-- Условие — обычно `$ flag …` / `$ counter …` (иногда с `| global`).
+- **`hided:`** — hide the option when the condition is true.
+- **`disabled:`** — show the option, but keep it unavailable.
+- The condition is usually `$ flag …` / `$ counter …` (sometimes with `| global`).
 
-## Комментарии
+## Comments
 
 ```vne
-# комментарий
-// тоже комментарий
+# comment
+// also a comment
 ```
 
-## Дальше
+## Next
 
-Начните с [dialogue.md](./dialogue.md) и [flow.md](./flow.md), затем ветвления ([choose.md](./choose.md)) и медиа ([canvas.md](./canvas.md), [audio.md](./audio.md)).
+Start with [dialogue.md](./dialogue.md) and [flow.md](./flow.md). Then branches ([choose.md](./choose.md)) and media ([canvas.md](./canvas.md), [audio.md](./audio.md)).

package/scenario.guide/audio.md

@@ -1,15 +1,15 @@
-# Аудио: $ audio.*
+# Audio: $ audio.*
 
-Четыре канала с одинаковым набором действий:
+Four channels share the same actions:
 
-| Модуль            | Назначение   |
-| ----------------- | ------------ |
-| `$ audio.music`   | Музыка / BGM |
-| `$ audio.ambient` | Амбиент      |
-| `$ audio.sound`   | SFX          |
-| `$ audio.voice`   | Голос        |
+| Module            | Role        |
+| ----------------- | ----------- |
+| `$ audio.music`   | Music / BGM |
+| `$ audio.ambient` | Ambient     |
+| `$ audio.sound`   | SFX         |
+| `$ audio.voice`   | Voice       |
 
-## Действия
+## Actions
 
 `play`, `stop`, `pause`, `resume`, `volume`
 
@@ -22,8 +22,8 @@ $ audio.music volume 0.5
 $ audio.music stop
 ```
 
-Точные аргументы после `play` (id трека, fade и т.д.) зависят от контента и контракта audio; смотрите примеры в `games/*/game/**/scenario/`.
+The exact args after `play` (track id, fade, and so on) depend on the content and the audio contract. See examples in `games/*/game/**/scenario/`.
 
-## См. также
+## See also
 
 - [`../plugins/audio/music.md`](../plugins/audio/music.md), [`ambient.md`](../plugins/audio/ambient.md), [`sound.md`](../plugins/audio/sound.md), [`voice.md`](../plugins/audio/voice.md)

package/scenario.guide/canvas.md

@@ -1,28 +1,28 @@
-# Canvas-слои: bl / fl / ml / ul
+# Canvas layers: bl / fl / ml / ul
 
-Команды вида `$ <layer>.<kind> <action> …`.
+Commands look like `$ <layer>.<kind> <action> …`.
 
-## Слои
+## Layers
 
-| Префикс | Обычный смысл                     |
-| ------- | --------------------------------- |
-| `bl`    | Back layer (фон, дальние объекты) |
-| `ml`    | Middle                            |
-| `fl`    | Front / персонажи часто здесь     |
-| `ul`    | UI / верхний слой                 |
+| Prefix | Usual meaning                        |
+| ------ | ------------------------------------ |
+| `bl`   | Back layer (background, far objects) |
+| `ml`   | Middle                               |
+| `fl`   | Front / characters often live here   |
+| `ul`   | UI / the top layer                   |
 
-Состав `kind` зависит от слоя (например у `ul` может не быть `video`). Типичные kind:
+Which `kind` values exist depends on the layer (for example `ul` may have no `video`). Typical kinds:
 
-| Kind                                               | Действия (часто)                      |
-| -------------------------------------------------- | ------------------------------------- |
-| `bg`                                               | `show`, `hide`, `change`              |
-| `sprite`                                           | `show`, `hide`, `change`, `move`      |
-| `video`                                            | `show`, `hide`, `change`              |
-| `text`                                             | `show`, `hide`, `change`, `move`      |
-| `fill`                                             | `show`, `change`, `hide`              |
-| `filter` / `scale` / `clip` / `mask` / `animation` | `set` / `unset` (у mask ещё `change`) |
+| Kind                                               | Actions (often)                          |
+| -------------------------------------------------- | ---------------------------------------- |
+| `bg`                                               | `show`, `hide`, `change`                 |
+| `sprite`                                           | `show`, `hide`, `change`, `move`         |
+| `video`                                            | `show`, `hide`, `change`                 |
+| `text`                                             | `show`, `hide`, `change`, `move`         |
+| `fill`                                             | `show`, `change`, `hide`                 |
+| `filter` / `scale` / `clip` / `mask` / `animation` | `set` / `unset` (mask also has `change`) |
 
-## Примеры
+## Examples
 
 ```vne
 $ bl.bg show {castle/hospital_room}
@@ -36,11 +36,11 @@ $ bl.mask set …
 $ bl.animation set …
 ```
 
-Число после bg/sprite часто — длительность перехода (мс). Id медиа в `{…}`.
+The number after bg/sprite is often the transition duration (ms). Media ids sit in `{…}`.
 
-Не копируйте документацию на каждый слой: паттерн один — меняется только префикс `bl` / `fl` / `ml` / `ul`.
+Do not copy the docs for every layer. The pattern is one pattern. Only the prefix changes: `bl` / `fl` / `ml` / `ul`.
 
-## См. также
+## See also
 
-- Слои: [`../plugins/canvas.layers/bl.md`](../plugins/canvas.layers/bl.md), [`fl.md`](../plugins/canvas.layers/fl.md), [`ml.md`](../plugins/canvas.layers/ml.md), [`ul.md`](../plugins/canvas.layers/ul.md)
+- Layers: [`../plugins/canvas.layers/bl.md`](../plugins/canvas.layers/bl.md), [`fl.md`](../plugins/canvas.layers/fl.md), [`ml.md`](../plugins/canvas.layers/ml.md), [`ul.md`](../plugins/canvas.layers/ul.md)
 - Kind: [`../plugins/canvas/bg.md`](../plugins/canvas/bg.md), [`sprite.md`](../plugins/canvas/sprite.md), …

package/scenario.guide/choose.md

@@ -1,56 +1,56 @@
-# Выбор: % choose
+# Choice: % choose
 
-Меню опций. UI рисует view-плагин; логика веток — здесь.
+An option menu. A view plugin draws the UI. Branch logic lives here.
 
 ```vne
 % choose
-  title: "Меню"
-  % choose.option "Осмотреть"
+  title: "Menu"
+  % choose.option "Look around"
     hided: $ flag seen
     $ flag seen
-    "Осмотрели."
+    "Looked around."
     $ choose repeat
-  % choose.option "Уйти"
-    "Уходим."
-# дальше — когда repeat больше не нужен / все option скрыты
+  % choose.option "Leave"
+    "We leave."
+# next — when repeat is no longer needed / every option is hidden
 ```
 
-## Команды
+## Commands
 
-| Синтаксис             | Смысл                                                     |
-| --------------------- | --------------------------------------------------------- |
-| `% choose`            | Открыть выбор; собрать `% choose.option`                  |
-| `% choose.option "…"` | Ветка; невыбранные пропускаются по indent                 |
-| `$ choose repeat`     | Вернуться к ближайшему `% choose` **выше** в той же метке |
+| Syntax                | Meaning                                                      |
+| --------------------- | ------------------------------------------------------------ |
+| `% choose`            | Open the choice and collect `% choose.option`                |
+| `% choose.option "…"` | A branch. Unpicked options are skipped by indent             |
+| `$ choose repeat`     | Return to the nearest `% choose` **above** in the same label |
 
-Если все опции `hided` (или список пуст) — блок пропускается.
+When every option is `hided` (or the list is empty), the block is skipped.
 
-Опционально у блока: `title: "…"` — заголовок над опциями (рисует `views.scenario.choose`).
+Optional on the block: `title: "…"` — a title above the options (drawn by `views.scenario.choose`).
 
-## Props и keywords опции
+## Option props and keywords
 
 ```vne
 % choose
-  % choose.option "С QTE"
+  % choose.option "With QTE"
     qte: easy
-    "Успех — эта ветка"
+    "Success — this branch"
   % choose.option "Fallback" | qte-fallback
-    "Прямой выбор или fail QTE"
-  % choose.option "Скрытая"
+    "A direct pick, or a failed QTE"
+  % choose.option "Hidden"
     hided: $ flag done
-  % choose.option "Недоступная"
+  % choose.option "Unavailable"
     disabled: $ flag locked
 ```
 
-- **`hided:`** / **`disabled:`** — условия видимости/доступности.
-- **`qte: <id>`** — перед входом в ветку запустить QTE (нужен compatibility choose↔qte в бандле).
-- **`| qte-fallback`** — ветка при провале QTE.
+- **`hided:`** / **`disabled:`** — visibility and availability conditions.
+- **`qte: <id>`** — run a QTE before entering the branch (the bundle needs choose↔qte compatibility).
+- **`| qte-fallback`** — the branch used when the QTE fails.
 
-## Цикл «осмотреть → меню»
+## The "look around, then menu" loop
 
-Паттерн: в каждой опции осмотра ставить флаг и `$ choose repeat`; когда всё осмотрено (`hided`), choose сам уйдёт дальше.
+Pattern: in each look option, set a flag and `$ choose repeat`. When everything is seen (`hided`), choose moves on by itself.
 
-## См. также
+## See also
 
 - [`../plugins/scenario/choose.md`](../plugins/scenario/choose.md)
 - View: [`../plugins/views.scenario/choose.md`](../plugins/views.scenario/choose.md)

package/scenario.guide/dialogue.md

@@ -1,58 +1,58 @@
-# Диалог и текст
+# Dialogue and text
 
-Строки без `$` / `%` — реплики (модуль `other`, плагин text).
+A line with no `$` / `%` is dialogue (module `other`, the text plugin).
 
-## Базовый диалог
+## Basic dialogue
 
 ```vne
-"Наррация от третьего лица."
-fl "Реплика персонажа с id fl."
-co "Реплика Коралины."
+"Third-person narration."
+fl "Line for the speaker id fl."
+co "Coraline's line."
 ```
 
-- Строка в кавычках без speaker id — наррация / «other».
-- `<speaker> "…"` — реплика с именем спикера (id из конфига игры).
+- A quoted line with no speaker id is narration / "other".
+- `<speaker> "…"` is a line for that speaker (the id comes from the game config).
 
-## Postfix и inject
+## Postfix and inject
 
 ```vne
-fl "Мне всегда нравилось твоё имя."
+fl "I always liked your name."
   postfix: nod
 
-% choose.option "А сейчас счетчик равен testsCounter"
+% choose.option "The counter is testsCounter"
   inject:
     $ counter testsCounter
 ```
 
-- **`postfix:`** — доп. токен к реплике (жесты, вариации — зависит от бандла/контента).
-- **`inject:`** — подставить значение в текст опции/строки через exec.
+- **`postfix:`** — an extra token on the line (gestures, variants — depends on the bundle and the content).
+- **`inject:`** — put a value into the option or line text through exec.
 
 ## text.meet
 
-Зафиксировать «знакомство» со спикером (имя в UI и т.п.):
+Record that the player has met the speaker (the name in the UI, and similar):
 
 ```vne
 $ text.meet fl
-fl "Нога заживёт."
+fl "The leg will heal."
 ```
 
-Сигнатура: `$ text.meet <speakerId>`.
+Signature: `$ text.meet <speakerId>`.
 
 ## text.wall
 
-Стена текста (многострочный блок на экране):
+A wall of text (a multi-line block on screen):
 
 ```vne
 $ text.wall start
-"Первый абзац"
-"Второй абзац"
+"First paragraph"
+"Second paragraph"
 $ text.wall end
 $ text.wall clear
 ```
 
-Действия: `start`, `end`, `clear`.
+Actions: `start`, `end`, `clear`.
 
-## См. также
+## See also
 
-- Плагины: [`../plugins/text/text.md`](../plugins/text/text.md), [`meet.md`](../plugins/text/meet.md), [`wall.md`](../plugins/text/wall.md)
-- Каталог: [`../scenario.catalog/stubs/other.md`](../scenario.catalog/stubs/other.md)
+- Plugins: [`../plugins/text/text.md`](../plugins/text/text.md), [`meet.md`](../plugins/text/meet.md), [`wall.md`](../plugins/text/wall.md)
+- Catalog: [`../scenario.catalog/stubs/other.md`](../scenario.catalog/stubs/other.md)

package/scenario.guide/flow.md

@@ -1,6 +1,6 @@
-# Поток сценария: stack, scenario, pause, save
+# Scenario flow: stack, scenario, pause, save
 
-## stack — переходы по меткам
+## stack — jumps between labels
 
 ```vne
 $ stack jump prologue/3
@@ -8,15 +8,15 @@ $ stack call testsStackSubroutine
 $ stack pop
 ```
 
-| Действие       | Смысл                                                                        |
-| -------------- | ---------------------------------------------------------------------------- |
-| `jump <label>` | Перейти на метку **без** сохранения возврата                                 |
-| `call <label>` | Push текущей позиции, затем переход; в конце метки обычно `pop` или auto-pop |
-| `pop`          | Вернуться к сохранённой позиции                                              |
+| Action         | Meaning                                                                             |
+| -------------- | ----------------------------------------------------------------------------------- |
+| `jump <label>` | Go to the label and do not save a return point                                      |
+| `call <label>` | Push the current position, then jump. The label usually ends with `pop` or auto-pop |
+| `pop`          | Return to the saved position                                                        |
 
-`call` может передавать аргументы (см. тесты `tests/stack` в играх).
+`call` can pass arguments (see the `tests/stack` tests in the games).
 
-## scenario — якоря внутри метки
+## scenario — anchors inside a label
 
 ```vne
 $ scenario anchor loop_start
@@ -24,10 +24,10 @@ $ scenario anchor loop_start
 $ scenario goto loop_start
 ```
 
-| Действие        | Смысл                             |
-| --------------- | --------------------------------- |
-| `anchor <name>` | Именованная точка в текущей метке |
-| `goto <name>`   | Перейти к якорю (в той же метке)  |
+| Action          | Meaning                            |
+| --------------- | ---------------------------------- |
+| `anchor <name>` | A named point in the current label |
+| `goto <name>`   | Jump to the anchor (same label)    |
 
 ## pause
 
@@ -36,21 +36,21 @@ $ pause
 $ pause 300
 ```
 
-Пауза сценария до клика или на `time` миллисекунд.
+Pause the scenario until a click, or for `time` milliseconds.
 
 ## save
 
 ```vne
-$ save key "Глава: «Пробуждение в кошмаре»"
+$ save key "Chapter: Waking in a nightmare"
 $ save.auto
 ```
 
-| Команда          | Смысл                                |
-| ---------------- | ------------------------------------ |
-| `$ save key "…"` | Задать ключ/подпись слота сохранения |
-| `$ save.auto`    | Автосохранение                       |
+| Command          | Meaning                          |
+| ---------------- | -------------------------------- |
+| `$ save key "…"` | Set the save slot key or caption |
+| `$ save.auto`    | Autosave                         |
 
-## Типичный каркас
+## A typical frame
 
 ```vne
 label init:
@@ -65,7 +65,7 @@ label prologue/1:
   $ stack jump prologue/2
 ```
 
-## См. также
+## See also
 
 - [`../plugins/core/stack.md`](../plugins/core/stack.md), [`scenario.md`](../plugins/core/scenario.md)
 - [`../plugins/scenario/pause.md`](../plugins/scenario/pause.md)

package/scenario.guide/point-and-click.md

@@ -1,6 +1,6 @@
 # Point-and-click: % point-and-click
 
-Hotspot-выбор на фоне. UI — view-плагин; ветки — как у choose.
+A hotspot choice on the background. The UI is a view plugin. Branches work like choose.
 
 ```vne
 % point-and-click
@@ -9,31 +9,31 @@ Hotspot-выбор на фоне. UI — view-плагин; ветки — ка
     imgHeight: 60
     hided: $ flag pac_1
     $ flag pac_1
-    "Нашли предмет."
+    "Found an item."
     $ point-and-click repeat
   % point-and-click.option {search} {search-hover} 50 50
     imgWidth: 60
     imgHeight: 60
     hided: $ flag pac_2
     $ flag pac_2
-    "Другая точка."
+    "Another spot."
     $ point-and-click repeat
-"Все точки осмотрены — сценарий продолжается."
+"Every spot is checked — the scenario continues."
 ```
 
-## Команды
+## Commands
 
-| Синтаксис                                         | Смысл                                           |
+| Syntax                                            | Meaning                                         |
 | ------------------------------------------------- | ----------------------------------------------- |
-| `% point-and-click`                               | Открыть режим; собрать `.option`                |
-| `% point-and-click.option {icon} {iconHover} x y` | Hotspot: иконка, hover-иконка и координаты      |
-| `$ point-and-click repeat`                        | Вернуться к ближайшему `% point-and-click` выше |
+| `% point-and-click`                               | Open the mode and collect `.option`             |
+| `% point-and-click.option {icon} {iconHover} x y` | A hotspot: icon, hover icon, and coordinates    |
+| `$ point-and-click repeat`                        | Return to the nearest `% point-and-click` above |
 
-`x` / `y` — числа (проценты/координаты UI — по конвенции игры). `{icon}` / `{iconHover}` — id иконок из `media/icons/.../point_and_click/`.
+`x` / `y` are numbers (percent or UI coordinates — by the game convention). `{icon}` / `{iconHover}` are icon ids from `media/icons/.../point_and_click/`.
 
-Props `hided:` / `disabled:` — как у choose. Опционально `imgWidth:` / `imgHeight:` — размер hotspot в пикселях canvas.
+Props `hided:` / `disabled:` work like choose. Optional `imgWidth:` / `imgHeight:` set the hotspot size in canvas pixels.
 
-## См. также
+## See also
 
 - [`../plugins/scenario/point_and_click.md`](../plugins/scenario/point_and_click.md)
 - View: [`../plugins/views.scenario/point_and_click.md`](../plugins/views.scenario/point_and_click.md)