@hakoniwajs/node

中文文档
0.1.6发布于 2026/11/01SEE LICENSE IN LICENSETypeScriptES Module构建来源已验证

箱庭諸島2 (TypeScript 版) の Node.js アダプタ。hakoniwa serve で node:sqlite をストレージにした HTTP サーバーが起動する

原始使用文档
文档目录4 节
  1. 使い方
  2. CLI
  3. 主な環境変数
  4. License

@hakoniwajs/node

箱庭諸島2 (TypeScript 版) の Node.js Adapter です。node:sqlite によるストレージ、HTTP サーバー、ファイルバックアップ、CLI を提供します。

使い方

Node.js 22.13 以上が必要です。

$ npm install @hakoniwajs/node
$ HAKONIWA_BASE_URL=http://localhost:3000 npx hakoniwa serve

http://localhost:3000/ でゲームが起動します (DB は既定で ./hakoniwa.db に作成されます)。

hakoniwa serve は、待ち受け先を指定しないとすべてのインターフェースで待ち受けます。このときは HAKONIWA_BASE_URL が必要で、未設定だとエラーを出して終了します。HAKONIWA_HOST=127.0.0.1 (または localhost、::1) でループバックだけにすると省略でき、http://localhost:<実際のポート> になります。この URL はリクエストの Host ヘッダからは決めません。0.0.0.0 や ::、LAN や公開アドレスで待ち受けるときも必須です。値を設定したときは、待ち受け先に関係なくその URL を使います。Cloudflare 版は未設定ならリクエストのオリジンを使います。

CLI

$ npx hakoniwa --help
$ npx hakoniwa db init          # ゲームを初期化して開始
$ npx hakoniwa db status        # 現在の状態を表示
$ npx hakoniwa turn check       # 期限が来ていればターンを進める
$ npx hakoniwa backup list|create|restore|delete

主な環境変数

変数内容
HAKONIWA_BASE_URL公開 URL。ループバック待ち受けでは省略でき http://localhost:<ポート>。それ以外は必須
HAKONIWA_HOST待ち受けアドレス。未指定は全インターフェース。ループバックなら 127.0.0.1 など
HAKONIWA_AUTH_SECRET任意。セッション署名・CSRF の鍵。未設定なら初回起動時に自動生成して DB に保存
HAKONIWA_DB_PATHSQLite DB のパス (既定 ./hakoniwa.db)
HAKONIWA_PUBLIC_DIR静的アセットのパス (既定は同梱の @hakoniwajs/core/public)
HAKONIWA_ADMIN_EMAILS任意。管理者ユーザーのメールアドレス (カンマ区切り)
HAKONIWA_DEV_LOGINtrue で開発ログインを有効化 (本番では false)

HAKONIWA_ADMIN_EMAILS を設定しない場合は、ログインしてから /admin/setup を開き、サーバーのコンソールに出力されるセットアップコードを入力すると最初の管理者になれます (以後は管理画面から管理者を追加・削除できます)。

全項目は 環境変数一覧 を参照してください。

License

オリジナルの利用条件に従います (LICENSE)。同梱画像の商用利用はできません。

版本与发布记录

@hakoniwajs/node 共发布 7 个版本,首次发布于 2026/09/26;过去 12 个月发布了 7 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.1.6latest2026/11/012 天前
0.1.52026/10/2410 天前
0.1.42026/09/271 个月前
0.1.32026/09/271 个月前
0.1.22026/09/261 个月前
0.1.12026/09/261 个月前

关于 @hakoniwajs/node 的常见问题

@hakoniwajs/node 是什么?

Node.js。hakoniwa serve で节点:sqliteをストレージにしたHTTPサーバーが起動する

如何安装 @hakoniwajs/node?

在项目目录运行 npm install @hakoniwajs/node,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 hakoniwa,可以用 npx hakoniwa 直接运行。

@hakoniwajs/node 支持 TypeScript 吗?

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

@hakoniwajs/node 支持 ESM 还是 CommonJS?

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

@hakoniwajs/node 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=22.13。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@hakoniwajs/node 可以商用吗?

@hakoniwajs/node 使用 SEE LICENSE IN LICENSE 许可。许可条款写在包内的独立文件中,请阅读该文件确认可否商用。以上为概括,不构成法律意见,请以许可原文为准。

@hakoniwajs/node 还在维护吗?

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