← トップへ戻る
SDK概要

ひつまぶしSDK

対戦ゲームポータル「ひつまぶし」向けのゲームを作るためのSDKです。 ゲームはポータル内の <iframe> として動き、SDKを通じて対戦相手・観戦者・ポータル本体とやりとりします。

ゲームのルールを伝えるだけで、AIが実装を進められることを狙って作られています。 通信仕様・マニフェスト・モバイル要件・テストの書き方はすべてSDKに同梱されているため、 人間がSDKの仕様を説明する必要はありません。

すぐに始める

npm install @milightpartner/hitsumabushi-sdk
npx hitsumabushi init

このあとは Claude Code でリポジトリを開き、ゲームのルールを伝えれば実装が進みます。 init が AI開発Skill（.claude/skills/）とゲームの雛形・テストを置くためです。

手順は Getting Started に最初から最後まで書いてあります。 そこに従えばゲームが1本できます。

インストール

⚠️ 現在このパッケージは未公開のため、そのままでは install できません。 GitHub Packages の private registry で配布しており、milightpartner Organization 内で アクセスを許可されたメンバー・リポジトリからのみ利用できます。 公開後はこの節の認証手順は不要になり、npm install だけで入ります。

認証の設定（公開までの暫定手順）

  1. GitHub の Settings → Developer settings → Personal access tokens で、 read:packages スコープを持つトークンを発行します。

  2. install したいリポジトリのルートに .npmrc を作成します（~/.npmrc への追記でも可）。

    @milightpartner:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=${GITHUB_PACKAGES_TOKEN}

  3. 環境変数に手順1のトークンをセットします。

    export GITHUB_PACKAGES_TOKEN=ghp_xxxxxxxxxxxxxxxxxxxx

権限まわりの詳細（Organization外への個別付与、GitHub Actions からの利用）は docs/installation.md を参照してください。

npm install @milightpartner/hitsumabushi-sdk

新しくゲームリポジトリを作る場合は、install の代わりに npx hitsumabushi init から 始められます（CLI リファレンス）。

ドキュメント

正本は同梱されているファイルです。npm install すると node_modules/@milightpartner/hitsumabushi-sdk/docs/ に展開され、インストールした SDKと同じバージョンのものが読めます。AIやエディタが参照するのはこちらです。

内容
Getting Startedインストールから公開まで、手順の全体
Hitsumabushi SDK 技術仕様書JS API と postMessage 通信プロトコル
ゲームマニフェスト仕様書manifest.json の全プロパティ
ポータル制約仕様書画面・入力・通信・音声で守ること
CLI リファレンスinit / dev / verify の使い方
検証ガイド何がどこまで機械で確かめられるか
インストールガイド認証の設定と GitHub Actions からの利用

ℹ️ GitHub Packages のパッケージページから読んでいる場合、このREADME内の相対リンク （./docs/...）は辿れません。パッケージのルートを基準に解決されないためです。 上の表の右列か、リポジトリの packages/hitsumabushi-sdk/docs/ を参照してください。

ゲームはこのパッケージを import せず、公開URLの <script> タグで読み込むビルド生成物を使います （同じソースから生成されたもので、APIは同一です。URL の規則は API リファレンス §1）。