@gd-kirie/platform

中文文档
0.16.0发布于 2026/10/29TypeScriptES Module构建来源已验证近 30 天下载 8699
原始使用文档
文档目录4 节
  1. External URLs
  2. Host window
  3. Global shortcuts
  4. System back

@gd-kirie/platform

@gd-kirie/platform exposes browser-side desktop capabilities supplied by the Godot host. Create the client from an existing @gd-kirie/ipc-eventa context.

import { createContext } from "@gd-kirie/ipc-eventa";
import { createPlatformClient, hostWindowPointerPositionChanged } from "@gd-kirie/platform";

const eventa = createContext();
const platform = createPlatformClient(eventa.context);

await platform.hostWindow.setAlwaysOnTop(true);

const windowBounds = await platform.hostWindow.getBounds();
const displayBounds = await platform.hostWindow.getCurrentDisplayBounds();
const stopPointer = eventa.context.on(hostWindowPointerPositionChanged, ({ body }) => {
  console.log(body);
});
const pointer = await platform.hostWindow.getPointerPosition();
const windowState = await platform.hostWindow.getState();
console.log(windowBounds, displayBounds, pointer, windowState);
stopPointer();
eventa.dispose();

Request/response capabilities are methods on the returned client. Host-initiated events are exported @moeru/eventa contracts; subscribe to them on the same context and the returned function unsubscribes.

External URLs

Use openExternalUrl() to open an absolute HTTP or HTTPS URL with the system browser:

await platform.openExternalUrl("https://example.com");

The Godot host rejects relative URLs and other URI schemes. It uses OS.shell_open() to select the system browser.

Use openApplicationDataDirectory() to open the current Godot application's data directory and receive its absolute path:

const path = await platform.openApplicationDataDirectory();

This capability does not accept an arbitrary path.

Host window

  • window position and size in screen coordinates
  • current display position and size in screen coordinates
  • pointer position relative to the host window, including while it is click-through
  • pointer passthrough
  • native move and resize gestures
  • always-on-top
  • centering on the current display
  • visibility, focus, and minimized-state snapshots and change events

Pointer coordinates use host-window pixels and are not normalized to the browser viewport. Subscribe to hostWindowPointerPositionChanged first. Then call getPointerPosition() to get a snapshot and start native observation. The host sends later changes while the window is unfocused or click-through.

getState() returns one lifecycle snapshot and starts native state observation. Call it once during setup. Later changes arrive as hostWindowStateChanged events; subscribe with context.on(hostWindowStateChanged, ({ body }) => ...) and call the returned function to unsubscribe.

Global shortcuts

The macOS and Windows hosts can register a shortcut that remains active while the Godot window is hidden or unfocused:

const shortcut = {
  keycode: 0x4b, // Godot Key.K
  shiftPressed: false,
  altPressed: false,
  ctrlPressed: false,
  metaPressed: false,
  commandOrControlAutoremap: true,
};

await platform.globalShortcuts.register(shortcut, ({ state }) => {
  console.log(state); // "pressed" or "released"
});

await platform.globalShortcuts.unregister(shortcut);

keycode uses Godot's logical Key values. Every modifier field is required; commandOrControlAutoremap selects Command on macOS and Control on Windows. One onKeyEvent handler receives both states; keyboard auto-repeat does not produce extra calls.

System back

Android delivers the system Back button as a Platform event. The application decides what Back means:

import { backRequested } from "@gd-kirie/platform";

const stop = context.on(backRequested, () => {
  console.log("The system Back button was pressed.");
});

stop();

To handle Back instead of letting Android close the application, set SceneTree.quit_on_go_back to false. The event is not emitted on platforms without a system Back button.

版本与发布记录

@gd-kirie/platform 共发布 28 个版本,首次发布于 2026/08/27;过去 12 个月发布了 28 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.16.0latest2026/10/2917 天前
0.15.32026/10/2917 天前
0.15.22026/10/2818 天前
0.15.12026/10/2818 天前
0.15.02026/10/2125 天前
0.14.22026/10/1729 天前

关于 @gd-kirie/platform 的常见问题

如何安装 @gd-kirie/platform?

在项目目录运行 npm install @gd-kirie/platform,或使用 pnpm add / yarn add / bun add。

@gd-kirie/platform 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@gd-kirie/platform 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@gd-kirie/platform 可以商用吗?

@gd-kirie/platform 使用 未声明 许可。package.json 没有声明许可证。没有许可证的代码默认保留全部权利,商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括,不构成法律意见,请以许可原文为准。

@gd-kirie/platform 的下载量有多少?

根据 npm 官方下载统计,@gd-kirie/platform 在 2026/10/16 – 2026/11/14 这 30 天内被下载 8,699 次,日均约 290 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@gd-kirie/platform 还在维护吗?

最新版本 0.16.0 发布于 2026/10/29(17 天前);至今共发布 28 个版本,其中过去 12 个月发布了 28 个;首次发布于 2026/08/27。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。