@vnejs/docs 0.2.65 → 0.2.66
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.
- package/README.md +35 -35
- package/architecture/backends.md +18 -0
- package/architecture/build.md +37 -0
- package/architecture/bundles.md +20 -0
- package/architecture/cli.md +25 -0
- package/architecture/compatibility.md +22 -0
- package/architecture/configs.md +19 -0
- package/architecture/contracts.md +30 -0
- package/architecture/dependencies.md +55 -0
- package/architecture/editor.md +7 -0
- package/architecture/games.md +38 -0
- package/architecture/helpers.md +14 -0
- package/architecture/model.md +43 -0
- package/architecture/modules.md +87 -0
- package/architecture/packages.md +43 -0
- package/architecture/plugins.md +36 -0
- package/architecture/uis.md +23 -0
- package/changelog/0.2.18.md +7 -0
- package/changelog/0.2.19.md +14 -0
- package/changelog/0.2.20.md +10 -0
- package/changelog/0.2.21.md +5 -0
- package/changelog/0.2.22.md +11 -0
- package/changelog/0.2.23.md +4 -0
- package/changelog/0.2.25.md +6 -0
- package/changelog/0.2.26.md +12 -0
- package/changelog/0.2.29.md +10 -0
- package/changelog/0.2.31.md +5 -0
- package/changelog/0.2.32.md +3 -0
- package/changelog/0.2.33.md +5 -0
- package/changelog/0.2.34.md +8 -0
- package/changelog/0.2.35.md +33 -0
- package/changelog/0.2.36.md +10 -0
- package/changelog/0.2.38.md +19 -0
- package/changelog/0.2.39.md +16 -0
- package/changelog/0.2.40.md +9 -0
- package/changelog/0.2.42.md +3 -0
- package/changelog/0.2.43.md +10 -0
- package/changelog/0.2.46.md +3 -0
- package/changelog/0.2.47.md +25 -0
- package/changelog/0.2.49.md +3 -0
- package/changelog/0.2.50.md +6 -0
- package/changelog/0.2.51.md +6 -0
- package/changelog/0.2.52.md +5 -0
- package/changelog/0.2.53.md +12 -0
- package/changelog/0.2.55.md +19 -0
- package/changelog/0.2.56.md +11 -0
- package/changelog/0.2.57.md +7 -0
- package/changelog/0.2.58.md +8 -0
- package/changelog/0.2.59.md +6 -0
- package/changelog/0.2.60.md +5 -0
- package/changelog/0.2.61.md +11 -0
- package/changelog/0.2.62.md +8 -0
- package/changelog/0.2.63.md +4 -0
- package/changelog/0.2.64.md +4 -0
- package/changelog/0.2.65.md +3 -0
- package/changelog/0.2.66.md +5 -0
- package/changelog/README.md +43 -0
- package/manifest.json +66 -5
- package/package.json +6 -4
- package/plugins/ai/ai.md +29 -29
- package/plugins/ai/checkers.md +26 -26
- package/plugins/audio/ambient.md +20 -20
- package/plugins/audio/audio.md +40 -40
- package/plugins/audio/music.md +20 -20
- package/plugins/audio/sound.md +20 -20
- package/plugins/audio/voice.md +23 -23
- package/plugins/canvas/bg.md +44 -44
- package/plugins/canvas/bg.speak.md +34 -34
- package/plugins/canvas/fill.md +33 -33
- package/plugins/canvas/layer.md +35 -35
- package/plugins/canvas/sprite.md +46 -46
- package/plugins/canvas/sprite.speak.md +33 -33
- package/plugins/canvas/text.md +37 -37
- package/plugins/canvas/video.md +37 -37
- package/plugins/canvas.layers/bl.md +33 -33
- package/plugins/canvas.layers/fl.md +33 -33
- package/plugins/canvas.layers/ml.md +33 -33
- package/plugins/canvas.layers/ul.md +32 -32
- package/plugins/canvas.props/animation.md +25 -25
- package/plugins/canvas.props/clip.md +22 -22
- package/plugins/canvas.props/filters.md +20 -20
- package/plugins/canvas.props/mask.md +23 -23
- package/plugins/canvas.props/scale.md +20 -20
- package/plugins/common/grid.md +23 -23
- package/plugins/common/turn.md +18 -18
- package/plugins/controls/controls.md +31 -31
- package/plugins/controls/cursor.md +54 -54
- package/plugins/controls/gamepad.md +56 -56
- package/plugins/controls/keyboard.md +17 -17
- package/plugins/core/components.md +28 -28
- package/plugins/core/interact.md +26 -26
- package/plugins/core/logs.md +28 -28
- package/plugins/core/media.md +38 -38
- package/plugins/core/memory.md +28 -28
- package/plugins/core/platforms.md +19 -19
- package/plugins/core/scenario.md +48 -48
- package/plugins/core/settings.md +24 -24
- package/plugins/core/stack.md +39 -39
- package/plugins/core/state.md +30 -30
- package/plugins/core/storage.md +56 -56
- package/plugins/core/system.md +37 -37
- package/plugins/core/vendors.md +19 -19
- package/plugins/entities/entities.md +16 -16
- package/plugins/entities/wallet.md +27 -27
- package/plugins/font/montserrat.md +16 -16
- package/plugins/game/checkers.md +38 -38
- package/plugins/platform/android.md +17 -17
- package/plugins/platform/electron.md +21 -21
- package/plugins/platform/metric.md +23 -23
- package/plugins/rpg/damage.md +22 -22
- package/plugins/rpg/hit.md +24 -24
- package/plugins/rpg/skills.md +26 -26
- package/plugins/save/auto.md +26 -26
- package/plugins/save/continue.md +23 -23
- package/plugins/save/quick.md +24 -24
- package/plugins/save/save.md +37 -37
- package/plugins/scales/health.md +17 -17
- package/plugins/scales/mana.md +17 -17
- package/plugins/scales/scales.md +31 -31
- package/plugins/scenario/autoread.md +36 -36
- package/plugins/scenario/choose.md +74 -65
- package/plugins/scenario/fastforward.md +46 -46
- package/plugins/scenario/history.md +41 -41
- package/plugins/scenario/pause.md +27 -27
- package/plugins/scenario/point_and_click.md +51 -51
- package/plugins/scenario/qte.md +54 -54
- package/plugins/scenario/random.md +17 -17
- package/plugins/settings/filter.md +19 -19
- package/plugins/settings/potato.md +22 -22
- package/plugins/settings/ratio.md +19 -19
- package/plugins/settings/textsize.md +19 -19
- package/plugins/settings/volume.md +21 -21
- package/plugins/text/inject.md +22 -22
- package/plugins/text/locs.md +36 -36
- package/plugins/text/meet.md +19 -19
- package/plugins/text/smooth.md +33 -33
- package/plugins/text/text.md +76 -69
- package/plugins/text/wall.md +20 -20
- package/plugins/time/date.md +22 -22
- package/plugins/time/time.md +23 -23
- package/plugins/vars/counters.md +28 -28
- package/plugins/vars/flags.md +24 -24
- package/plugins/vars/vars.md +29 -29
- package/plugins/views/achievement.md +44 -44
- package/plugins/views/comment.md +31 -31
- package/plugins/views/controls.hints.md +34 -34
- package/plugins/views/cursor.md +19 -19
- package/plugins/views/fps.md +33 -33
- package/plugins/views/gamepad.debug.md +32 -32
- package/plugins/views/settings.md +39 -39
- package/plugins/views/video.md +37 -37
- package/plugins/views.scenario/choose.md +41 -41
- package/plugins/views.scenario/interface.controls.md +31 -31
- package/plugins/views.scenario/interface.fastforward.md +29 -29
- package/plugins/views.scenario/interface.md +74 -74
- package/plugins/views.scenario/point_and_click.md +39 -39
- package/plugins/views.scenario/qte.md +51 -51
- package/plugins/views.screens/checkers.md +35 -35
- package/plugins/views.screens/confirm.md +35 -35
- package/plugins/views.screens/credits.md +31 -31
- package/plugins/views.screens/disclaimer.md +42 -42
- package/plugins/views.screens/eula.md +37 -37
- package/plugins/views.screens/gallery.full.md +41 -41
- package/plugins/views.screens/gallery.md +75 -75
- package/plugins/views.screens/gamemenu.md +41 -41
- package/plugins/views.screens/history.md +39 -39
- package/plugins/views.screens/intro.md +32 -32
- package/plugins/views.screens/loading.md +30 -30
- package/plugins/views.screens/mainmenu.md +49 -49
- package/plugins/views.screens/mainmenu.socials.md +25 -25
- package/plugins/views.screens/save.md +66 -66
- package/plugins/views.screens/settings.defaults.md +37 -37
- package/plugins/views.screens/settings.md +40 -40
- package/scenario.catalog/README.md +13 -13
- package/scenario.catalog/index.md +35 -35
- package/scenario.catalog/stubs/achievement.md +4 -4
- package/scenario.catalog/stubs/audio.ambient.md +4 -4
- package/scenario.catalog/stubs/audio.music.md +4 -4
- package/scenario.catalog/stubs/audio.sound.md +4 -4
- package/scenario.catalog/stubs/audio.voice.md +4 -4
- package/scenario.catalog/stubs/bl.animation.md +5 -5
- package/scenario.catalog/stubs/bl.bg.md +5 -5
- package/scenario.catalog/stubs/bl.clip.md +5 -5
- package/scenario.catalog/stubs/bl.fill.md +5 -5
- package/scenario.catalog/stubs/bl.filter.md +5 -5
- package/scenario.catalog/stubs/bl.mask.md +5 -5
- package/scenario.catalog/stubs/bl.scale.md +5 -5
- package/scenario.catalog/stubs/bl.sprite.md +5 -5
- package/scenario.catalog/stubs/bl.text.md +5 -5
- package/scenario.catalog/stubs/bl.video.md +5 -5
- package/scenario.catalog/stubs/choose.block.md +7 -7
- package/scenario.catalog/stubs/choose.md +4 -4
- package/scenario.catalog/stubs/choose.option.md +7 -7
- package/scenario.catalog/stubs/comment.md +5 -5
- package/scenario.catalog/stubs/counter.md +5 -5
- package/scenario.catalog/stubs/credits.md +4 -4
- package/scenario.catalog/stubs/date.md +4 -4
- package/scenario.catalog/stubs/disclaimer.md +5 -5
- package/scenario.catalog/stubs/fl.animation.md +5 -5
- package/scenario.catalog/stubs/fl.bg.md +5 -5
- package/scenario.catalog/stubs/fl.clip.md +5 -5
- package/scenario.catalog/stubs/fl.fill.md +5 -5
- package/scenario.catalog/stubs/fl.filter.md +5 -5
- package/scenario.catalog/stubs/fl.mask.md +5 -5
- package/scenario.catalog/stubs/fl.scale.md +5 -5
- package/scenario.catalog/stubs/fl.sprite.md +5 -5
- package/scenario.catalog/stubs/fl.text.md +5 -5
- package/scenario.catalog/stubs/fl.video.md +5 -5
- package/scenario.catalog/stubs/flag.md +13 -13
- package/scenario.catalog/stubs/interface.md +4 -4
- package/scenario.catalog/stubs/intro.md +4 -4
- package/scenario.catalog/stubs/mainmenu.md +4 -4
- package/scenario.catalog/stubs/ml.animation.md +5 -5
- package/scenario.catalog/stubs/ml.bg.md +5 -5
- package/scenario.catalog/stubs/ml.clip.md +5 -5
- package/scenario.catalog/stubs/ml.fill.md +5 -5
- package/scenario.catalog/stubs/ml.filter.md +5 -5
- package/scenario.catalog/stubs/ml.mask.md +5 -5
- package/scenario.catalog/stubs/ml.scale.md +5 -5
- package/scenario.catalog/stubs/ml.sprite.md +5 -5
- package/scenario.catalog/stubs/ml.text.md +5 -5
- package/scenario.catalog/stubs/ml.video.md +5 -5
- package/scenario.catalog/stubs/other.md +6 -6
- package/scenario.catalog/stubs/pause.md +5 -5
- package/scenario.catalog/stubs/point-and-click.block.md +4 -4
- package/scenario.catalog/stubs/point-and-click.md +4 -4
- package/scenario.catalog/stubs/point-and-click.option.md +4 -4
- package/scenario.catalog/stubs/qte.md +4 -4
- package/scenario.catalog/stubs/random.md +4 -4
- package/scenario.catalog/stubs/random.option.md +4 -4
- package/scenario.catalog/stubs/save.auto.md +4 -4
- package/scenario.catalog/stubs/save.md +5 -5
- package/scenario.catalog/stubs/scenario.md +4 -4
- package/scenario.catalog/stubs/settings.defaults.md +4 -4
- package/scenario.catalog/stubs/stack.md +4 -4
- package/scenario.catalog/stubs/text.meet.md +4 -4
- package/scenario.catalog/stubs/text.wall.md +4 -4
- package/scenario.catalog/stubs/time.md +4 -4
- package/scenario.catalog/stubs/ul.animation.md +5 -5
- package/scenario.catalog/stubs/ul.bg.md +5 -5
- package/scenario.catalog/stubs/ul.clip.md +5 -5
- package/scenario.catalog/stubs/ul.fill.md +5 -5
- package/scenario.catalog/stubs/ul.filter.md +5 -5
- package/scenario.catalog/stubs/ul.mask.md +5 -5
- package/scenario.catalog/stubs/ul.scale.md +5 -5
- package/scenario.catalog/stubs/ul.sprite.md +5 -5
- package/scenario.catalog/stubs/ul.text.md +5 -5
- package/scenario.catalog/stubs/video.md +4 -4
- package/scenario.catalog/stubs/wallet.md +4 -4
- package/scenario.guide/README.md +38 -38
- package/scenario.guide/audio.md +11 -11
- package/scenario.guide/canvas.md +23 -23
- package/scenario.guide/choose.md +28 -28
- package/scenario.guide/dialogue.md +23 -23
- package/scenario.guide/flow.md +21 -21
- package/scenario.guide/point-and-click.md +12 -12
- package/scenario.guide/qte-random.md +20 -20
- package/scenario.guide/vars.md +19 -19
- package/scenario.guide/views.md +20 -20
- package/CHANGELOG.md +0 -387
- package/architecture.md +0 -566
package/plugins/core/system.md
CHANGED
|
@@ -1,58 +1,58 @@
|
|
|
1
1
|
# plugins/core/system/
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package: `@vnejs/plugins.core.system` · namespace: `SYSTEM`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Application lifecycle, DOM anchors, files, resize, engine version.
|
|
6
6
|
|
|
7
|
-
##
|
|
7
|
+
## Events
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
Handler payloads and results are typed through module augmentation of the contract (`VneEventPayloadMap` / `VneEventResultMap`). The types live in `@vnejs/contracts.core.system`.
|
|
10
10
|
|
|
11
|
-
|
|
|
12
|
-
| -------------- | ------------------------- |
|
|
13
|
-
| `RESIZE` | `vne:system:resize` |
|
|
14
|
-
| `RELOAD` | `vne:system:reload` |
|
|
15
|
-
| `FULLSCREEN` | `vne:system:fullscreen` |
|
|
16
|
-
| `CLOSE` | `vne:system:close` |
|
|
17
|
-
| `CLOSE_BEFORE` | `vne:system:close_before` |
|
|
18
|
-
| `FILE_LOAD` | `vne:file:load` |
|
|
19
|
-
| `FILE_READ` | `vne:file:read` | File picker → parse JSON →
|
|
11
|
+
| Key | String | Meaning |
|
|
12
|
+
| -------------- | ------------------------- | -------------------------------------------------------------- |
|
|
13
|
+
| `RESIZE` | `vne:system:resize` | Application window size changed. |
|
|
14
|
+
| `RELOAD` | `vne:system:reload` | Reload the page after the `CLOSE_BEFORE` phase. |
|
|
15
|
+
| `FULLSCREEN` | `vne:system:fullscreen` | Toggle document fullscreen. |
|
|
16
|
+
| `CLOSE` | `vne:system:close` | Close the application window after the `CLOSE_BEFORE` phase. |
|
|
17
|
+
| `CLOSE_BEFORE` | `vne:system:close_before` | Prep phase before page close or reload. |
|
|
18
|
+
| `FILE_LOAD` | `vne:file:load` | Download an object as a JSON file. Payload: `{ obj?, name? }`. |
|
|
19
|
+
| `FILE_READ` | `vne:file:read` | File picker → parse JSON → return contents. |
|
|
20
20
|
|
|
21
|
-
##
|
|
21
|
+
## Constants
|
|
22
22
|
|
|
23
|
-
|
|
|
24
|
-
|
|
|
25
|
-
| `HOST`
|
|
26
|
-
| `VERSION_MAJOR`
|
|
27
|
-
| `VERSION_MINOR`
|
|
28
|
-
| `DOM_IDS.APP`
|
|
29
|
-
| `DOM_IDS.MEDIA`
|
|
30
|
-
| `DOM_IDS.COMPONENTS`
|
|
31
|
-
| `LOGS_ACTIONS.RESIZE` | `"resize"` —
|
|
23
|
+
| Key | Meaning |
|
|
24
|
+
| --------------------- | ---------------------------------------------- |
|
|
25
|
+
| `HOST` | Origin or `http://localhost:{port}` from query |
|
|
26
|
+
| `VERSION_MAJOR` | Major version of the state format (number) |
|
|
27
|
+
| `VERSION_MINOR` | Minor version (number) |
|
|
28
|
+
| `DOM_IDS.APP` | `"app"` — root container |
|
|
29
|
+
| `DOM_IDS.MEDIA` | `"media"` — hidden media container |
|
|
30
|
+
| `DOM_IDS.COMPONENTS` | `"components"` — UI container |
|
|
31
|
+
| `LOGS_ACTIONS.RESIZE` | `"resize"` — log label on `RESIZE` |
|
|
32
32
|
|
|
33
|
-
##
|
|
33
|
+
## Parameters
|
|
34
34
|
|
|
35
|
-
|
|
35
|
+
None.
|
|
36
36
|
|
|
37
|
-
##
|
|
37
|
+
## Settings
|
|
38
38
|
|
|
39
|
-
|
|
39
|
+
None.
|
|
40
40
|
|
|
41
|
-
##
|
|
41
|
+
## Modules
|
|
42
42
|
|
|
43
|
-
|
|
|
44
|
-
| ---------------- |
|
|
45
|
-
| `system` | Reload, close, fullscreen, `CLOSE_BEFORE`.
|
|
46
|
-
| `system.resize` |
|
|
47
|
-
| `system.file` | `FILE_LOAD` / `FILE_READ`.
|
|
48
|
-
| `system.version` | Default state `{ major, minor }`
|
|
43
|
+
| Module | Role |
|
|
44
|
+
| ---------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
|
|
45
|
+
| `system` | Reload, close, fullscreen, `CLOSE_BEFORE`. |
|
|
46
|
+
| `system.resize` | Reacts to window resize; emits `RESIZE`. |
|
|
47
|
+
| `system.file` | `FILE_LOAD` / `FILE_READ`. |
|
|
48
|
+
| `system.version` | Default state `{ major, minor }` for save migration; slice in `ModuleGlobalState["system.version"]` (`ModuleGlobalStateSystemVersion`). |
|
|
49
49
|
|
|
50
|
-
##
|
|
50
|
+
## Related plugins
|
|
51
51
|
|
|
52
52
|
### plugins/core/
|
|
53
53
|
|
|
54
54
|
- [logs.md](./logs.md) — `LOGS`: `EVENTS.LOGS.EMIT` (`action`, …) (resize)
|
|
55
55
|
|
|
56
|
-
###
|
|
56
|
+
### Other
|
|
57
57
|
|
|
58
|
-
—
|
|
58
|
+
— None
|
package/plugins/core/vendors.md
CHANGED
|
@@ -1,41 +1,41 @@
|
|
|
1
1
|
# plugins/core/vendors/
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package: `@vnejs/plugins.core.vendors` · namespace: `VENDORS`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Wrappers over third-party utilities: screenshot.
|
|
6
6
|
|
|
7
|
-
##
|
|
7
|
+
## Events
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
Handler payloads and results are typed through module augmentation of the contract (`VneEventPayloadMap` / `VneEventResultMap`). The types live in `@vnejs/contracts.core.vendors`.
|
|
10
10
|
|
|
11
|
-
|
|
|
11
|
+
| Key | String | Meaning |
|
|
12
12
|
| -------- | -------------------- | ---------------------------------------------------------------------------------------------- |
|
|
13
|
-
| `SCREEN` | `vne:vendors:screen` |
|
|
13
|
+
| `SCREEN` | `vne:vendors:screen` | DOM screenshot via html2canvas → webp data URL. Payload: `{ width?, height?, quality?, id? }`. |
|
|
14
14
|
|
|
15
|
-
##
|
|
15
|
+
## Constants
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
None.
|
|
18
18
|
|
|
19
|
-
##
|
|
19
|
+
## Parameters
|
|
20
20
|
|
|
21
|
-
|
|
21
|
+
None.
|
|
22
22
|
|
|
23
|
-
##
|
|
23
|
+
## Settings
|
|
24
24
|
|
|
25
|
-
|
|
25
|
+
None.
|
|
26
26
|
|
|
27
|
-
##
|
|
27
|
+
## Modules
|
|
28
28
|
|
|
29
|
-
|
|
|
30
|
-
| ---------------- |
|
|
31
|
-
| `vendors.screen` | html2canvas screenshot;
|
|
29
|
+
| Module | Role |
|
|
30
|
+
| ---------------- | ------------------------------------------------------------ |
|
|
31
|
+
| `vendors.screen` | html2canvas screenshot; on init marks media elements ignore. |
|
|
32
32
|
|
|
33
|
-
##
|
|
33
|
+
## Related plugins
|
|
34
34
|
|
|
35
35
|
### plugins/core/
|
|
36
36
|
|
|
37
37
|
- [system.md](./system.md) — `SYSTEM`: `STARTED`; `CONST.SYSTEM.DOM_IDS.MEDIA` (html2canvas ignore)
|
|
38
38
|
|
|
39
|
-
###
|
|
39
|
+
### Other
|
|
40
40
|
|
|
41
|
-
—
|
|
41
|
+
— None
|
|
@@ -1,35 +1,35 @@
|
|
|
1
1
|
# plugins/entities/entities/
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package: `@vnejs/plugins.entities.entities` · namespace: `ENTITIES`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Registers the base entity-system contract.
|
|
6
6
|
|
|
7
|
-
##
|
|
7
|
+
## Events
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
None.
|
|
10
10
|
|
|
11
|
-
##
|
|
11
|
+
## Constants
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
None.
|
|
14
14
|
|
|
15
|
-
##
|
|
15
|
+
## Parameters
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
None.
|
|
18
18
|
|
|
19
|
-
##
|
|
19
|
+
## Settings
|
|
20
20
|
|
|
21
|
-
|
|
21
|
+
None.
|
|
22
22
|
|
|
23
|
-
##
|
|
23
|
+
## Modules
|
|
24
24
|
|
|
25
|
-
|
|
25
|
+
None.
|
|
26
26
|
|
|
27
|
-
##
|
|
27
|
+
## Related plugins
|
|
28
28
|
|
|
29
29
|
### plugins/core/
|
|
30
30
|
|
|
31
|
-
—
|
|
31
|
+
— None
|
|
32
32
|
|
|
33
|
-
###
|
|
33
|
+
### Other
|
|
34
34
|
|
|
35
|
-
—
|
|
35
|
+
— None
|
|
@@ -1,49 +1,49 @@
|
|
|
1
1
|
# plugins/entities/wallet/
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package: `@vnejs/plugins.entities.wallet` · namespace: `WALLET`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Manages wallets and currencies: add, set, and reset from scenario and events.
|
|
6
6
|
|
|
7
|
-
##
|
|
7
|
+
## Events
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
Handler payloads and results are typed through module augmentation of the contract (`VneEventPayloadMap` / `VneEventResultMap`). The types live in `@vnejs/contracts.entities.wallet`.
|
|
10
10
|
|
|
11
|
-
|
|
|
12
|
-
| --------- | -------------------- |
|
|
13
|
-
| `ADD` | `vne:wallet:add` |
|
|
14
|
-
| `SET` | `vne:wallet:set` |
|
|
15
|
-
| `REG` | `vne:wallet:reg` |
|
|
16
|
-
| `RESET` | `vne:wallet:reset` |
|
|
17
|
-
| `CHANGED` | `vne:wallet:changed` |
|
|
11
|
+
| Key | String | Meaning |
|
|
12
|
+
| --------- | -------------------- | ------------------------------- |
|
|
13
|
+
| `ADD` | `vne:wallet:add` | Plugin namespace event `ADD`. |
|
|
14
|
+
| `SET` | `vne:wallet:set` | Write or update a value. |
|
|
15
|
+
| `REG` | `vne:wallet:reg` | Register a handler. |
|
|
16
|
+
| `RESET` | `vne:wallet:reset` | Plugin namespace event `RESET`. |
|
|
17
|
+
| `CHANGED` | `vne:wallet:changed` | Record a state change. |
|
|
18
18
|
|
|
19
|
-
##
|
|
19
|
+
## Constants
|
|
20
20
|
|
|
21
|
-
|
|
21
|
+
None.
|
|
22
22
|
|
|
23
|
-
##
|
|
23
|
+
## Parameters
|
|
24
24
|
|
|
25
|
-
|
|
|
26
|
-
| ------------ | -------- |
|
|
27
|
-
| `CURRENCIES` | `string` |
|
|
28
|
-
| `ITEMS` | `object` |
|
|
25
|
+
| Key | Type | Meaning |
|
|
26
|
+
| ------------ | -------- | ------------------------ |
|
|
27
|
+
| `CURRENCIES` | `string` | Default: `"CURRENCIES"`. |
|
|
28
|
+
| `ITEMS` | `object` | Parameter `ITEMS`. |
|
|
29
29
|
|
|
30
|
-
##
|
|
30
|
+
## Settings
|
|
31
31
|
|
|
32
|
-
|
|
32
|
+
None.
|
|
33
33
|
|
|
34
|
-
##
|
|
34
|
+
## Modules
|
|
35
35
|
|
|
36
|
-
|
|
|
37
|
-
| -------- |
|
|
38
|
-
| `wallet` |
|
|
36
|
+
| Module | Role |
|
|
37
|
+
| -------- | ----------------------- |
|
|
38
|
+
| `wallet` | Handler registry (REG). |
|
|
39
39
|
|
|
40
|
-
##
|
|
40
|
+
## Related plugins
|
|
41
41
|
|
|
42
42
|
### plugins/core/
|
|
43
43
|
|
|
44
44
|
- [scenario.md](../core/scenario.md) — `SCENARIO`: EVENTS.NEXT, EVENTS.LINE_EXEC_REG
|
|
45
45
|
- [state.md](../core/state.md) — `STATE`: EVENTS.SET, EVENTS.CLEAR
|
|
46
46
|
|
|
47
|
-
###
|
|
47
|
+
### Other
|
|
48
48
|
|
|
49
|
-
- [entities.md](./entities.md) —
|
|
49
|
+
- [entities.md](./entities.md) — base namespace `ENTITIES` (parent package)
|
|
@@ -1,35 +1,35 @@
|
|
|
1
1
|
# plugins/font/montserrat/
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package: `@vnejs/plugins.font.montserrat` · namespace: `UNKNOWN`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Loads the Montserrat font via CSS @font-face.
|
|
6
6
|
|
|
7
|
-
##
|
|
7
|
+
## Events
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
None.
|
|
10
10
|
|
|
11
|
-
##
|
|
11
|
+
## Constants
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
None.
|
|
14
14
|
|
|
15
|
-
##
|
|
15
|
+
## Parameters
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
None.
|
|
18
18
|
|
|
19
|
-
##
|
|
19
|
+
## Settings
|
|
20
20
|
|
|
21
|
-
|
|
21
|
+
None.
|
|
22
22
|
|
|
23
|
-
##
|
|
23
|
+
## Modules
|
|
24
24
|
|
|
25
|
-
|
|
25
|
+
None.
|
|
26
26
|
|
|
27
|
-
##
|
|
27
|
+
## Related plugins
|
|
28
28
|
|
|
29
29
|
### plugins/core/
|
|
30
30
|
|
|
31
|
-
—
|
|
31
|
+
— None
|
|
32
32
|
|
|
33
|
-
###
|
|
33
|
+
### Other
|
|
34
34
|
|
|
35
|
-
—
|
|
35
|
+
— None
|
package/plugins/game/checkers.md
CHANGED
|
@@ -1,51 +1,51 @@
|
|
|
1
1
|
# plugins/game/checkers/
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package: `@vnejs/plugins.game.checkers` · namespace: `CHECKERS`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Russian checkers rules and scenario commands `$ checkers`. AI orchestration — in [`ai/checkers`](../ai/checkers.md) (`CHECKERS_AI`). UI — in [`views.screens/checkers`](../views.screens/checkers.md) (`CHECKERS_VIEW`). Board — in [`common/grid`](../common/grid.md) (`GRID`). Side to move — in [`common/turn`](../common/turn.md) (`TURNS`).
|
|
6
6
|
|
|
7
|
-
##
|
|
7
|
+
## Events
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
Handler payloads and results are typed through module augmentation of the contract (`VneEventPayloadMap` / `VneEventResultMap`). The types live in `@vnejs/contracts.game.checkers`.
|
|
10
10
|
|
|
11
|
-
|
|
|
12
|
-
| -------------- | --------------------------- |
|
|
13
|
-
| `SHOW` | `vne:checkers:show` |
|
|
14
|
-
| `HIDE` | `vne:checkers:hide` | `UNSET` +
|
|
15
|
-
| `START` | `vne:checkers:start` |
|
|
16
|
-
| `SET` | `vne:checkers:set` | `{ cells, owner }` → `GRID.SET` + `TURNS.SET` (id / rows / columns
|
|
17
|
-
| `UNSET` | `vne:checkers:unset` | `GRID.UNSET` + `TURNS.UNSET`
|
|
18
|
-
| `STATE_UPDATE` | `vne:checkers:state_update` |
|
|
19
|
-
| `FINISH` | `vne:checkers:finish` |
|
|
20
|
-
| `MOVES_GET` | `vne:checkers:moves_get` | `emitOne`: `{ board, turn }` → `{ moves, hanging, safe }`.
|
|
21
|
-
| `MOVE_PLAY` | `vne:checkers:move_play` | `emitOne`: `{ move, controllerType? }` → `boolean`;
|
|
22
|
-
| `MOVE_PLAYED` | `vne:checkers:move_played` |
|
|
11
|
+
| Key | String | Meaning |
|
|
12
|
+
| -------------- | --------------------------- | ----------------------------------------------------------------------------------------------- |
|
|
13
|
+
| `SHOW` | `vne:checkers:show` | Start: `SET` (`cells` + `owner`) → `START`. Payload: `{ initialOwner?, initialPreset? }`. |
|
|
14
|
+
| `HIDE` | `vne:checkers:hide` | `UNSET` + reset busy sources. |
|
|
15
|
+
| `START` | `vne:checkers:start` | Game ready (listens `CHECKERS_AI` → `INTERACT`). |
|
|
16
|
+
| `SET` | `vne:checkers:set` | `{ cells, owner }` → `GRID.SET` + `TURNS.SET` (id / rows / columns from constants). |
|
|
17
|
+
| `UNSET` | `vne:checkers:unset` | `GRID.UNSET` + `TURNS.UNSET` by `GRID_ID` / `TURN_ID`. |
|
|
18
|
+
| `STATE_UPDATE` | `vne:checkers:state_update` | Patch game state (no board). |
|
|
19
|
+
| `FINISH` | `vne:checkers:finish` | End game: `{ winner }` → delay → `sources.clear()` + `emit SCENARIO.NEXT`. |
|
|
20
|
+
| `MOVES_GET` | `vne:checkers:moves_get` | `emitOne`: `{ board, turn }` → `{ moves, hanging, safe }`. |
|
|
21
|
+
| `MOVE_PLAY` | `vne:checkers:move_play` | `emitOne`: `{ move, controllerType? }` → `boolean`; success → `MOVE_PLAYED` or on win `FINISH`. |
|
|
22
|
+
| `MOVE_PLAYED` | `vne:checkers:move_played` | After a move (from `MOVE_PLAY`); AI loop — in `CHECKERS_AI`. |
|
|
23
23
|
|
|
24
|
-
`MOVE_PLAY`
|
|
24
|
+
`MOVE_PLAY` reads the board via `GRID.GET` and side via `TURNS.GET`; after the move writes `CHECKERS.SET`. Win — only via `FINISH` (`CheckersFinishPayload`).
|
|
25
25
|
|
|
26
|
-
##
|
|
26
|
+
## Constants / Shared / Params
|
|
27
27
|
|
|
28
|
-
|
|
|
29
|
-
| ------------------------------------------ |
|
|
30
|
-
| `EXEC_ACTIONS` / `COLORS` / `COLOR_VALUES` | show/hide; white/black
|
|
31
|
-
| `CONST.CHECKERS.TURN_ID` | `"checkers"` — id
|
|
32
|
-
| `CONST.CHECKERS.GRID_ID` | `"checkers"` — id
|
|
33
|
-
| `shared.checkersInteractDisableSources` | `SourcesSet` —
|
|
34
|
-
| `PARAMS.CHECKERS.FINISH_DELAY` |
|
|
35
|
-
| `PARAMS.CHECKERS.ROWS` / `COLUMNS` | `8` —
|
|
36
|
-
| `PARAMS.CHECKERS.PRESETS` |
|
|
28
|
+
| Key | Meaning |
|
|
29
|
+
| ------------------------------------------ | --------------------------------------------------------------------------- |
|
|
30
|
+
| `EXEC_ACTIONS` / `COLORS` / `COLOR_VALUES` | show/hide; white/black |
|
|
31
|
+
| `CONST.CHECKERS.TURN_ID` | `"checkers"` — id in `TURNS` |
|
|
32
|
+
| `CONST.CHECKERS.GRID_ID` | `"checkers"` — id in `GRID` |
|
|
33
|
+
| `shared.checkersInteractDisableSources` | `SourcesSet` — block interact during AI move |
|
|
34
|
+
| `PARAMS.CHECKERS.FINISH_DELAY` | pause before `emit SCENARIO.NEXT` on `FINISH` (ms, `300`) |
|
|
35
|
+
| `PARAMS.CHECKERS.ROWS` / `COLUMNS` | `8` — size for `GRID.SET` (inside `SET`) |
|
|
36
|
+
| `PARAMS.CHECKERS.PRESETS` | board presets: `COMMON`, `FLIPPED`, `RANDOM` (`RANDOM` anew on each `SHOW`) |
|
|
37
37
|
|
|
38
|
-
##
|
|
38
|
+
## Modules
|
|
39
39
|
|
|
40
|
-
|
|
|
40
|
+
| Module | Role |
|
|
41
41
|
| --------------------------------------- | ------------------------------------------------------ |
|
|
42
42
|
| `checkers` | `$ checkers show/hide` |
|
|
43
43
|
| `checkers.show` | SHOW → `SET` + START; HIDE → `UNSET` |
|
|
44
44
|
| `checkers.set` | `SET` → `GRID`/`TURNS`; `UNSET` → `GRID`/`TURNS` UNSET |
|
|
45
|
-
| `checkers.moves` / `checkers.move.play` |
|
|
46
|
-
| `checkers.finish` | FINISH → delay + `emit SCENARIO.NEXT`
|
|
45
|
+
| `checkers.moves` / `checkers.move.play` | moves; `move.play` → `SET` / `FINISH` |
|
|
46
|
+
| `checkers.finish` | FINISH → delay + `emit SCENARIO.NEXT` |
|
|
47
47
|
|
|
48
|
-
##
|
|
48
|
+
## Scenario
|
|
49
49
|
|
|
50
50
|
```vne
|
|
51
51
|
$ checkers show
|
|
@@ -55,18 +55,18 @@ $ checkers show
|
|
|
55
55
|
$ checkers hide
|
|
56
56
|
```
|
|
57
57
|
|
|
58
|
-
Args
|
|
58
|
+
Args under `show`: `initialOwner` (`white` / `black`, else white); `initialPreset` (key from `PARAMS.CHECKERS.PRESETS`, default `COMMON`).
|
|
59
59
|
|
|
60
|
-
`$ checkers.ai` —
|
|
60
|
+
`$ checkers.ai` — see [`ai/checkers`](../ai/checkers.md).
|
|
61
61
|
|
|
62
|
-
##
|
|
62
|
+
## Bundle
|
|
63
63
|
|
|
64
64
|
`@vnejs/bundles.checkers` — `plugins.common.grid` + `plugins.common.turn` + `plugins.game.checkers` + `plugins.ai.checkers` + `plugins.views.screens.checkers` + `plugins.ai`.
|
|
65
65
|
|
|
66
|
-
##
|
|
66
|
+
## Related plugins
|
|
67
67
|
|
|
68
|
-
- [common/grid.md](../common/grid.md) — `GRID` (
|
|
68
|
+
- [common/grid.md](../common/grid.md) — `GRID` (board)
|
|
69
69
|
- [common/turn.md](../common/turn.md) — `TURNS` (`id` / `owner`)
|
|
70
70
|
- [ai/checkers.md](../ai/checkers.md) — `CHECKERS_AI`
|
|
71
71
|
- [views.screens/checkers.md](../views.screens/checkers.md) — `CHECKERS_VIEW`
|
|
72
|
-
- [ai/ai.md](../ai/ai.md) —
|
|
72
|
+
- [ai/ai.md](../ai/ai.md) — `AI.EMIT` dispatcher
|
|
@@ -1,38 +1,38 @@
|
|
|
1
1
|
# plugins/platform/android/
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package: `@vnejs/plugins.platform.android` · namespace: `ANDROID`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
On Android hides the splash screen on start and closes the app.
|
|
6
6
|
|
|
7
|
-
##
|
|
7
|
+
## Events
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
None.
|
|
10
10
|
|
|
11
|
-
##
|
|
11
|
+
## Constants
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
None.
|
|
14
14
|
|
|
15
|
-
##
|
|
15
|
+
## Parameters
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
None.
|
|
18
18
|
|
|
19
|
-
##
|
|
19
|
+
## Settings
|
|
20
20
|
|
|
21
|
-
|
|
21
|
+
None.
|
|
22
22
|
|
|
23
|
-
##
|
|
23
|
+
## Modules
|
|
24
24
|
|
|
25
|
-
|
|
|
26
|
-
| --------- |
|
|
27
|
-
| `android` |
|
|
25
|
+
| Module | Role |
|
|
26
|
+
| --------- | ----------------------- |
|
|
27
|
+
| `android` | Handles STARTED, CLOSE. |
|
|
28
28
|
|
|
29
|
-
##
|
|
29
|
+
## Related plugins
|
|
30
30
|
|
|
31
31
|
### plugins/core/
|
|
32
32
|
|
|
33
33
|
- [platforms.md](../core/platforms.md) — `PLATFORMS`: CONST.MOBILE, PARAMS.CURRENT_PLATFORM
|
|
34
34
|
- [system.md](../core/system.md) — `SYSTEM`: EVENTS.STARTED, EVENTS.CLOSE
|
|
35
35
|
|
|
36
|
-
###
|
|
36
|
+
### Other
|
|
37
37
|
|
|
38
|
-
—
|
|
38
|
+
— None
|
|
@@ -1,45 +1,45 @@
|
|
|
1
1
|
# plugins/platform/electron/
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Package: `@vnejs/plugins.platform.electron` · namespace: `ELECTRON`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Syncs storage with the Electron host and reloads the game when state changes. The host lays out state: `{module}.json` when group is `_`, else `{module}/{group}.json`.
|
|
6
6
|
|
|
7
|
-
##
|
|
7
|
+
## Events
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
Handler payloads and results are typed through module augmentation of the contract (`VneEventPayloadMap` / `VneEventResultMap`). The types live in `@vnejs/contracts.platform.electron`.
|
|
10
10
|
|
|
11
|
-
|
|
|
12
|
-
| -------- | --------------------- |
|
|
13
|
-
| `CONFIG` | `vne:electron:config` |
|
|
11
|
+
| Key | String | Meaning |
|
|
12
|
+
| -------- | --------------------- | -------------------------------------------- |
|
|
13
|
+
| `CONFIG` | `vne:electron:config` | Electron host config (for example language). |
|
|
14
14
|
|
|
15
|
-
##
|
|
15
|
+
## Constants
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
None.
|
|
18
18
|
|
|
19
|
-
##
|
|
19
|
+
## Parameters
|
|
20
20
|
|
|
21
|
-
|
|
21
|
+
None.
|
|
22
22
|
|
|
23
|
-
##
|
|
23
|
+
## Settings
|
|
24
24
|
|
|
25
|
-
|
|
25
|
+
None.
|
|
26
26
|
|
|
27
|
-
##
|
|
27
|
+
## Modules
|
|
28
28
|
|
|
29
|
-
|
|
|
30
|
-
| ---------- |
|
|
31
|
-
| `electron` |
|
|
29
|
+
| Module | Role |
|
|
30
|
+
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
31
|
+
| `electron` | Syncs remote storage; on change and cooldown ≥ 10 s (mark in `sessionStorage`) sets `shouldReload` + `shared.shouldAutostartScenario = false`; on `STARTED` emits `RELOAD`; handles CHANGED / CLOSE_BEFORE. |
|
|
32
32
|
|
|
33
|
-
##
|
|
33
|
+
## Related plugins
|
|
34
34
|
|
|
35
35
|
### plugins/core/
|
|
36
36
|
|
|
37
37
|
- [platforms.md](../core/platforms.md) — `PLATFORMS`: CONST.ELECTRON, PARAMS.CURRENT_PLATFORM
|
|
38
|
-
- [scenario.md](../core/scenario.md) — `SCENARIO`: `shared.shouldAutostartScenario` (
|
|
38
|
+
- [scenario.md](../core/scenario.md) — `SCENARIO`: `shared.shouldAutostartScenario` (disables autostart before reload)
|
|
39
39
|
- [storage.md](../core/storage.md) — `STORAGE`: EVENTS.CHANGED, EVENTS.SET_ALL, EVENTS.GET_ALL
|
|
40
40
|
- [system.md](../core/system.md) — `SYSTEM`: EVENTS.STARTED, EVENTS.CLOSE_BEFORE, EVENTS.RELOAD, CONST.HOST
|
|
41
41
|
- [vendors.md](../core/vendors.md) — `VENDORS`: EVENTS.DEBOUNCE
|
|
42
42
|
|
|
43
|
-
###
|
|
43
|
+
### Other
|
|
44
44
|
|
|
45
|
-
—
|
|
45
|
+
— None
|