🚀 Hitsumabushi SDK に Getting Started ガイドを追加しました

自作のWebゲームを「ひつまぶし」に連携するための Hitsumabushi SDK に、インストールから最小構成のゲームを動かすまでを一本道で解説する Getting Started ガイドを追加しました。

これまでSDKのドキュメントはAPI仕様書・マニフェスト仕様書・技術制約ガイドライン・AIプロンプトの4つに分かれており、「まず何から読めばいいか」が分かりにくい状態でした。Getting Startedはその入り口として、以下の内容を一つのページにまとめています。

👉 Getting Started を読む

1. インストール

GitHub Packagesの認証設定（Personal Access Tokenの発行、.npmrcの設定）から npm install までの手順です。

npm install @milightpartner/hitsumabushi-sdk

2. 最小構成の実装

Hitsumabushi.init() の呼び出しから、対戦設定を受け取る onStartMatch、決着を報告する sendGameOver までの最小サンプルコードを掲載しています。

import { Hitsumabushi } from '@milightpartner/hitsumabushi-sdk';

Hitsumabushi.init({
  onCreateMatch: (config) => {
    // 最初の1回だけ。DOM構築やイベント登録はこちら
  },
  onStartMatch: (config) => {
    // 毎試合（リマッチ含む）呼ばれる。盤面・スコアのリセットはここに書けば漏れない
  },
});

3. `manifest.json` の最小例

ポータルがプレイ人数・大会モード適合を判定するために必要な manifest.json の、まず動かすための最小構成を紹介しています。

4. スタンドアロンでの動作確認

ポータルの外で開いても安全に動くフォールバック実装の考え方も解説しています。

次に読むべきドキュメント

Getting Startedを読み終えたら、必要に応じて以下の詳細ドキュメントを参照してください。

🚀 Getting Started — インストール〜最小構成で動かすまでのチュートリアル
🔌 Hitsumabushi SDK 技術仕様書 — JS API・通信プロトコルの完全リファレンス
📄 ゲームマニフェスト仕様書 — manifest.json の全プロパティ定義
📱 ゲームアプリ技術制約ガイドライン — モバイル・UX技術制約
🤖 ゲームマニフェスト仕様書 — 既存のゲームから manifest.json を起こす手掛かりも含みます

npmパッケージ (@milightpartner/hitsumabushi-sdk) にも同じ内容が同梱されているため、エディタやAIコーディングツールでソースコードを読みながらでもそのまま参照できます。

自作ゲームの「ひつまぶし」掲載にご興味のある方は、ぜひ Getting Started から試してみてください。