vimp-engine 0.38.3 → 0.40.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.23.5"
 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.38.3",
+  "version": "0.40.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/InputListener.js

@@ -20,6 +20,9 @@ export default class InputListener {
       this.publisher.emit('keyUp', event),
     );
 
+    // keyup за пределами окна не приходит — эфир залип бы до таймаута
+    window.addEventListener('blur', () => this.publisher.emit('blur'));
+
     const emitMouse = () => this.publisher.emit('mouseAction');
 
     window.addEventListener('mouseup', emitMouse);

package/src/client/SoundManager.js

@@ -892,6 +892,19 @@ export default class SoundManager {
     }
   }
 
+  /**
+   * Выход Web Audio движка для голосовой связи: контекст Howler и его master
+   * gain. Голос подчиняется общей громкости и mute (скрытая вкладка, пауза
+   * миграции).
+   * @returns {{ ctx: AudioContext, destination: AudioNode } | null} null —
+   *   Web Audio недоступен.
+   */
+  getAudioOutput() {
+    return Howler.usingWebAudio && Howler.ctx && Howler.masterGain
+      ? { ctx: Howler.ctx, destination: Howler.masterGain }
+      : null;
+  }
+
   /**
    * Выключает все звуки.
    */

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/Controls.js

@@ -54,6 +54,16 @@ export default class ControlsCtrl {
     this._model.resendHeld();
   }
 
+  // назначает клавишу связи (push-to-talk)
+  setPushToTalk(keyCode) {
+    this._model.setPushToTalk(keyCode);
+  }
+
+  // отпускает связь (потеря фокуса, скрытая вкладка)
+  releasePtt() {
+    this._model.releasePtt();
+  }
+
   // скрывает курсор
   resetCursorHideTimer() {
     this._view.resetCursorHideTimer();

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

@@ -0,0 +1,31 @@
+// Singleton VoiceCtrl
+
+let voiceCtrl;
+
+export default class VoiceCtrl {
+  constructor(model, view) {
+    if (voiceCtrl) {
+      return voiceCtrl;
+    }
+
+    voiceCtrl = this;
+
+    this._model = model;
+    this._view = view;
+  }
+
+  // состояние своего эфира
+  showOwn(kind, data) {
+    this._model.showOwn(kind, data);
+  }
+
+  // чужой эфир (null — скрыть)
+  setIncoming(speaker) {
+    this._model.setIncoming(speaker);
+  }
+
+  destroy() {
+    this._model.destroy();
+    this._view.destroy();
+  }
+}

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

@@ -2,6 +2,17 @@ import Publisher from '../../../lib/Publisher.js';
 
 // Singleton ControlsModel
 
+// keyCode самих модификаторов: Ctrl, Alt, Meta (два кода и Firefox)
+const MODIFIER_CODES = new Set([17, 18, 91, 93, 224]);
+
+// фокус в поле ввода: клавиша печатает букву
+function isEditableTarget(target) {
+  return (
+    target?.isContentEditable === true ||
+    ['INPUT', 'TEXTAREA', 'SELECT'].includes(target?.tagName)
+  );
+}
+
 let controlsModel;
 
 export default class ControlsModel {
@@ -25,6 +36,8 @@ export default class ControlsModel {
     // возобновления сессии должен знать, что игрок держит на самом деле
     this._heldCodes = new Set();
     this._areKeysEnabled = false; // статус возможности нажатия клавиш
+    this._pttKey = null; // keyCode клавиши связи, null — связи нет
+    this._pttHeld = false;
 
     // канал указателя: игра, не объявившая modules.controls.pointer, его не
     // получает вовсе — ни одного лишнего сообщения по проводу
@@ -79,6 +92,34 @@ export default class ControlsModel {
         this.publisher.emit('mode', mode);
       }
     } else {
+      // Cmd, нажатый при уже зажатой клавише связи: её keyup на macOS не
+      // придёт — эфир отпускается сразу
+      if (event.metaKey && this._pttHeld && keyCode !== this._pttKey) {
+        this.releasePtt();
+      }
+
+      // клавиша связи никогда не уходит в игру командой. Автоповтор keydown
+      // игнорируется — удержание и так длится до keyup. Фокус в поле ввода
+      // (любом, не только в строке чата) — клавиша печатает букву. С
+      // Ctrl/Cmd/Alt — системная комбинация (вставка), не связь: на macOS при
+      // Cmd keyup обычной клавиши не приходит и связь залипла бы
+      // Сам модификатор может быть клавишей связи: его keydown несёт свой флаг
+      if (
+        keyCode === this._pttKey &&
+        (MODIFIER_CODES.has(keyCode) ||
+          !(event.ctrlKey || event.metaKey || event.altKey)) &&
+        !isEditableTarget(event.target)
+      ) {
+        event.preventDefault();
+
+        if (!event.repeat && !this._pttHeld) {
+          this._pttHeld = true;
+          this.publisher.emit('ptt', true);
+        }
+
+        return;
+      }
+
       // если клавиша ещё не зажата
       if (!this._pressedKeys[keyCode]) {
         const name = this._currentKeySet[keyCode];
@@ -111,6 +152,11 @@ export default class ControlsModel {
 
     this._heldCodes.delete(keyCode);
 
+    // отпускание засчитывается всегда, без проверки цели
+    if (keyCode === this._pttKey && this._pttHeld) {
+      this.releasePtt();
+    }
+
     // если клавиша была зажата
     if (this._pressedKeys[keyCode]) {
       const name = this._currentKeySet[keyCode];
@@ -131,6 +177,10 @@ export default class ControlsModel {
     if (status === 'opened') {
       this._currentModes[mode] = true;
 
+      if (mode === 'chat') {
+        this.releasePtt();
+      }
+
       // иначе змейка так и ехала бы к последней точке, пока игрок набирает
       // сообщение в чат
       this._releasePointer(this._lastTapX, this._lastTapY);
@@ -260,6 +310,20 @@ export default class ControlsModel {
 
     if (isEnabled === false) {
       this._releasePointer(this._lastTapX, this._lastTapY);
+      this.releasePtt();
+    }
+  }
+
+  // клавиша связи (push-to-talk); null выключает
+  setPushToTalk(keyCode) {
+    this._pttKey = keyCode ?? null;
+  }
+
+  // отпускает связь (клавиша вверх, потеря фокуса, чат, запрет ввода)
+  releasePtt() {
+    if (this._pttHeld) {
+      this._pttHeld = false;
+      this.publisher.emit('ptt', false);
     }
   }
 }

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/Voice.js

@@ -0,0 +1,96 @@
+import Publisher from '../../../lib/Publisher.js';
+
+// вспышка ошибки гаснет сама
+const ERROR_FLASH_MS = 1500;
+
+// Singleton VoiceModel
+
+let voiceModel;
+
+export default class VoiceModel {
+  /**
+   * @param {Object} data
+   * @param {Object} data.texts - CONFIG_DATA.voice.texts.
+   */
+  constructor({ texts }) {
+    if (voiceModel) {
+      return voiceModel;
+    }
+
+    voiceModel = this;
+
+    this._texts = texts ?? {};
+    // один таймер авто-скрытия: новый показ снимает прежний, иначе таймер
+    // старой ошибки погасил бы эфир, начатый после неё
+    this._timer = null;
+
+    // 'own' ({ kind, text, endsAt, totalMs }) и 'incoming' (speaker | null)
+    this.publisher = new Publisher();
+  }
+
+  /**
+   * Состояние своего эфира.
+   * @param {'hidden'|'talking'|'busy'|'cooldown'|'error'} kind
+   * @param {Object} [data] - talking: { endsAt, totalMs }, cooldown:
+   *   { endsAt }, error: { textKey }.
+   */
+  showOwn(kind, data = {}) {
+    this._clearTimer();
+
+    let text = '';
+    let endsAt = 0;
+    let totalMs = 0;
+
+    if (kind === 'busy') {
+      text = this._texts.busy ?? '';
+    } else if (kind === 'cooldown') {
+      text = this._texts.cooldown ?? '';
+      endsAt = data.endsAt;
+    } else if (kind === 'error') {
+      text = this._texts[data.textKey] ?? '';
+    } else if (kind === 'talking') {
+      endsAt = data.endsAt;
+      totalMs = data.totalMs;
+    }
+
+    this.publisher.emit('own', { kind, text, endsAt, totalMs });
+
+    if (kind === 'error') {
+      this._arm(ERROR_FLASH_MS);
+    } else if (kind === 'cooldown') {
+      this._arm(Math.max(0, endsAt - performance.now()));
+    }
+  }
+
+  /**
+   * Чужой эфир.
+   * @param {{ name: string, teamId: number|null, color: string|null }|null}
+   *   speaker - null скрывает.
+   */
+  setIncoming(speaker) {
+    this.publisher.emit('incoming', speaker);
+  }
+
+  destroy() {
+    this._clearTimer();
+  }
+
+  _arm(ms) {
+    this._timer = setTimeout(() => {
+      this._timer = null;
+      this.publisher.emit('own', {
+        kind: 'hidden',
+        text: '',
+        endsAt: 0,
+        totalMs: 0,
+      });
+    }, ms);
+  }
+
+  _clearTimer() {
+    if (this._timer !== null) {
+      clearTimeout(this._timer);
+      this._timer = null;
+    }
+  }
+}

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

@@ -1,4 +1,5 @@
 import Publisher from '../../../lib/Publisher.js';
+import { VOTE_ANSWER_KEYS } from '../../../config/voteKeys.js';
 
 // Singleton VoteModel
 
@@ -215,7 +216,7 @@ export default class VoteModel {
     }
 
     // если keyCode это число от 0 до 9
-    if (48 <= keyCode && keyCode <= 57) {
+    if (VOTE_ANSWER_KEYS[0] <= keyCode && keyCode <= VOTE_ANSWER_KEYS[1]) {
       number = String.fromCharCode(keyCode);
       number = parseInt(number, 10);
 

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;