vimp-engine 0.39.0 → 0.41.0

package/README.md

@@ -4,7 +4,7 @@ The VIMP engine SDK for game plugins: the browser host and client runtime,
 the standalone mode (`vimp-engine/standalone`) and the CLI tools `vimp-sim`
 and `vimp-contract`. Game rules live in separate plugin packages that the
 engine loads at runtime through the
-[plugin contract](https://docs.vimp.lgick.dev/en/plugin-api).
+plugin contract (VIMP docs: plugin-api.md).
 
 Start a game:
 
@@ -12,4 +12,4 @@ Start a game:
 npm create vimp-game my-game
 ```
 
-Documentation: https://docs.vimp.lgick.dev
+Platform: https://vimp.lgick.dev

package/bin/vimp-sim.js

@@ -40,8 +40,8 @@ const BUILTIN_NOTICE =
   'notice: the built-in smoke scenario is running against --game. It only\n' +
   'notice: proves the loop closes on this plugin: key coverage (invariant 2)\n' +
   'notice: and prediction drift (invariant 9) are skipped — both need a\n' +
-  'notice: scenario written for your game. See § Scenario format at\n' +
-  'notice: https://docs.vimp.lgick.dev/en/debugging#scenario-format, then run\n' +
+  'notice: scenario written for your game; the format is in\n' +
+  'notice: VIMP docs: debugging.md § "Scenario format". Then run\n' +
   'notice: vimp-sim --scenario <file>.\n\n';
 
 // типичная опечатка «--core без --game»: фикстурное ядро — обычный JS и

package/core/Cargo.toml

@@ -1,10 +1,10 @@
 [package]
 name = "vimp-engine-core"
-version = "0.23.4"
+version = "0.24.0"
 edition = "2024"
 description = "VIMP engine simulation core: physics, map, snapshot framing, interpolation/prediction/raycast primitives, navigation utilities. No wasm-bindgen — the game crate builds the WASM ABI wrappers."
 license = "MIT"
-homepage = "https://docs.vimp.lgick.dev/en/core"
+homepage = "https://vimp.lgick.dev"
 documentation = "https://docs.rs/vimp-engine-core"
 readme = "README.md"
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vimp-engine",
-  "version": "0.39.0",
+  "version": "0.41.0",
   "description": "VIMP engine SDK: browser host and client runtime, standalone mode and CLI tools (vimp-sim, vimp-contract) for VIMP game plugins",
   "license": "MIT",
   "repository": {
@@ -8,7 +8,7 @@
     "url": "git+ssh://git@github.com/lgick/vimp.git",
     "directory": "packages/engine"
   },
-  "homepage": "https://docs.vimp.lgick.dev",
+  "homepage": "https://vimp.lgick.dev",
   "type": "module",
   "engines": {
     "node": ">=20.11.0"
@@ -44,8 +44,7 @@
   ],
   "scripts": {
     "predev": "node scripts/sync-pixi-vendor.mjs",
-    "dev": "NODE_ENV=development nodemon src/master/main.js -w src/master -w src/dedicated -w src/lib -w src/config",
-    "dedicated": "NODE_ENV=development nodemon src/master/main.js -w src/master -w src/dedicated -w src/host -w src/lib -w src/config",
+    "dev": "NODE_ENV=development nodemon src/master/main.js -w src/master -w src/lib -w src/config",
     "start": "NODE_ENV=production node --env-file ../../.env src/master/main.js",
     "prebuild": "node scripts/sync-pixi-vendor.mjs",
     "build": "vite build",

package/src/client/boot.js

@@ -1,33 +1,19 @@
 // Режим загрузки клиента движка (Этап 2 плана standalone-sdk). Клиент один
-// на все контуры, а различает их этот модуль:
+// на оба контура, а различает их этот модуль:
 //
-//   lobby      — прод: каталог игр и сигналинг мастера, лобби за экраном профиля;
-//   solo       — standalone SDK: хост в этой же вкладке (inline, без Worker'а),
-//                мастера нет вовсе;
-//   dedicated  — Node-сервер: прямой WebSocket к игровому процессу.
+//   lobby — прод: каталог игр и сигналинг мастера, лобби за экраном профиля;
+//   solo  — standalone SDK: хост в этой же вкладке (inline, без Worker'а),
+//           мастера нет вовсе.
 //
 // Канал передачи конфига от SDK к main.js — модульное состояние: и SDK, и
 // main.js резолвят этот модуль в один экземпляр графа бандлера. Глобалов на
 // window не вводим: они переживают перезагрузку бандла и ломают вторую
 // вкладку SDK в том же документе.
 
-import {
-  bodyReadFailure,
-  fetchRetrying,
-  isNetworkFailure,
-} from './lib/retryOnNetworkError.js';
-
-// эндпоинт режима: его отдаёт dedicated-сервер, у мастера его нет —
-// 404 и мусор означают прод-лобби; сбой сети — отказ загрузки
-const CONFIG_URL = '/config';
-
-// умолчание игрового WS dedicated-сервера: тот же хост, путь /game
-const DEDICATED_WS_PATH = '/game';
-
 /**
  * Конфиг загрузки:
  * {
- *   mode: 'lobby' | 'solo' | 'dedicated',
+ *   mode: 'lobby' | 'solo',
  *   container,       // solo: точка монтирования каркаса и канвасов
  *   manifest,        // solo: манифест-подобный объект в памяти
  *   clientPlugin,    // solo: живой ClientPlugin (минуя dynamic import)
@@ -37,15 +23,13 @@ const DEDICATED_WS_PATH = '/game';
  *   startupVotes,    // solo: ответы на initialVote (выход из наблюдателей)
  *   startupCommands, // solo: чат-команды игры (спавн ботов)
  *   reportUrl,       // solo: приём журнала клиентских ошибок (null — выкл.)
- *   wsUrl,           // dedicated: адрес игрового WS
- *   gameId,          // dedicated: какую игру каталога считать активной
  * }
  */
 let bootConfig = null;
 
 /**
  * Задаёт конфиг загрузки. SDK вызывает его до import('./main.js') — main.js
- * читает уже готовое состояние и сети не касается.
+ * читает уже готовое состояние.
  * @param {Object} cfg - Конфиг загрузки (см. выше).
  */
 export function setBootConfig(cfg) {
@@ -53,7 +37,7 @@ export function setBootConfig(cfg) {
 }
 
 /**
- * Текущий конфиг загрузки (null, пока не задан и не разрешён).
+ * Текущий конфиг загрузки (null, пока SDK его не задал).
  * @returns {Object|null}
  */
 export function getBootConfig() {
@@ -69,69 +53,9 @@ export function resetBootConfig() {
 }
 
 /**
- * Разрешает режим загрузки: инъекция SDK → GET /config → лобби.
- * @param {Function} [fetchImpl] - Реализация fetch (тесты подставляют свою).
- * @param {Object} [retry] - Параметры fetchRetrying (тесты отключают паузы).
- * @returns {Promise<Object>} Конфиг загрузки; отклоняется NetworkFailure, если
- *   сеть не ответила после повторов.
+ * Разрешает режим загрузки: инъекция SDK, иначе лобби.
+ * @returns {Object} Конфиг загрузки.
  */
-export async function resolveBootConfig(fetchImpl, retry) {
-  if (bootConfig) {
-    return bootConfig;
-  }
-
-  const doFetch = fetchImpl ?? ((...args) => fetch(...args));
-  let res = null;
-
-  try {
-    res = await fetchRetrying(doFetch, CONFIG_URL, retry);
-  } catch (e) {
-    // сети нет: режим неизвестен, и лобби здесь — догадка, а не факт
-    if (isNetworkFailure(e)) {
-      throw e;
-    }
-  }
-
-  if (res?.ok) {
-    try {
-      bootConfig = normalize(await res.json());
-    } catch (e) {
-      // мусор в JSON — лобби; обрыв при чтении тела — сбой сети
-      const failure = bodyReadFailure(e);
-
-      if (isNetworkFailure(failure)) {
-        throw failure;
-      }
-
-      bootConfig = null;
-    }
-  }
-
-  bootConfig = bootConfig ?? { mode: 'lobby' };
-
-  return bootConfig;
-}
-
-// приводит ответ /config к валидному конфигу; всё, что не dedicated, —
-// лобби: неизвестный режим не должен уронить клиент в чёрный экран
-function normalize(raw) {
-  if (!raw || typeof raw !== 'object' || raw.mode !== 'dedicated') {
-    return null;
-  }
-
-  return {
-    ...raw,
-    mode: 'dedicated',
-    // сервер объявляет свой путь в /config: константа — только умолчание
-    wsUrl: raw.wsUrl || defaultDedicatedWsUrl(raw.wsPath),
-  };
-}
-
-function defaultDedicatedWsUrl(wsPath) {
-  const protocol = location.protocol === 'https:' ? 'wss:' : 'ws:';
-  // пустой или отсутствующий путь — это «умолчание», а не корень: `''` дал бы
-  // ws://host, null — ws://hostnull
-  const path = wsPath || DEDICATED_WS_PATH;
-
-  return `${protocol}//${location.host}${path}`;
+export function resolveBootConfig() {
+  return bootConfig ?? { mode: 'lobby' };
 }

package/src/client/components/controller/Vote.js

@@ -24,6 +24,27 @@ export default class VoteCtrl {
   // {name: 'templateName', params: ['p1',..], values: ['v1',..] || 'values'}
   // ['val1', 'val2'];
   open(data) {
+    // личное меню хоста: проверяется раньше шаблона голосования (тоже объект)
+    if (typeof data === 'object' && data !== null && !Array.isArray(data)) {
+      if (Object.hasOwn(data, 'menu')) {
+        this._model.openPersonal(data.menu);
+
+        return;
+      }
+
+      if (Object.hasOwn(data, 'menuClose')) {
+        this._model.closePersonal(data.menuClose);
+
+        return;
+      }
+
+      if (Object.hasOwn(data, 'menuHint')) {
+        this._model.setHint(data.menuHint?.name, data.menuHint?.on);
+
+        return;
+      }
+    }
+
     // если данные - массив (values для созданного голосования)
     if (Array.isArray(data)) {
       this._model.updateValues(data);
@@ -64,6 +85,11 @@ export default class VoteCtrl {
     this._model.closeEngineVote(name);
   }
 
+  // CLEAR: личное меню закрывается, подсказки гаснут
+  clearPersonal() {
+    this._model.clearPersonal();
+  }
+
   // голосования хоста не пережили переподключение
   removeHostVotes() {
     this._model.removeHostVotes();

package/src/client/components/model/Controls.js

@@ -1,4 +1,5 @@
 import Publisher from '../../../lib/Publisher.js';
+import { VOTE_ANSWER_KEYS } from '../../../config/voteKeys.js';
 
 // Singleton ControlsModel
 
@@ -120,8 +121,15 @@ export default class ControlsModel {
         return;
       }
 
+      // цифры открытого окна голосования/меню — только ответ окну, в игру
+      // не уходят; прочие клавиши идут и в игру (танк ездит при меню)
+      const isVoteAnswer =
+        this._currentModes.vote &&
+        keyCode >= VOTE_ANSWER_KEYS[0] &&
+        keyCode <= VOTE_ANSWER_KEYS[1];
+
       // если клавиша ещё не зажата
-      if (!this._pressedKeys[keyCode]) {
+      if (!isVoteAnswer && !this._pressedKeys[keyCode]) {
         const name = this._currentKeySet[keyCode];
 
         if (name) {

package/src/client/components/model/RoomMenu.js

@@ -8,7 +8,7 @@ import Publisher from '../../../lib/Publisher.js';
 // - «Hand over host» — только у текущего хоста, когда в комнате есть другие
 //   люди и мастер назначил бету (иначе передавать некому).
 // Пока идёт передача, пункты заблокированы, на их месте статус. Только
-// лобби-режим: в solo/dedicated ссылки на комнату нет
+// лобби-режим: в solo ссылки на комнату нет
 
 // handoff: null | 'pending' | 'slow' | 'failed'
 const STATUS_TEXT = {

package/src/client/components/model/Vote.js

@@ -1,5 +1,6 @@
 import Publisher from '../../../lib/Publisher.js';
 import { VOTE_ANSWER_KEYS } from '../../../config/voteKeys.js';
+import { MENU_NAME_PATTERN } from '../../../config/menuName.js';
 
 // Singleton VoteModel
 
@@ -7,6 +8,44 @@ import { VOTE_ANSWER_KEYS } from '../../../config/voteKeys.js';
 // его ведёт мастер, а не хост, и игра таких имён не объявляет
 const isEngineVote = name => typeof name === 'string' && name.startsWith('@');
 
+// ограничения данных личного меню: хост недоверенный
+const PERSONAL_MAX_ITEMS = 7;
+const PERSONAL_MAX_DEPTH = 2;
+const PERSONAL_MAX_TEXT = 64;
+
+// узлы личного меню: усечённые копии, глубина ≤ 2, пунктов ≤ 7
+function sanitizeNodes(nodes, depth) {
+  if (!Array.isArray(nodes)) {
+    return [];
+  }
+
+  if (nodes.length > PERSONAL_MAX_ITEMS) {
+    console.warn(
+      `[vote] personal menu level has ${nodes.length} items, max ${PERSONAL_MAX_ITEMS}`,
+    );
+  }
+
+  return nodes.slice(0, PERSONAL_MAX_ITEMS).map(node => {
+    const out = {
+      text: String(node?.text ?? '').slice(0, PERSONAL_MAX_TEXT),
+      disabled: node?.disabled === true,
+    };
+
+    if (depth < PERSONAL_MAX_DEPTH) {
+      const children = sanitizeNodes(node?.children, depth + 1);
+
+      if (children.length > 0) {
+        out.children = children;
+      } else if (node?.children !== undefined) {
+        // объявленная группа без валидных детей не должна стать листом
+        out.disabled = true;
+      }
+    }
+
+    return out;
+  });
+}
+
 let voteModel;
 
 export default class VoteModel {
@@ -41,6 +80,11 @@ export default class VoteModel {
     // затирает чужое и не затирается им (этап 10)
     this._queue = [];
 
+    // личное меню хоста (type 'personal'): { name, style, title, items,
+    // path }, path — индексы открытых групп; подсказки — имя → горит ли
+    this._personal = null;
+    this._hints = new Map();
+
     this._title = null; // заголовок голосования
     this._values = []; // все значения голосования
 
@@ -124,6 +168,137 @@ export default class VoteModel {
     if (!(this._type === 'vote' && isEngineVote(this._voteName))) {
       this.complete();
     }
+
+    this._clearHints();
+  }
+
+  /**
+   * Личное меню хоста: заменяет любое содержимое окна и начинается с
+   * 1-го уровня; открытое голосование движка уходит в начало очереди.
+   * @param {Object} menu - { name, style, title, items }.
+   * @returns {boolean} данные приняты.
+   */
+  openPersonal(menu) {
+    if (
+      !menu ||
+      !MENU_NAME_PATTERN.test(menu.name) ||
+      !MENU_NAME_PATTERN.test(menu.style)
+    ) {
+      return false;
+    }
+
+    if (
+      this._showing &&
+      this._type === 'vote' &&
+      isEngineVote(this._voteName)
+    ) {
+      this._queue.unshift({
+        engine: {
+          name: this._voteName,
+          title: this._title,
+          values: this._values,
+          deadline: this._deadline,
+        },
+      });
+    }
+
+    this._waitingValues = false;
+    this._timeOff = true;
+    this._deadline = null;
+    this._type = 'personal';
+    this._voteName = '';
+    this._personal = {
+      name: menu.name,
+      style: menu.style,
+      title: String(menu.title ?? '').slice(0, PERSONAL_MAX_TEXT),
+      items: sanitizeNodes(menu.items, 1),
+      path: [],
+    };
+
+    this.show();
+    this.open();
+
+    return true;
+  }
+
+  // закрывает окно, если оно показывает личное меню `name`
+  closePersonal(name) {
+    if (
+      this._showing &&
+      this._type === 'personal' &&
+      this._personal.name === name
+    ) {
+      this.complete();
+    }
+  }
+
+  // зажигает/гасит подсказку меню
+  setHint(name, on) {
+    if (!MENU_NAME_PATTERN.test(name)) {
+      return;
+    }
+
+    this._hints.set(name, on === true);
+    this.publisher.emit('hint', { name, on: on === true });
+  }
+
+  // CLEAR: личное меню закрывается, подсказки гаснут
+  clearPersonal() {
+    if (this._showing && this._type === 'personal') {
+      this.complete();
+    }
+
+    this._clearHints();
+  }
+
+  _clearHints() {
+    for (const [name, on] of this._hints) {
+      if (on) {
+        this.setHint(name, false);
+      }
+    }
+  }
+
+  // пункты текущего уровня личного меню
+  _personalLevel() {
+    let nodes = this._personal.items;
+
+    for (const index of this._personal.path) {
+      nodes = nodes[index].children;
+    }
+
+    return nodes;
+  }
+
+  // цифра в личном меню: 0 — выход, 8/9 — страниц нет, 1–7 — пункт
+  _updatePersonal(number) {
+    if (number === 0) {
+      this.complete();
+
+      return;
+    }
+
+    const node = this._personalLevel()[number - 1];
+
+    if (number >= 8 || !node || node.disabled) {
+      return;
+    }
+
+    if (node.children) {
+      this._personal.path.push(number - 1);
+      this.show();
+
+      return;
+    }
+
+    const answer = [...this._personal.path, number - 1]
+      .map(index => index + 1)
+      .join('.');
+    const name = this._personal.name;
+
+    // окно закрывается ДО отправки (синхронный транспорт, см. ниже)
+    this.complete();
+    this.publisher.emit('socket', [`menu:${name}`, answer]);
   }
 
   _startEngineVote({ name, title, values, deadline }) {
@@ -220,6 +395,12 @@ export default class VoteModel {
       number = String.fromCharCode(keyCode);
       number = parseInt(number, 10);
 
+      if (this._type === 'personal') {
+        this._updatePersonal(number);
+
+        return;
+      }
+
       // exit
       if (number === 0) {
         this.complete();
@@ -277,6 +458,27 @@ export default class VoteModel {
 
   // отображает голосование
   show() {
+    if (this._type === 'personal') {
+      this._showing = true;
+      this.publisher.emit('clear', this._timerId);
+
+      this.publisher.emit('vote', {
+        title: this._personal.title,
+        list: this._personalLevel().map(node => ({
+          text: node.text,
+          disabled: node.disabled,
+          group: Boolean(node.children),
+        })),
+        back: false,
+        more: false,
+        time: null,
+        style: this._personal.style,
+        level: this._personal.path.length + 1,
+      });
+
+      return;
+    }
+
     const begin = this._currentPage * 7;
     const max = begin + 7;
     let currentValues = [];

package/src/client/components/view/Auth.js

@@ -13,7 +13,7 @@ export default class AuthView {
   // texts — игровые тексты формы (authSchema.texts: title, sections);
   // сам каркас (auth.pug) нейтрален и текстов игры не содержит.
   // params — та же дескрипторная схема формы, что и у room-формы
-  // (docs.vimp.lgick.dev/en/plugin-api "Form schema"), едет по сети в
+  // (VIMP docs: plugin-api.md § "Form schema"), едет по сети в
   // PS_AUTH_DATA
   constructor(model, elems, texts = null, params = null) {
     if (authView) {
@@ -64,8 +64,8 @@ export default class AuthView {
   }
 
   // строит контролы формы игрока из той же дескрипторной схемы, что и
-  // room-форма (единый formBuilder, docs.vimp.lgick.dev/en/plugin-api "Form
-  // schema")
+  // room-форма (единый formBuilder,
+  // VIMP docs: plugin-api.md § "Form schema")
   _renderFields(elems, params) {
     if (!Array.isArray(params)) {
       return;